Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nightmirror21/afkbot
A bot for the server in Minecraft to stay in the game, control via discord.
https://github.com/nightmirror21/afkbot
afk-bot discord-js minecraft-afk-bot minecraft-bot mineflayer mineflayer-bot nodejs
Last synced: about 2 months ago
JSON representation
A bot for the server in Minecraft to stay in the game, control via discord.
- Host: GitHub
- URL: https://github.com/nightmirror21/afkbot
- Owner: NightMirror21
- Created: 2024-08-08T22:42:40.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-08T22:59:38.000Z (5 months ago)
- Last Synced: 2024-10-19T06:44:01.652Z (3 months ago)
- Topics: afk-bot, discord-js, minecraft-afk-bot, minecraft-bot, mineflayer, mineflayer-bot, nodejs
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AFKBot
AFKBot is a Discord bot that connects to a Minecraft server on your behalf, allowing you to stay AFK (away from keyboard) while performing other tasks. The bot can execute commands when it connects to the server, manage connection settings, and handle reconnections automatically. This is particularly useful for tasks like farming, waiting for in-game events, or simply maintaining your presence on the server.
## Requirements
- Node.js (v16.6.0 or higher)
- Discord Bot Token
- Own discord server (for logging)
- Mineflayer (A Minecraft bot API)
## Installation
1. **Clone the Repository**
```bash
git clone https://github.com/NightMirror21/AFKBot.git
cd AFKBot
```
2. **Configure your bot**
Replace `TOKEN` in the code with your Discord bot token.
Replace `LOG_CHANNEL` with the ID of the Discord channel where you want to log bot activities.
3. **Install dependencies**
```bash
npm install discord.js mineflayer
```
4. **Run**
```bash
node bot.js
```
## Usage
Once the bot is running, you can control it through the following Discord commands:
- `/settings ` - Sets the connection settings for the Minecraft server.
```
host: The IP address of the Minecraft server.
port: The port number of the Minecraft server.
username: The username you want to connect with.
```
- `/connect` - Connects the bot to the Minecraft server using the previously set settings.
- `/disconnect` - Disconnects the bot from the Minecraft server.
- `/setcommand ` - Sets a command that the bot will execute upon connecting to the server. This is useful for logging in with a password or performing any other in-game tasks.
```
command: The Minecraft command to execute.
```
- `/setdelay ` - Sets the delay before the bot attempts to reconnect to the server if disconnected.
```
delay_in_seconds: The number of seconds to wait before attempting to reconnect.
```
- `/help` - Displays a help message with detailed instructions on how to use the bot.
### Example
1. Set up the server connection settings:
`/settings play.example.com 25565 MyUsername`
2. Connect to the server:
`/connect`
3. Set a command to be executed upon connection (e.g., logging in):
`/setcommand /login MySecretPassword`
4. Set a custom delay before reconnecting:
`/setdelay 10`
5. Disconnect from the server:
`/disconnect`