Add blurbs about settings to readme (#11)

Co-authored-by: Sanae <32604996+Sanae6@users.noreply.github.com>
This commit is contained in:
Piplup 2022-07-13 03:46:27 +01:00 committed by GitHub
parent 967a89a55b
commit b5a6a87649
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions

View File

@ -37,3 +37,18 @@ Run the `loadsettings` command in the console to update the settings without res
Server address and port will require a server restart, but everything else should update when you run `loadsettings`.
[//]: # (TODO: Document all commands, possibly rename them too.)
## Settings
### Server
Address: the ip address of the server, default: 0.0.0.0 # this shouldn't be changed
Port: the port of the server, default 1027
Maxplayers: the max amount of players that can join, default: 8
Flip: flips the player upside down, defaults: enabled: true, pov: both
Scenario: sync's scenario's for all players on the server, default: false
Banlist: banned people are unable to join the server, default: false
### Discord
Token: the token of the bot you want to load into, default: null
Prefix: the bot prefix to be used, default: $
LogChannel: logs the server console to that channel, default: null