diff --git a/README.md b/README.md index 9413d1c9..f055938a 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,20 @@ Once complete, the optimized executable will be located at `./target/release/mch MCHPRS will generate a `Config.toml` file in the current working directory when starting the server if it does not exist. +The folowing options are available at the toplevel (under no header): +| Field | Description | Default | +| --- | --- |--- | +| `bind_address` | Bind address and port | `0.0.0.0:25565` | +| `motd` | Message of the day | `"Minecraft High Performance Redstone Server"` | +| `chat_format` | How to format chat message interpolating `username` and `message` with curly braces | `<{username}> {message}` | +| `max_players` | Maximum number of simultaneous players | `99999` | +| `view_distance` | Maximal distance (in chunks) between players and loaded chunks | `8` | +| `bungeecord` | Enable compatibility with [BungeeCord](https://github.com/SpigotMC/BungeeCord) | `false` | +| `whitelist` | Whether or not the whitelist (in `whitelist.json`) shoud be enabled | `false` | +| `schemati` | Mimic the verification and directory layout used by the Open Redstone Engineers [Schemati plugin](https://github.com/OpenRedstoneEngineers/Schemati) | `false` | +| `block_in_hitbox` | Allow placing blocks inside of players (hitbox logic is simplified) | true | +| `auto_redpiler` | Use redpiler automatically | true | + ### LuckPerms MCHPRS has basic support for LuckPerms with MySQL or MariaDB remote database storage. This implementation has no commands or interface and would have to be manged through LuckPerms running on a proxy (`/lpb`) or other server (`/lp`)