diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 89 |
1 files changed, 69 insertions, 20 deletions
@@ -1,43 +1,92 @@ # Benson Mod Manager from hell, for Willy World -## Running the Discord Bot -1. DM me to get the Discord bot token. -2. Place the token in `config/api.json` like this: +## Setup -```json -{ - "token": "your-bot-token-here" -} +```bash +npm install ``` -3. **Set the Discord channel ID** +## Configuration -Open `config/config.json` and update the `channel_id` field to the channel where the bot should post updates: +### `config/config.json` ```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", "modrinth_mods": [ - "example-mod", - "another-mod" - ], - // ... + "fabric-api", + "lithium", + "simple-voice-chat" + ] +} +``` + +### `config/api.json` (for Discord bot) + +```json +{ + "token": "your-bot-token-here" } ``` -If you don't set this, the bot **will not find the channel** and won't send any messages. +## Discord Bot -4. Start the bot: +Monitors Modrinth for mod updates and posts compatibility reports to a Discord channel. ```bash -npm i -node . +npm run bot ``` -## Running the Updater -> Make sure to run this from the **project root**, **not** inside the `updater` folder. +## Server Manager CLI + +Interactive CLI for managing mods and server files. ```bash -python updater/updater.py +npm run benson +``` + +``` + ╔══════════════════════════════════════╗ + ║ BENSON CLI v1.0 ║ + ║ Fabric Mod Manager for MC 1.21.10 ║ + ╚══════════════════════════════════════╝ + + Type 'help' for available commands. + +benson> _ +``` + +### Commands + +| Command | Description | +|---------|-------------| +| `list-mods` | List configured mods | +| `generate` | Download mods + server, run to generate files | +| `merge` | (coming soon) | +| `clean generated` | Remove generated server files | +| `clean all` | (coming soon) | +| `help` | Show available commands | +| `exit` | Exit the CLI | + +## Project Structure + +``` +Benson/ +├── lib/ +│ ├── modrinth.js # Shared Modrinth API functions +│ └── config.js # Shared config/cache utilities +├── bot/ +│ └── app.js # Discord bot +├── updater/ +│ └── cli.js # Interactive CLI +├── config/ +│ ├── config.json # Main configuration +│ └── api.json # Discord token (not in repo) +├── cache/ # Version cache (auto-generated) +└── server/ # Server files (auto-generated) ``` |