diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 60 |
1 files changed, 0 insertions, 60 deletions
@@ -5,65 +5,5 @@ Benson started as a little server manager for the Minecraft server a few friends It's probably way more complicated than it needs to be, but that's kind of the point. The only reason this is public is because a friend of mine told me it might be useful for other people. -> [!WARNING] -> This is currently held together with duct tape and Node.js. I plan to rewrite the entire thing in Go properly at some point. - -## Setup -Install the Node dependencies with `npm i` and create the configuration files under `config/`. - -```json -# `config/config.json` -{ - "channel_id": "YOUR_CHANNEL_ID_HERE", - "check_interval_minutes": 60, - "minecraft_version": "1.21.10", - "fabric_loader_version": "0.17.3", - "loader_meta_version": "1.1.0", - "java_path": null, - "server_location": "C:/path/to/your/server", - "backup_location": "C:/path/to/backups", - "modrinth_mods": [ - "fabric-api", - "lithium", - "simple-voice-chat" - ] -} - -# `config/api.json` -{ - "token": "your-bot-token-here" -} -``` - -## Discord bot -The Discord bot periodically checks the configured mods on Modrinth and posts compatibility reports and update information to a given Discord channel. - -The bot runs in a separate process so it can be hosted on a server independently from the server manager. Just run: - -```bash -npm run bot -``` - -## Server manager -To interact with Benson, use the interactive CLI: - -```bash -npm run benson -``` - -The CLI provides the following commands: - -| Command | Description | -| ----------------- | ----------------------------------------------------------------- | -| `list-mods` | List the configured mods | -| `check` | Check whether the configured mods are compatible | -| `generate` | Download the server and mods and generate a server directory | -| `merge` | Back up the existing server and merge the generated files into it | -| `clean generated` | Remove the generated server directory | -| `clean latest` | Remove the latest backup | -| `clean all` | Remove both generated files and the latest backup | -| `help` | Show available commands | -| `exit` | Exit Benson | - ## License Benson is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more details. |