summaryrefslogtreecommitdiff
path: root/docs
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
parente1730d8012fca0a712de588285342f7ad10dd804 (diff)
now including entertain/chess
Diffstat (limited to 'docs')
-rw-r--r--docs/ENTERTAIN.md21
-rw-r--r--docs/MASTER-GUIDE.md3
2 files changed, 15 insertions, 9 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
diff --git a/docs/MASTER-GUIDE.md b/docs/MASTER-GUIDE.md
index b6d025d..2f5d180 100644
--- a/docs/MASTER-GUIDE.md
+++ b/docs/MASTER-GUIDE.md
@@ -61,7 +61,8 @@ Full key tables: frozen `docs/MANUAL.md`. Vault INI copy (reference station): `s
|---------|---------|
| `[service]` | Name, session limit, prompt |
| `[storage]` | `flatfile` or `sqlite`; user shards under `users/` |
-| `[networks]` | Enable plugins: `ax25`, `baycom`, `crdop`, `circuit`, `ssh`, `websocket`, `entertain` (Main chess) |
+| `[networks]` | Enable transports: `ax25`, `baycom`, `crdop`, `circuit`, `ssh`, `websocket`, … |
+| `[entertain]` | Main/standalone Entertain area (`enabled=yes`; chess built-in) |
| `[transport.telnet]` | Bind, port `2323` |
| `[transport.circuit]` | HBX hub port `7323`, `max_links` (default 8, max 16) |
| `[transport.packet_radioN]` | TNC instance — device, `tnc=` profile, `protocol=kiss` |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com