summaryrefslogtreecommitdiff
path: root/docs/ENTERTAIN.md
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-09 12:42:59 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-09 12:42:59 +0000
commit7815183927ecb914de430a5d64f9df27a48f49ae (patch)
tree1f75384f4b54998476f9d2e8219b8570c3f8f650 /docs/ENTERTAIN.md
parente1730d8012fca0a712de588285342f7ad10dd804 (diff)
now including entertain/chess
Diffstat (limited to 'docs/ENTERTAIN.md')
-rw-r--r--docs/ENTERTAIN.md21
1 files changed, 13 insertions, 8 deletions
diff --git a/docs/ENTERTAIN.md b/docs/ENTERTAIN.md
index f6b9667..4fd75b0 100644
--- a/docs/ENTERTAIN.md
+++ b/docs/ENTERTAIN.md
@@ -1,22 +1,26 @@
# Entertain Area · HyBBX
-Optional **Main / standalone Main** feature plugin for games (chess first).
-Not loaded on Secondary or Proxy. AmigaOS builds force the plugin **OFF** at CMake.
+Optional **Main / standalone Main** feature plugin. Chess is a **fixed** part of
+Entertain (no separate `chess=` INI key). AmigaOS builds force the plugin **OFF**.
## Enable
| Layer | Setting |
|-------|---------|
| Build | `-DHYBBX_PLUGIN_ENTERTAIN=ON` (default on POSIX; forced off on AmigaOS) |
-| INI | `[networks] entertain=yes` |
-| Role | `hybbxd` Main (or standalone Main) |
+| INI | **`[entertain] enabled=yes`** (not under `[networks]`) |
+| Role | `hybbxd` Main or standalone Main only |
```ini
-[networks]
-entertain = yes
+[entertain]
+enabled = yes
```
-Log line on success: `[entertain] plugin loaded — chess_max_games=…`
+Legacy `[networks] entertain=yes` is still read with a warning — prefer `[entertain]`.
+
+Log: `[entertain] enabled=yes …` then `[entertain] plugin loaded — chess_max_games=…`
+
+When Entertain is off, `/chess` stays **Unknown command** (by design).
## Chess
@@ -30,8 +34,9 @@ Log line on success: `[entertain] plugin loaded — chess_max_games=…`
| `/chess resign` / `/chess draw` | Resign / offer-accept draw |
| `/chess list` / `/chess board` / `/chess clear` | List / show / free finished slots |
| `/play …` | Alias for `/chess` |
+| `/proxychess …` | **Stub** — future chess via mains_proxy mesh |
-Limits: no castling, no en passant; pawn promotes to Q/R/B/N. ASCII board for telnet/SSH.
+Limits: no castling, no en passant; pawn promotes to Q/R/B/N. Compact ASCII board.
## Related
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com