summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTor Andersson <tor@ccxvii.net>2025-05-06 19:58:28 +0200
committerTor Andersson <tor@ccxvii.net>2025-05-06 20:00:03 +0200
commit64f345c56447fb01e73c99827c028f6507a1514b (patch)
treeca294e5418729a964e47b2dd1191dd18d2487054 /docs
parentef6892fd6a3c95d7076b0e707f20f38430d8948b (diff)
downloadserver-64f345c56447fb01e73c99827c028f6507a1514b.tar.gz
Docs improvements.
Diffstat (limited to 'docs')
-rw-r--r--docs/server/toolbox.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/server/toolbox.md b/docs/server/toolbox.md
index f589901..eeb778f 100644
--- a/docs/server/toolbox.md
+++ b/docs/server/toolbox.md
@@ -9,7 +9,7 @@ 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
+ ln -s ~/server/bin/rtt ~/.local/bin/rtt
Alternatively, you can edit your .profile to add the server bin directory to your PATH.
@@ -21,6 +21,8 @@ Check that the command works by running the command to create the database:
## Commands
+ usage: rtt <subcommand> [ arguments... ]
+
database management
init -- create database
@@ -42,15 +44,22 @@ module development
game debugging
+ show -- show game state
show-chat -- show game chat (for moderation)
- show-game -- show game state object
show-replay -- show game replay log
+ show-snap -- show game rewind snapshot
miscellaneous tools
update-covers -- generate cover thumbnails
update-elo -- recalculate Elo ratings
+archive database
+
+ archive-backup -- backup replay data into archive
+ archive-prune -- prune replay data from live database
+ archive-restore -- restore replay data from archive
+
## Miscellaneous
The "tools" directory holds various useful bits and bobs.