formation-chess-web 0.2.0

Rules engine and text notation for Formation Chess (阵棋), a strategy board game where piece formations reshape nearby abilities
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

# formation-chess-web

A local web UI for [Formation Chess (阵棋)](..), built with [Axum](https://github.com/tokio-rs/axum) and vanilla JavaScript. No build tools, no framework — Rust serving a static frontend embedded in the binary.

## Quick start

**From crates.io:**

```sh
cargo install formation-chess-web
formation-chess-web
```

**From source:**

```sh
cargo run -p formation-chess-web
```

Opens the browser automatically at an available local port. To specify a port:

```sh
formation-chess-web 4000          # after install
cargo run -p formation-chess-web -- 4000  # from source
```

## API endpoints

| Method | Path | Description |
|:--|:--|:--|
| `GET` | `/` | Web UI |
| `GET` | `/api/state` | Full game state |
| `POST` | `/api/action` | Submit an action |
| `POST` | `/api/hints` | Legal moves or white placements |
| `POST` | `/api/new` | Create a game from config |
| `GET` | `/api/rules` | Chinese rules text |

All request/response bodies are JSON. Coordinates are 0-based `[x, y]`. Enum values are serialised in English (`"Red"`, `"BlackWin"`, etc.).