summaryrefslogtreecommitdiff
path: root/docs/ENTERTAIN.md
blob: f6b96670735fe394ef90035f5a5ae391dc681532 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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.

## 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
[networks]
entertain = yes
```

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

| Goal | Doc |
|------|-----|
| Topology | [TOPOLOGY.md](TOPOLOGY.md) |
| Commands | [COMMANDS.md](COMMANDS.md) |
| Areas | `share/areas.yaml` · Entertain menu (User+) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com