Skip to content

Commit 2c54ec9

Browse files
committed
Create README.md
1 parent ee24b7d commit 2c54ec9

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# AFK Bot
2+
3+
AFK Bot is a simple program to connect a Minecraft account to a selected realm (both Java and Bedrock realms are supported) and auto-feed the player.
4+
5+
## Features
6+
7+
- Connect to Minecraft Java and Bedrock realms
8+
- Automatically feed the player when food level is low
9+
- Disconnect the player when health is critically low
10+
- Log errors and events
11+
12+
## Installation
13+
14+
1. Clone the repository:
15+
```sh
16+
git clone https://github.com/azures04/Mineflayer-Realm-AFK.git
17+
cd Mineflayer-Realm-AFK
18+
```
19+
20+
2. Install dependencies:
21+
```sh
22+
npm install
23+
```
24+
25+
## Usage
26+
27+
1. Run the bot:
28+
```sh
29+
node client.js
30+
```
31+
32+
2. Follow the prompts to select the Minecraft edition and realm.
33+
34+
## Dependencies
35+
36+
- [colors](https://www.npmjs.com/package/colors)
37+
- [input](https://www.npmjs.com/package/input)
38+
- [mineflayer](https://www.npmjs.com/package/mineflayer)
39+
- [prismarine-auth](https://www.npmjs.com/package/prismarine-auth)
40+
- [prismarine-realms](https://www.npmjs.com/package/prismarine-realms)
41+
- [uuid](https://www.npmjs.com/package/uuid)
42+
43+
## License
44+
45+
This project is licensed under the MIT License. See the [LICENSE](http://_vscodecontentref_/0) file for details.
46+
47+
## Author
48+
49+
- Gilles Lazure (azures04)
50+
- [Email](mailto:gilleslazure04@gmail.com)
51+
- [Website](https://azures.fr)
52+
- [GitHub](https://github.com/azures04)
53+
54+
## Contributing
55+
56+
Contributions are welcome! Please open an issue or submit a pull request for any changes.
57+
58+
## Bugs
59+
60+
If you encounter any issues, please report them on the [GitHub Issues](https://github.com/azures04/Mineflayer-Realm-AFK/issues) page.

0 commit comments

Comments
 (0)