diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 28 insertions, 28 deletions
@@ -1,21 +1,21 @@ -# Benson -A Minecraft server manager from hell. +# benson +a minecraft server manager from hell. -Benson started as a little server manager for the Minecraft server a few friends and I play on. The server runs on one of our machines, and originally Benson was just a way to make managing that server a little less annoying. Then it progressively grew. I added automatic mod updates through Modrinth. Then compatibility checking. Then backups. Then a way to generate a fresh server without having to manually download everything and set it up again. At some point, Benson stopped being just a server manager and became a tool for spinning up Minecraft servers whenever we feel like doing something stupid. It can manage mods for an existing server, keep them up to date, back up the server before making changes, and generate completely new servers from a configuration. +benson started as a little server manager for the minecraft server a few friends and i play on. the server runs on one of our machines, and originally benson was just a way to make managing that server a little less annoying. then it progressively grew. i added automatic mod updates through modrinth. then compatibility checking. then backups. then a way to generate a fresh server without having to manually download everything and set it up again. at some point, benson stopped being just a server manager and became a tool for spinning up minecraft servers whenever we feel like doing something stupid. it can manage mods for an existing server, keep them up to date, back up the server before making changes, and generate completely new servers from a configuration. -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. +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. > [!NOTE] -> This is the Go rewrite of Benson. The original was held together with duct tape and Node.js and shipped as two separate programs; this version is a single self-contained binary with no runtime dependencies. The server manager and the Discord bot are now the same executable. +> this is the go rewrite of benson. the original was held together with duct tape and node.js and shipped as two separate programs; this version is a single self-contained binary with no runtime dependencies. the server manager and the discord bot are now the same executable. -## Install -You need Go 1.26+ to build it. Java is only needed for the `generate` command. +## install +you need go 1.26+ to build it. java is only needed for the `generate` command. ```bash go install git.hachem.wtf/hachem/benson@latest ``` -Or build from source: +or build from source: ```bash git clone https://git.hachem.wtf/hachem/benson.git @@ -23,43 +23,43 @@ cd benson go build -o benson . ``` -## Configure -Benson keeps its configuration under `config/`. The easiest way to set it up is the interactive wizard: +## configure +benson keeps its configuration under `config/`. the easiest way to set it up is the interactive wizard: ```bash benson setup # server manager: versions, paths, mods benson setup bot # discord bot: token, channel, interval ``` -`setup` writes `config/config.json` and `setup bot` also writes `config/api.json` (which holds your bot token). The bot is entirely optional — if you only want the server manager, you never have to touch it. You can also edit the files by hand; see `config/config.example.json` for the shape. +`setup` writes `config/config.json` and `setup bot` also writes `config/api.json` (which holds your bot token). the bot is entirely optional — if you only want the server manager, you never have to touch it. you can also edit the files by hand; see `config/config.example.json` for the shape. -## Server manager -Run Benson with no arguments to open the interactive CLI: +## server manager +run benson with no arguments to open the interactive cli: ```bash benson ``` -It provides the following commands: +it provides the following commands: -| Command | Description | +| 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 | +| `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 | -## Discord bot -The Discord bot periodically checks the configured mods on Modrinth and posts compatibility reports to a given channel. Since it's the same binary as the manager, you can host it wherever you like: +## discord bot +the discord bot periodically checks the configured mods on modrinth and posts compatibility reports to a given channel. since it's the same binary as the manager, you can host it wherever you like: ```bash benson bot ``` -## License -Benson is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more details. +## license +benson is licensed under the apache license 2.0. see [license](LICENSE) for more details. |