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

v1.0

Browse source 
- Fixed SLEEPTIME not working (always 0)
- Refined logging
- Added metadata to /info command
- Bot now automatically sets own commands for autocompletion
This commit is contained in:
Noah 2024-12-22 07:13:19 +01:00
parent d50b026545
commit 6c733c6e41
No known key found for this signature in database
GPG key ID: D2A7E2C8F77E0430
14 changed files with 116 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,2 +1,40 @@
# steamsalty
Get notifications about Steam Comments on Telegram
# SteamSalty
SteamSalty notifies you on telegram about new comments on any steam profile.
## Running with Docker Compose
Docker image: https://hub.docker.com/r/watn3y/steamsalty
Example compose file:
```yaml
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_TELEGRAMAPITOKEN=
- STEAMSALTY_STEAMAPIKEY=
- STEAMSALTY_CHATID=
- STEAMSALTY_WATCHERS=
#- STEAMSALTY_SLEEPINTERVAL=
```
## Running on Linux
Grab a release from the [releases page](https://github.com/watn3y/steamsalty/releases). Make sure to set your **environment variables** accordingly.
## Environment Variables
| Variable | Description | Default |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `STEAMSALTY_LOGLEVEL` | LogLevel as described [here](https://pkg.go.dev/github.com/rs/zerolog@v1.33.0#readme-simple-leveled-logging-example) | 1 (Info) |
| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** |
| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from https://steamcommunity.com/dev/apikey | None, **required** |
| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** |
| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** |
| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 |