steamgifts-bot/README.md
mcinj a101447eeb reorganization
- Had to reorganize so that Alembic's env.py could reference the tables in both local environment and a docker environment without manually modifying the python sys path. Maybe there is a better way idk
2022-05-20 12:20:08 -04:00

46 lines
1.2 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

### About
The bot is specially designed for [SteamGifts.com](https://www.steamgifts.com/)
### Features
- Automatically enters giveaways.
- Undetectable.
- Сonfigurable.
- Sleeps to restock the points.
- Can run 24/7.
## Instructions
1. Rename `config/config.ini.example` to `config/config.ini`.
2. Add your PHPSESSION cookie to it.
3. Modifying the other settings is optional.
### Run from sources
```bash
python -m venv env
source env/bin/activate
pip install -r requirements.txt
python main.py
```
### Docker
#### Run it
```bash
# Run the container
# Set TZ based on your timezone: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
docker run --name steamgifts -e TZ=America/New_York -d -v /path/to/the/config/folder:/config mcinj/docker-steamgifts-bot:latest
```
#### Or build it yourself locally
```bash
# Build the image
docker build -t steamgifts:latest .
# Run the container
# Set TZ based on your timezone: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
docker run --name steamgifts -e TZ=America/New_York -d -v /path/to/the/config/folder:/config steamgifts:latest
```
### Help
Please leave your feedback and bugs in `Issues` page.