summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-09 12:22:53 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-09 12:22:53 +0000
commite1730d8012fca0a712de588285342f7ad10dd804 (patch)
treeb351ae5da04fe10a211be772636b2bf8de6d49dd /docs
parenta989bd16c40e04bba5a5404b0ef0cd22f19d2707 (diff)
now including entertain/chess
Diffstat (limited to 'docs')
-rw-r--r--docs/ENTERTAIN.md43
-rw-r--r--docs/MASTER-GUIDE.md2
2 files changed, 31 insertions, 14 deletions
diff --git a/docs/ENTERTAIN.md b/docs/ENTERTAIN.md
index cbdec78..f6b9667 100644
--- a/docs/ENTERTAIN.md
+++ b/docs/ENTERTAIN.md
@@ -1,21 +1,37 @@
-# Entertain Area · HyBBX 2.8.0
+# Entertain Area · HyBBX
-Optional Main-only plugins for games and apps — not on Secondary RF hosts.
+Optional **Main / standalone Main** feature plugin for games (chess first).
+Not loaded on Secondary or Proxy. AmigaOS builds force the plugin **OFF** at CMake.
-## Plugin matrix
+## Enable
-| Plugin | Status | Notes |
-|--------|--------|-------|
-| Entertain Area framework | opt-in CMake | Main hosts only |
-| Chess / games | deferred | future or doc removal |
+| Layer | Setting |
+|-------|---------|
+| Build | `-DHYBBX_PLUGIN_ENTERTAIN=ON` (default on POSIX; forced off on AmigaOS) |
+| INI | `[networks] entertain=yes` |
+| Role | `hybbxd` Main (or standalone Main) |
-## Config matrix
+```ini
+[networks]
+entertain = yes
+```
-| Item | Value |
-|------|-------|
-| Enable | `-DHYBBX_PLUGIN_ENTERTAIN=ON` (when available) |
-| Host role | Main only — Secondary runs RF transports |
-| User access | Level-gated via `[areas]` / `share/areas.yaml` |
+Log line on success: `[entertain] plugin loaded — chess_max_games=…`
+
+## Chess
+
+| Command | Action |
+|---------|--------|
+| `/chess help` | Command list |
+| `/chess new` | Create game (White) |
+| `/chess join [id]` | Join as Black |
+| `/chess watch [id]` | Spectate |
+| `/chess move e2 e4` | Move (`/mv e2 e4` or `/mv e2e4`) |
+| `/chess resign` / `/chess draw` | Resign / offer-accept draw |
+| `/chess list` / `/chess board` / `/chess clear` | List / show / free finished slots |
+| `/play …` | Alias for `/chess` |
+
+Limits: no castling, no en passant; pawn promotes to Q/R/B/N. ASCII board for telnet/SSH.
## Related
@@ -23,3 +39,4 @@ Optional Main-only plugins for games and apps — not on Secondary RF hosts.
|------|-----|
| Topology | [TOPOLOGY.md](TOPOLOGY.md) |
| Commands | [COMMANDS.md](COMMANDS.md) |
+| Areas | `share/areas.yaml` · Entertain menu (User+) |
diff --git a/docs/MASTER-GUIDE.md b/docs/MASTER-GUIDE.md
index 53895af..b6d025d 100644
--- a/docs/MASTER-GUIDE.md
+++ b/docs/MASTER-GUIDE.md
@@ -61,7 +61,7 @@ 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` |
+| `[networks]` | Enable plugins: `ax25`, `baycom`, `crdop`, `circuit`, `ssh`, `websocket`, `entertain` (Main chess) |
| `[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