docs: wip document specs

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/docs/gamespec.rst b/docs/gamespec.rst
new file mode 100644 (file)
index 0000000..3d9c0d8
--- /dev/null
+++ b/docs/gamespec.rst
@@ -0,0 +1,23 @@
+Game specs
+==========
+
+A game spec defines the starting layout for a game: **which pieces start
+on the table, and where**.
+
+It also defines some ancillary information about the game and its
+layout.  It does not contain information about the players.
+Players join a game as permitted by the game access control list,
+which is specified in a *table specification* (sadly not currently
+properly documented, but look at the Rustdoc for ``TableSpec``).
+
+General
+-------
+
+A game spec is a TOML file.  It has the following entries at the top
+level:
+
+ * ``table_size`` [array of 2 numbers].  Size of the table playing
+   area, in Otter internal units.  The default is ``[300,200]``.
+
+
+ * xxx

diff --git a/docs/index.rst b/docs/index.rst
index fd8f18354b8844938df51292af88d39d3dd38924..bfd16fbb13e7fd93b57dd3dae29a300c38fccba8 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -14,6 +14,7 @@ Otter - Online Table Top Environment Renderer
    user
    advanced
    bundles
+   gamespec
    shapelibs
    build
    install