diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 3 | ||||
| -rw-r--r-- | docs/server/install.md | 1 | ||||
| -rw-r--r-- | docs/server/production.md | 4 | ||||
| -rw-r--r-- | docs/server/toolbox.md | 52 |
4 files changed, 56 insertions, 4 deletions
diff --git a/docs/index.md b/docs/index.md index 96c9a7b..254cc74 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,6 +13,7 @@ server instance and how to create new modules. * [Installing the server](/docs/server/install) * [Running a public server](/docs/server/production) +* [Toolbox](/docs/server/toolbox) ## System overview @@ -22,7 +23,7 @@ server instance and how to create new modules. ## Module implementation -* [Step by step guide](/docs/module/guide) +* [General tips and where to start](/docs/module/guide) * [Rules framework](/docs/module/rules) * [Script syntax](/docs/module/script) * [Utility library](/docs/module/library) diff --git a/docs/server/install.md b/docs/server/install.md index 86359bc..4e48440 100644 --- a/docs/server/install.md +++ b/docs/server/install.md @@ -43,4 +43,3 @@ Register it in the database: Open the browser to http://localhost:8080/ and create an account. The first account created will have administrator privileges. - diff --git a/docs/server/production.md b/docs/server/production.md index 9882a5a..4344630 100644 --- a/docs/server/production.md +++ b/docs/server/production.md @@ -91,11 +91,11 @@ Run the archive and purge scripts as part of the backup cron job. Copy game state data of finished games into archive database. - sqlite3 tools/archive.sql + sqlite3 < tools/archive.sql Delete game state data of finished games over a certain age. - sqlite3 tools/purge.sql + sqlite3 < tools/purge.sql Restore archived game state. diff --git a/docs/server/toolbox.md b/docs/server/toolbox.md new file mode 100644 index 0000000..ebbabaf --- /dev/null +++ b/docs/server/toolbox.md @@ -0,0 +1,52 @@ +# Toolbox + +There are a few programs that help maintain the database and are useful to +develop and debug modules. + +## Setup + +These programs can be invoked from the command line by running the "rtt" +command that is found in the "bin" directory. +I suggest creating a symlink to the "rtt" command somewhere in your PATH. + + ln -s ~/server/bin/rtt ~/.local/bin + +Alternatively, you can edit your .profile to add the server bin directory to your PATH. + + PATH=$PATH:$HOME/server/bin + +## Commands + +database management + + init -- create database + run -- run server + backup -- backup database + +game management + + export -- export game + import -- import game + patch -- patch game state (using replay) + undo -- rewind game state (using replay) + +module development + + foreach -- run a command for each module + fuzz -- fuzz test a module + +game debugging + + show-chat -- show game chat (for moderation) + show-game -- show game state object + show-replay -- show game replay log + +miscellaneous tools + + update-covers -- generate cover thumbnails + update-elo -- recalculate Elo ratings + +## Miscellaneous + +The "tools" directory holds various useful bits and bobs. + |