From b5a6a876494b08b8e85e7aa8dfe463430e30196f Mon Sep 17 00:00:00 2001 From: Piplup <100526773+piplup55@users.noreply.github.com> Date: Wed, 13 Jul 2022 03:46:27 +0100 Subject: [PATCH] Add blurbs about settings to readme (#11) Co-authored-by: Sanae <32604996+Sanae6@users.noreply.github.com> --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index f8b2f50..97e0006 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file