summaryrefslogtreecommitdiff
path: root/website/src/docs/features/admin.md
diff options
context:
space:
mode:
authorSho Sakuma <me@m1sk9.dev>2026-08-05 04:36:50 +0900
committerSho Sakuma <me@m1sk9.dev>2026-08-05 04:36:50 +0900
commit418be2d127ce2d6a3ed5e9c876deb9c2aafc089b (patch)
treedb800a91ac8fb05ae870b50014dc7fe06f274c47 /website/src/docs/features/admin.md
parent048932276d0c1e11d463f8b9aea872e498b04743 (diff)
downloadLunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.tar.gz
LunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.tar.bz2
LunaticChat-418be2d127ce2d6a3ed5e9c876deb9c2aafc089b.zip
docs: correct the website where it had drifted from the implementation
Several statements were wrong rather than merely thin, and each would have set the wrong expectation: - the conversion example implied romaji replaces the input, when the result is appended in parentheses and both are sent - the handshake was described as happening at startup, when it waits for the first player to join, so a DISCONNECTED status on an empty server read as a fault - cache eviction was called oldest-first, which the unordered in-memory map cannot provide - the Velocity settings table omitted crossServerDirectMessage - ConfigManager was described as reading Bukkit's FileConfiguration, and the settings storage as recovering from a backup that does not exist It also documents behaviour that had no mention anywhere: the `!` force-global prefix, that spy sees channel messages and not only DMs, the nightly build warnings, the overall 1000ms conversion budget that makes api.timeout above it ineffective, and the data files the plugin writes. Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'website/src/docs/features/admin.md')
-rw-r--r--website/src/docs/features/admin.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/website/src/docs/features/admin.md b/website/src/docs/features/admin.md
index c3a3d2f..0c185fb 100644
--- a/website/src/docs/features/admin.md
+++ b/website/src/docs/features/admin.md
@@ -24,8 +24,10 @@ Displayed information:
## Spy Mode
-Players with the `lunaticchat.spy` permission (default: op) can view all direct messages sent and received on the server.
+Players with the `lunaticchat.spy` permission (default: op) can view both the direct messages and the channel messages sent on the server.
+- Direct messages are delivered to spies, excluding the sender and the recipient
+- Channel messages are delivered to spies, excluding the sender and the channel's own members
- Spy players see the original message before romaji conversion
- Hover text indicates the message is a spy message
- Spy players themselves are not included in the normal sender/recipient list
@@ -46,6 +48,15 @@ When `checkForUpdates` is `true` (default), the plugin checks for new versions a
checkForUpdates: true
```
+## Nightly Builds
+
+Builds produced from the `main` branch outside of a release are marked as nightly, and the plugin says so rather than letting it go unnoticed.
+
+- Every player is warned on join that the build may be unstable, along with a pointer to GitHub Issues
+- `/lc status` shows the same warning, and displays the release channel in yellow instead of green
+
+Nightly builds are not covered by the [security policy](https://github.com/m1sk9/LunaticChat/blob/main/.github/SECURITY.md); use a release build on a production server.
+
## Debug Mode
Setting `debug` to `true` enables verbose plugin logging. This is useful for troubleshooting issues or submitting bug reports.
@@ -68,7 +79,7 @@ language: "ja" # "en" or "ja"
| Permission | Default | Description |
|-----------|---------|-------------|
-| `lunaticchat.spy` | op | View all direct messages |
+| `lunaticchat.spy` | op | View all direct and channel messages |
| `lunaticchat.channelbypass` | op | Bypass channel restrictions |
| `lunaticchat.noticeupdate` | op | Receive update notifications |
| `lunaticchat.command.lcv.status` | op | Use the `/lcv status` command |