corbz/Spiffo
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Actions Activity

environment variables in readme
All checks were successful
Build and Push Docker Image / build (push) Successful in 12s
Details

Browse Source
This commit is contained in:
Corban-Lee Jones 2024-12-07 01:07:55 +00:00
parent ba23b9d868
commit 3981edb006
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -12,6 +12,21 @@ A multi-purpose Discord integration bot for Project Zomboid.
- Ability to read directly from the server console log for accurate up-to-date info.
- Super easy deployment via docker with environment variables for configuration.
## Setup
### Environment Variables
|Variable|Description|Required|Default Value|
|-|-|:-:|-|
|`SPIFFO__BOT_TOKEN`|Credential to allow the application to authenticate as the bot.|✔||
|`SPIFFO__RCON_HOST`|Host of the server's remote console.|✔||
|`SPIFFO__RCON_PORT`|Port of the server's remote console.|✔||
|`SPIFFO__RCON_PASSWORD`|Password of the server's remote console.|✔||
|`SPIFFO__DISCORD_CHANNEL_ID`|Snowflake ID of the channel where join alerts and other server related messages should appear.|✔||
|`SPIFFO__STEAM_API_KEY`|Web API key granted by steam, allows for the user's steam profile info to be shown in the join alerts.|||
|`SPIFFO__ZOMBOID_FOLDER_PATH`|Absolute path to the 'Zomboid' folder that contains the `server-console.txt` file.|✔||
|`SPIFFO__SERVER_NAME`|Name of the server instance, don't change unless you know what you are doing!|✔|servertest|
## Why Did I Make This?
All existing bots are poorly coded, slow and/or lack certain features.