Files
firefrost-services/services/rules-mod/INSTALL.md
Claude (Chronicler #83 - The Compiler) 996b59672f v1.0.1: Config reset fix + Loading handler + versioning (all 6 builds)
- Added ModConfigEvent.Loading handler to detect default config on startup
- Warns clearly in logs when bot_token is still YOUR_TOKEN_HERE
- Bumped all 6 builds to 1.0.1 (3 firefrostrules + 3 discordrules)
- Created CHANGELOG.md and INSTALL.md with correct install procedure
- Updated CLAUDE.md with install procedure note
- 1.16.5 uses ModConfig.Loading (different class hierarchy from 1.20.1+)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-13 17:06:31 -05:00

38 lines
1.2 KiB
Markdown

# Rules Mod — Install Procedure
## Important: Do NOT place config files manually
Forge generates `world/serverconfig/firefrostrules-server.toml` (or
`discordrules-server.toml` for the generic version) on first server start.
Placing a config file manually before the first run will cause Forge to
overwrite it with defaults — your bot token, channel ID, and message ID
will be lost.
## Correct Install Steps
1. Place the jar in the server's `mods/` folder
2. Start the server once — Forge generates the config with defaults
3. Stop the server
4. Edit `world/serverconfig/firefrostrules-server.toml`:
- Set `bot_token` to your Discord bot token
- Set `channel_id` to the channel containing your rules message
- Set `message_id` to the specific message ID
5. Start the server again
## Verify It Worked
Check server logs on startup for:
```
Rules mod config loaded successfully. Channel: <your_channel_id>
```
If you see this instead, the config is still on defaults:
```
Rules mod is using default config values! Edit world/serverconfig/firefrostrules-server.toml
```
## Config Location
The config lives at `world/serverconfig/` — NOT `config/`.
This is standard Forge SERVER config behavior.