From 02d45ddd4b8cf3264bd2d01c265ee135da50c34a Mon Sep 17 00:00:00 2001 From: core Date: Sun, 16 Nov 2025 00:43:19 -0500 Subject: [PATCH] feat: documentation --- README.md | 2 ++ index.md | 4 ++++ 2 files changed, 6 insertions(+) create mode 100644 index.md diff --git a/README.md b/README.md index 55d68a62431456575ec555bd82bcdd4edc1363c6..10b76f2737de53f3c60f174e91100d34d016bea2 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,5 @@ a game about floating through space ## building don't + +documentation: https://man.srht.e3t.cc/~starkingdoms/starkingdoms \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000000000000000000000000000000000000..f46e7ae8864bb75ee82b7209aa0eb6ee32bcdfd9 --- /dev/null +++ b/index.md @@ -0,0 +1,4 @@ +# starkingdoms: the manual + +how to run client: `RUST_LOG="info,starkingdoms=trace" cargo run -F native -- client --server 'ws://[::1]:5151'` +how to run server: `RUST_LOG="info,starkingdoms=trace" cargo run -F native -- server --tick-rate 60 --max-clients 16` \ No newline at end of file