ErrorNoInternet/ErrorNoWatcher
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ErrorNoInternet 2023-01-18 22:28:40 +08:00
parent 1d55f4cb19
commit 323272b3fe
Signed by untrusted user who does not match committer: ErrorNoInternet
GPG Key ID: 2486BFB7B1E6A4A3
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -13,7 +13,7 @@ The compiled executable can be found at `./target/release/errornowatcher`
### Configuration ### Configuration
Running the bot will create the `bot_configuration.toml` file, where you can change several options: Running the bot will create the `bot_configuration.toml` file, where you can change several options:
```toml ```toml
username = "<bot's username>" username = "<bot's username>" # offline username
server_address = "<server address>" server_address = "<server address>"
register_keyword = "Register using" register_keyword = "Register using"
register_command = "register MyPassword MyPassword" register_command = "register MyPassword MyPassword"
@ -25,8 +25,8 @@ whitelist = [
"<won't be triggered by the alert system>" "<won't be triggered by the alert system>"
] ]
alert_players = ["ErrorNoInternet", "<players to send a message to>"] alert_players = ["ErrorNoInternet", "<players to send a message to>"]
alert_location = [0, 0] alert_location = [0, 0] # coordinates of your base (X and Y position)
alert_radius = 192 alert_radius = 192 # the radius of your base (-192, -192 to 192, 192)
alert_command = [ alert_command = [
"curl", "curl",
"-s", "-s",
@ -35,10 +35,11 @@ alert_command = [
"-HPriority: urgent", "-HPriority: urgent",
"-HTags: warning", "-HTags: warning",
"-d{player_name} is near your base! Their coordinates are {x} {y} {z}.", "-d{player_name} is near your base! Their coordinates are {x} {y} {z}.",
"<your URL here (or a service such as ntfy.sh)>", "<your URL here (or a service such as ntfy.sh)>"
] ]
cleanup_interval = 300 cleanup_interval = 300 # the amount of seconds to wait before checking for idle entities
mob_expiry = 300 mob_expiry_time = 300 # the maximum amount of time a mob can stay idle before getting cleared
mob_packet_drop_level = 5 # the level of mob packets to drop (0 = 0%, 5 = 50%, 10 = 100%)
``` ```
### Example commands ### Example commands
- `/msg ErrorNoWatcher help 1` - list the first page of usable commands - `/msg ErrorNoWatcher help 1` - list the first page of usable commands