e21a348b3b
Console /rules now fetches from Discord async (was returning hardcoded fallback without attempting fetch). DIAG logging kept for observability. All 6 builds at 1.0.5. CHANGELOG.md, INSTALL.md, ACTIVE_CONTEXT.md updated. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
45 lines
1.5 KiB
Markdown
45 lines
1.5 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
|
|
- **IMPORTANT: Keep the [discord] and [performance] section headers!**
|
|
- Only change the values, not the file structure
|
|
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.
|
|
|
|
## Testing /rules
|
|
|
|
Both console and in-game `/rules` will fetch from Discord. However,
|
|
for the best test, have a player run `/rules` in-game. The console
|
|
path fetches async and displays the result, but the in-game path
|
|
also shows the "Fetching latest rules..." message and applies the
|
|
per-player cooldown.
|
|
|
|
## 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.
|