From 2d2cf708efb9f9bdcaa250caddf01fdac075198d Mon Sep 17 00:00:00 2001 From: Corban-Lee Jones Date: Sat, 7 Dec 2024 01:10:04 +0000 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd36c5a..4b208d2 100644 --- a/README.md +++ b/README.md @@ -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?