From 216f035312c3a53601fd43052a7c747a23a39351 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 23 May 2021 02:58:19 +0100 Subject: [PATCH] docs: wip document specs Signed-off-by: Ian Jackson --- docs/gamespec.rst | 23 +++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 24 insertions(+) create mode 100644 docs/gamespec.rst diff --git a/docs/gamespec.rst b/docs/gamespec.rst new file mode 100644 index 00000000..3d9c0d80 --- /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 fd8f1835..bfd16fbb 100644 --- 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 -- 2.30.2