An open API service indexing awesome lists of open source software.

https://github.com/000pp/minebot

🤖 Charles is a minecraft bot made with mineflayer to execute simple commands
https://github.com/000pp/minebot

Last synced: 11 months ago
JSON representation

🤖 Charles is a minecraft bot made with mineflayer to execute simple commands

Awesome Lists containing this project

README

          

# 🤖 minebot
![charles](https://i.imgur.com/ZzMMs7q.jpg)
> minebot is a minecraft bot made with Mineflayer to execute simple commands



## 🤔 What is Charles?
minebot is a javascript minecraft bot made with [Mineflayer](https://github.com/PrismarineJS/mineflayer) librarie, the goal is execute simple commands.



## ☁️ Download
1. For a more easy download, click in the button `Clone or download` and click in `Download ZIP`
2. If you want to use **SSH**, you can use `git clone git@github.com:oppsec/minebot.git`
3. If you want to use **HTTPS**, you can use `git clone https://github.com/oppsec/minebot.git` **(recommended)**



## ⚙️ Set-up
1. You need [Node](https://nodejs.org/en/) installed on your machine.

2. On the `server.json` file, you need to put the server informations to the bot connect.
- Localhost: `ip: localhost` | `port: ... (Open a LAN server)` | `version: ... (Minecraft server version)`
- Online server: `username: yourminecraft@memail.com` | `password: youramazingpassword`

3. After setting up the `server.json` file, type in your terminal `node index.js` or `node .` *(the terminal path needs to be the same of the folder)*

4. Done, probably your bot will connect on the server. 😃



## 🔨 Commands
| Command | Function | Example |
|----------- |----------------------------- |--------------------- |
| !search | Search for a specific block | !search diamond_ore |
| !jump | Simple jump function | |
| !stopjump | Stop jump function | |
| !come | The bot will come to you | |
| !dev | Say the developer name | |



## 👀 Previews
### Search command
![search](https://i.imgur.com/w7Fmh1l.png)



## 👋 Contributing
If you want to contribute with the project, you have two ways:
1. Open a pull request with your changes



## 👏 Credits
**Mineflayer**: https://github.com/PrismarineJS/mineflayer