From 3981edb0061347280381c5702480d3f53aec99d6 Mon Sep 17 00:00:00 2001 From: Corban-Lee Jones Date: Sat, 7 Dec 2024 01:07:55 +0000 Subject: [PATCH] environment variables in readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index c6aa859..fd36c5a 100644 --- a/README.md +++ b/README.md @@ -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.