Files
firefrost-services/services/rules-mod/INSTALL.md
Claude (Chronicler #83 - The Compiler) 60740386ac v1.0.2: Fix config reset — switch from SERVER to COMMON config type
SERVER configs in world/serverconfig/ are tied to the world load/unload
lifecycle, causing Forge to overwrite edited values on every restart.
COMMON configs in config/ load once at startup and persist reliably.

Config location changed:
  firefrostrules: config/firefrostrules-common.toml
  discordrules:   config/discordrules-common.toml

All 6 builds updated (3 firefrostrules + 3 discordrules).

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

35 lines
1.1 KiB
Markdown

# Rules Mod — Install Procedure
## 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 `config/firefrostrules-common.toml` (or `config/discordrules-common.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 config/firefrostrules-common.toml
```
## Config Location
The config lives at `config/firefrostrules-common.toml` (COMMON type).
This loads once at startup and persists reliably across restarts.
## Upgrading from v1.0.0 or v1.0.1
Old versions used `world/serverconfig/firefrostrules-server.toml`.
That file is now ignored. Copy your values to the new location above.