minecraft-bot/README.md
2021-04-19 04:18:40 +00:00

145 lines
3.3 KiB
Markdown

# Minecraft Bot
## Setup
Assuming Debian / Ubuntu based distro:
```
$ sudo apt update
$ sudo apt install build-essential python3 python3-dev python3-pip python3-virtualenv git
$ git clone https://git.tannercollin.com/tanner/minecraft-bot.git
$ cd minecraft-bot/
$ bash download_mcdata.sh
$ virtualenv -p python3 env
$ source env/bin/activate
(env) $ pip install -r requirements.txt
```
Always make sure the virtual environment is running `(env)`.
## Running
```
(env) $ USERNAME=you@domain.com PASSWORD=supersecret SERVER=example.com python main.py
```
## Commands
Talking to bot (All commands can be found in "game.py" under "public commands", starting around line 494)
Use prefix (in this case, "1") to call to attention before giving command. (EX. 1ping, 1here, etc.)
### Public Commands
These can be ran by anyone, all bots will reply.
`!help` - prints this whole help message to console
`!help [command]` - replies in-game explaining command
`!ping` - replies with "pong"
`!echo [data]` - replies with "data"
`!pos` - replies with position and dimension
`!afk` - goes AFK with /afk
`!unafk` - goes not AFK with /afk
`!error` - raises an error
`!inv` - prints current inventory
`!time` - replies with Minecraft world time
`!count [id]` - counts the number of items with that id
`!loaded` - replies with the current loaded area
`!players` - prints the current players
`!players clear` - clears the current player list
`!objects` - prints the current items on ground
`!objects clear` - clears the current object list
`!mobs` - prints the current mobs
`!mobs clear` - clears the current mob list
`!monsters` - prints the current monsters
`!villagers` - prints the current villagers
`!threats` - prints the dangerous monsters within 20 blocks
`!threats [num]` - prints the dangerous monsters within num blocks
`"zzz" or !zzz` - bot does /afk to let others sleep
`!tree` - replies with the closest tree
`!block x y z` - replies what block is at (x, y, z)
### Bot-specific Commands
These will only run for the bot they are addressed to.
`1respawn` - respawns the bot if it's dead
`1gather wood` - gathers wood from the world
`1gather sand` - gathers sand from the world
`1farm wood` - farms wood from a certain area
`1farm sand` - farms sand from a certain area
`1farm wart` - farms netherwart from a certain area
`1farm crop` - farms mature crops from a certain area
`1loiter` - stands still but eats, sleeps, and flees
`1trade` - sells items to villagers to get emeralds
`1stop` - stops the current job and resets bot
`1drop` - drops the current stack its holding
`1select [id]` - moves item with id into main hand
`1dump [id]` - drops all items matching id
`1drain` - drops all items in inventory
`1fill [x] [y] [z] [x] [y] [z]` - fills the cuboid with the block at the first coordinate
`1here` - bot comes to your location
`1goto [x] [y] [z]` - sends the bot to coordinate (x, y, z)
`1close` - closes the current Minecraft window
`1click [slot] [button] [mode]` - clicks the current window
`1use` - use the item it's currently holding
`1interact [entity id]` - interacts with that entity
### Authorized Commands
These dangerous commands can only be ran by the bot owner.
`1print [expression]` - replies with Python eval(expression)
`1exit` - exits the program