chore: add basic readme

This commit is contained in:
Ryan 2025-02-21 22:32:21 -05:00
parent a4606e68e4
commit 08b9fbbc1e
Signed by: ErrorNoInternet
GPG Key ID: 2486BFB7B1E6A4A3

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# ErrorNoWatcher
A Minecraft bot with Lua scripting support, written in Rust with [azalea](https://github.com/azalea-rs/azalea).
## Features
- Running Lua from
- `errornowatcher.lua`
- in-game chat messages
- POST requests to HTTP server
- Listening to in-game events
- Pathfinding (from azalea)
- Entity and chest interaction
## Usage
```sh
$ git clone https://github.com/ErrorNoInternet/ErrorNoWatcher
$ cd ErrorNoWatcher
$ cargo build --release
$ # ./target/release/errornowatcher
```
Make sure the `SERVER` and `USERNAME` globals are defined in `errornowatcher.lua` before starting the bot.