watn3y/steamsalty
1
0
Fork 0
mirror of https://github.com/watn3y/steamsalty.git synced 2025-10-25 09:51:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add documentation for new and changes features

Browse source
This commit is contained in:
Noah 2025-10-13 17:24:32 +02:00
parent 038d375ae7
commit 9f582e4c75
No known key found for this signature in database
GPG key ID: D2A7E2C8F77E0430
2 changed files with 29 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

10
.env.example Normal file
View file

@ -0,0 +1,10 @@
STEAMSALTY_LOGLEVEL=
STEAMSALTY_CHATID=
STEAMSALTY_WATCHERS=
STEAMSALTY_SLEEPINTERVAL=
STEAMSALTY_TRANSLATE_ENABLED=
STEAMSALTY_TRANSLATE_LANGUAGE=
STEAMSALTY_TELEGRAM_APITOKEN=
STEAMSALTY_STEAMAPIKEY=
STEAMSALTY_DEEPL_APIKEY=
STEAMSALTY_DEEPL_FREETIER=

34
README.md
View file

@ -18,11 +18,15 @@ services:
- /etc/localtime:/etc/localtime:ro - /etc/localtime:/etc/localtime:ro
environment: environment:
#- STEAMSALTY_LOGLEVEL= #- STEAMSALTY_LOGLEVEL=
- STEAMSALTY_TELEGRAMAPITOKEN=
- STEAMSALTY_STEAMAPIKEY=
- STEAMSALTY_CHATID= - STEAMSALTY_CHATID=
- STEAMSALTY_WATCHERS= - STEAMSALTY_WATCHERS=
#- STEAMSALTY_SLEEPINTERVAL= - STEAMSALTY_SLEEPINTERVAL=
#- STEAMSALTY_TRANSLATE_ENABLED=
#- STEAMSALTY_TRANSLATE_LANGUAGE=
- STEAMSALTY_TELEGRAM_APITOKEN=
- STEAMSALTY_STEAMAPIKEY=
#- STEAMSALTY_DEEPL_APIKEY=
#- STEAMSALTY_DEEPL_FREETIER=
``` ```
## Running on Linux ## Running on Linux
@ -34,15 +38,15 @@ Grab a release from the [releases page](https://github.com/watn3y/steamsalty/rel
> [!NOTE] > [!NOTE]
> For development purposes, SteamSalty supports loading environment variables from a .env file placed in the project root directory. > For development purposes, SteamSalty supports loading environment variables from a .env file placed in the project root directory.
| Variable | Description | Default | Required | | Variable | Description | Default | Required | Example |
|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------| |---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------|-----------------------------------------------|
| `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | ❌ | | `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | ❌ | 1 |
| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | ❌ | | `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | ❌ | 60 |
| `STEAMSALTY_TRANSLATE_ENABLED` | Whether to enable translation of comments | False | ❌ | | `STEAMSALTY_TRANSLATE_ENABLED` | Whether to enable translation of comments | False | ❌ | True, False |
| `STEAMSALTY_TRANSLATE_LANGUAGE` | Language to translate as described [in the DeepL API documentation](https://developers.deepl.com/docs/getting-started/supported-languages#translation-target-languages) | EN-US | ❌ | | `STEAMSALTY_TRANSLATE_LANGUAGE` | Language to translate as described [in the DeepL API documentation](https://developers.deepl.com/docs/getting-started/supported-languages#translation-target-languages) | EN-US | ❌ | EN-US,DE |
| `STEAMSALTY_CHATID` | Chat to notify about new comments | None | ✅ | | `STEAMSALTY_CHATID` | Chat to notify about new comments | None | ✅ | -1001234567890 |
| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new profile comments | None | ✅ | | `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new profile comments | None | ✅ | 76561198012345678,76561198087654321 |
| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram BotToken, get it from [@BotFather on Telegram](https://t.me/BotFather) | None | ✅ | | `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram BotToken, get it from [@BotFather on Telegram](https://t.me/BotFather) | None | ✅ | 1234567890:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw |
| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get it from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None | ✅ | | `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get it from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None | ✅ | A7B3C9D2E5F1A4B8C6D9E2F5A8B1C4D7E0F3A6B9 |
| `STEAMSALTY_DEEPL_APIKEY` | DeepL API Key, get it from [deepl.com/en/your-account/keys](https://www.deepl.com/en/your-account/keys) | None | ❌ | | `STEAMSALTY_DEEPL_APIKEY` | DeepL API Key, get it from [deepl.com/en/your-account/keys](https://www.deepl.com/en/your-account/keys) | None | ❌ | a1b2c3d4-56e7-89f0-a1b2-c3d4e5f6a7b8:fx |
| `STEAMSALTY_DEEPL_FREETIER` | Whether you are using the DeepL Free Tier | True | ❌ | | `STEAMSALTY_DEEPL_FREETIER` | Whether you are using the DeepL Free Tier | True | ❌ | True, False |