diff --git a/README.md b/README.md index 0094c10..24c9372 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # ErrorNoWatcher -ErrorNoWatcher is a Minecraft bot that alerts you when certain players are near your base. It also has a lot more features, such as interacting with blocks, a basic pathfinder that can follow players and go to coordinates, and much more. +ErrorNoWatcher is a Minecraft bot (written in Rust with [azalea](https://github.com/mat-1/azalea)) that alerts you when players are near your base. It also has other features such as interacting with blocks/entities, a basic pathfinder that can follow players and go to coordinates, a scripting system to run commands automatically, and much more. + +## Compiling +```sh +git clone https://github.com/ErrorNoInternet/ErrorNoWatcher +cd ErrorNoWatcher +cargo build --release +``` +The compiled executable will be at `./target/release/errornowatcher` + +## Usage +Running the bot for the first time will create the `bot_configuration.toml` file, where you can change several options: +```toml +username = "" +server_address = "" +register_keyword = "Register using" +register_command = "register MyPassword MyPassword" +login_keyword = "Login using" +login_command = "login MyPassword" +bot_owners = ["ErrorNoInternet", ""] +whitelist = [ + "ErrorNoInternet", + "" +] +alert_players = ["ErrorNoInternet", ""] +alert_location = [0, 0] +alert_radius = 192 +alert_command = [ + "curl", + "-s", + "-HTitle: Intruder Alert", + "-HPriority: urgent", + "-HTags: warning", + "-d{player_name} is near your base! Their coordinates are {x} {y} {z}.", + "", +] +```