-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add page documenting banlist functionality (#275)
Adds docs of how `ban`, `unban` and the `banlist.txt` work
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
docs/hosting-a-server-with-northstar/server-settings/banlist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`). |