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

Update README.md
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:10:04 +00:00
parent 3981edb006
commit 2d2cf708ef
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -16,6 +16,10 @@ A multi-purpose Discord integration bot for Project Zomboid.
### Environment Variables
Despite being isolated to a docker container in deployment, the environment variables are prefixed with the application name (`SPIFFO__`).
This should make the environment variables used be more clear and pronounced when you choose to use them or otherwise.
|Variable|Description|Required|Default Value|
|-|-|:-:|-|
|`SPIFFO__BOT_TOKEN`|Credential to allow the application to authenticate as the bot.|✔||
@ -25,7 +29,7 @@ A multi-purpose Discord integration bot for Project Zomboid.
|`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|
|`SPIFFO__SERVER_NAME`|Name of the server instance, don't change unless you know what you are doing!||servertest|
## Why Did I Make This?