From 083bbae1158b7afa66f53ccff73a2905dbca1244 Mon Sep 17 00:00:00 2001
From: Cyn <70904206+itscynxx@users.noreply.github.com>
Date: Mon, 8 Jan 2024 13:08:27 -0600
Subject: Add page documenting banlist functionality (#275)

Adds docs of how `ban`, `unban` and the `banlist.txt` work
---
 .../server-settings/banlist.md                     | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 docs/hosting-a-server-with-northstar/server-settings/banlist.md

(limited to 'docs/hosting-a-server-with-northstar/server-settings/banlist.md')

diff --git a/docs/hosting-a-server-with-northstar/server-settings/banlist.md b/docs/hosting-a-server-with-northstar/server-settings/banlist.md
new file mode 100644
index 0000000..441b69c
--- /dev/null
+++ b/docs/hosting-a-server-with-northstar/server-settings/banlist.md
@@ -0,0 +1,31 @@
+# Banlist
+
+The `banlist.txt` file found at `R2Northstar\banlist.txt` is a list of players that you have either banned or unbanned from your server.
+
+The UIDs can be formatted as shown below:
+```
+1111111111
+
+4444444444
+```
+
+This file also supports the use of comments with the `#` symbol:
+
+```
+# This is a comment
+1111111111
+
+4444444444 # Banned for being uncool
+```
+
+## Banning
+
+When banning a player in game using the `ban` command in console, their UID will be added to the list in `banlist.txt`.
+
+The `ban` command is used alongside the name of the player you want to ban (e.g. `ban realPlayerFr`), or with their UID (e.g. `ban 1111111111`). The console will auto-complete the name for you, given you have typed something close to a valid name of a player in the game.
+
+## Unbanning
+
+When unbanning a player in game using the `unban` command in console, their UID will be commented out in the file, as well as a comment next to their UID displaying the unban date.
+
+The `unban` command is used alongisde the UID of the player you want to unban (e.g. `unban 1111111111`).
-- 
cgit v1.2.3