diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0cfd714 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# ValheimPlus-Discord_Bot +Valheim Plus discord bot based off of [ckbaudio's valheim-discord-bot](https://github.com/ckbaudio/valheim-discord-bot) + +## Setup: +**Working MySQL server is needed for this bot.** +`table_info.sql` Has Table info for the database +`pip install -r requirements.txt` To install Pyhton requirements. + +## [config.py](https://github.com/stolenvw/ValheimPlus-Discord_Bot/code/config.py) +Edit this file with your info. Setting should be self-explanitory. + +Add `-logfile /location/to/file.log` to your start command to get a logfile. + +**Warning:** If using the `BepInEx/LogOutput.log` file you need to edit the **BepInEx.cfg** file `AppendLog = true` *If you do not set this and server is started before bot, or restarted without restarting bot it will not work.* When using the `LogOutPut.log` Extra Server Info World Zdos save info **will not be available** + +For `WORLDSIZE` user running the bot must have read permissions to the world.db.old file + +## Usage: +`python3 plusbot.py` While in the `code` dir. +`nohup python3 plusbot.py &` Too run in background. +Or you can create a service to run `plusbot.py` under systemd + +**help** Shows available commands + +### Example Output: + |