From 2f73cccfa166fb2bbd4c47c0da184f35a02abc0e Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Thu, 8 Apr 2021 19:26:33 +0100 Subject: [PATCH] docs: Headings Signed-off-by: Ian Jackson --- README.md | 9 +++++---- docs/advanced.md | 21 +++++++++++++++++---- docs/user.md | 4 ++-- 3 files changed, 24 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index be94387e..e7fe5c47 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -OTTER - ONLINE TABLE TOP ENVIRONMENT RENDERER -============================================= +Introduction +============ -Otter is an online game system. +Otter, the Online Table Top Environment Renderer, is an online game +system. But it is not like most online game systems. It does not know (nor does it need to know) the rules of the game you are playing. Instead, @@ -37,7 +38,7 @@ Mao with Otter. Playing a game with Otter --------------------------- +------------------------- The Otter game environment is accessed from a web browser running JavaScript, using a magic https link obtained from joining the game. diff --git a/docs/advanced.md b/docs/advanced.md index a0f4620f..c5d0dcfc 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -1,5 +1,18 @@ -Making your own game -==================== +Advanced usage +============== + +Adding pieces to a game in progress +----------------------------------- + +Use the `otter library-list` and `otter library-add` commands, you can +add pieces to a game while it is in progress. + +You may want to refer to the shape library preview ("Shapelib" link in +the game UI). + + +Defining your own game +---------------------- If you want to use existing piece shapes that Otter already knows about, you can do this by providing a `.game.toml` file. @@ -7,8 +20,8 @@ The format of these files is a TOML document representing a `GameSpec` as found in `src/spec.rs` in the Otter source code. -Adding shapes -============= +Adding shapes (pieces, cards, etc.) +----------------------------------- Otter uses SVGs. The sources for the SVGs are all in the otter source tree, in the `library/` directory. diff --git a/docs/user.md b/docs/user.md index 724fe739..f65259f0 100644 --- a/docs/user.md +++ b/docs/user.md @@ -1,5 +1,5 @@ -OTTER - USER DOCUMENTATION -========================== +Using Otter as a player or game host +==================================== Basics; joining a game ---------------------- -- 2.30.2