watn3y/steamsalty
1
0
Fork 0
mirror of https://github.com/watn3y/steamsalty.git synced 2025-10-24 09:21:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
Get notifications about Steam Comments on Telegram
33 commits 1 branch 5 tags 165 KiB
Find a file
Exact
Noah Theus 8548acf79c
Some checks failed
Build and Push to Docker Hub on push to any branch / docker (push) Has been cancelled
Details
deps: bump golang to 1.25.2
2025-10-14 01:08:38 +02:00
.github/workflows chore: Only tag images with branchname if changes are on master branch 2025-10-13 17:27:26 +02:00
.vscode chore: add vscode launch config 2025-10-13 16:10:06 +02:00
botIO refactor!: change config structure to be more readable 2025-10-13 17:02:20 +02:00
commands refactor: Standardized logging to be more uniform 2025-08-31 03:51:36 +02:00
config fix: Fix config parsing 2025-10-13 20:58:46 +02:00
deepL refactor!: change config structure to be more readable 2025-10-13 17:02:20 +02:00
steam refactor!: change config structure to be more readable 2025-10-13 17:02:20 +02:00
.env.example docs: Add documentation for new and changes features 2025-10-13 17:24:32 +02:00
.gitignore gitignore vscode config 2024-12-22 08:20:51 +01:00
bot.go refactor: Standardized logging to be more uniform 2025-08-31 03:51:36 +02:00
build.sh add build script 2024-12-22 07:41:48 +01:00
Dockerfile deps: bump golang to 1.25.2 2025-10-14 01:08:38 +02:00
go.mod deps: bump golang to 1.25.2 2025-10-14 01:08:38 +02:00
go.sum feat: Parse environment variables from .env file 2025-08-31 03:49:57 +02:00
LICENSE Initial commit 2024-12-19 08:37:16 +01:00
main.go refactor!: change config structure to be more readable 2025-10-13 17:02:20 +02:00
README.md docs: fix typo 2025-10-13 18:01:55 +02:00

README.md

SteamSalty

SteamSalty notifies you on telegram about new comments on any steam profile with built in auto translation.

Running with Docker Compose

Docker image: https://hub.docker.com/r/watn3y/steamsalty

Example compose file:

services:
  steamsalty:
    image: watn3y/steamsalty:latest # use :<branchname> to be up-to-date with any branch 
    container_name: steamsalty
    restart: unless-stopped
    volumes:
      - /etc/localtime:/etc/localtime:ro
    environment:
      #- 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=

Running on Linux

Grab a release from the releases page. Make sure to set your environment variables accordingly.

Environment Variables

Note

For development purposes, SteamSalty supports loading environment variables from a .env file placed in the project root directory.

Variable Description Default Required Example
STEAMSALTY_LOGLEVEL LogLevel as described in the zerolog documentation 1 (Info) ❌ 1
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 ❌ True, False
STEAMSALTY_TRANSLATE_LANGUAGE Language to translate as described in the DeepL API documentation EN-US ❌ EN-US,DE
STEAMSALTY_CHATID Chat to notify about new comments None ✅ -1001234567890
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 None ✅ 1234567890:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw
STEAMSALTY_STEAMAPIKEY Steam API Key, get it from steamcommunity.com/dev/apikey None ✅ A7B3C9D2E5F1A4B8C6D9E2F5A8B1C4D7E0F3A6B9
STEAMSALTY_DEEPL_APIKEY DeepL API Key, get it from 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 ❌ True, False

Nice to know

Semantic Versioning

This project does it's best to follow Semantic Versioning, however I can't guarantee anything.