Skip to content

bernardopg/steam-idler-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

103 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Steam Idle Bot โ€” farm playtime and trading-card drops on autopilot

Python 3.12+ uv-managed 560 tests passing mypy clean MIT license English docs Docs em Portuguรชs

Farm Steam playtime and trading-card drops on autopilot. Steam Idle Bot syncs your library, idles only the games that still have cards to drop, and remembers what's already finished โ€” so every run scans less and starts faster. Live terminal dashboard, optional desktop GUI, two interchangeable idling backends with automatic fallback.


Why it's different

Most idlers blindly run every game forever. Steam Idle Bot is accurate and self-pruning:

๐ŸŽด Drops only where it matters Detects which games have trading cards and how many drops remain โ€” idles just those, never wasting a slot on a drained game.
๐Ÿง  Learns over time Persistent no-drop caches record fully-farmed games; short-lived positive caches avoid re-scraping active games every refresh.
๐Ÿ” Accurate by design Verifies the Steam web session is genuinely logged in before trusting it; auto-recovers a valid session from a browser you're signed into.
๐Ÿ–ฅ๏ธ Readable output Live panel of game names, cards remaining and idle time; structured session report + optional JSON/Markdown checkpoints.
๐Ÿ” Two backends, one interface Built-in Python client (Steam Guard / 2FA) or a local steam-utility install โ€” with transparent fallback if one fails.
๐Ÿ”„ Rotates when cards drain Inventory snapshots can prove a game dropped all known remaining cards before badge pages catch up, so refreshes can replace it mid-session.
โšก Modern & tested uv-managed, fully typed, 560 tests across Python 3.12โ€“3.14.

Quick start

# 1. Install uv (if needed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# 2. Clone & install
git clone https://github.com/bernardopg/steam-idler-python.git
cd steam-idler-python
uv sync

# 3. Configure (never commit the filled .env)
cp .env.example .env
#    edit .env โ†’ USERNAME, PASSWORD, and ideally STEAM_API_KEY

# 4. Preview without contacting Steam
./run.sh --dry-run

# 5. Run it โ€” terminal, or ./run-gui.sh for the desktop GUI
./run.sh

๐Ÿ’ก A free Steam Web API key unlocks automatic library sync and badge-based filtering. Without it the bot still runs โ€” it just can't filter as precisely.


How it works

The orchestrator wires a configuration layer to a swappable idling backend and three card services, then drives a refresh loop that tracks drops as they drain.

Architecture: entry and config feed the SteamIdleBot orchestrator, which drives a swappable backend and three card services, with results tracked by IdleTracker

Game selection is a funnel โ€” each stage narrows the set, capped at Steam's hard limit of 32:

Pipeline: library source, then has-cards filter, then drops-remaining filter, then exclusions and cap to 32 games


Common commands

./run.sh                              # run normally (terminal)
./run.sh --dry-run                    # print config + chosen games, no Steam contact
./run.sh --no-trading-cards           # skip trading-card filtering
./run.sh --max-games 10               # cap idled games
./run.sh --refresh-interval-seconds 300   # re-run selection every 5 min
./run.sh --checkpoint-minutes 5 --duration-minutes 25  # timed run + JSON/MD checkpoints
./run.sh --stop-app-ids "570,730"     # stop steam-utility idles for those App IDs and exit
STEAM_IDLE_SKIP_SYNC=1 ./run.sh       # skip the runner's preflight uv sync
STEAM_IDLE_RUNNER_VERBOSE=1 ./run.sh  # show uv sync output while preparing the environment
./run-gui.sh                          # desktop GUI

./run.sh keeps the Python bot out of a shell pipeline so Ctrl+C reaches it directly, writes bot output to logs/runs/run_*.log, and prints a short startup/exit banner. By default it clears stale exported Steam Idle Bot environment overrides so .env wins; set STEAM_IDLE_PRESERVE_ENV=1 when you intentionally want exported variables to override .env.

Full flag and setting reference: USAGE guide.


Configuration

Settings come from environment variables / a .env file (copy .env.example). The two required values are USERNAME and PASSWORD; everything else has sane defaults.

Key Default Purpose
STEAM_API_KEY โ€” Library sync + badge filtering (recommended)
IDLING_BACKEND python python or steam_utility
MAX_GAMES_TO_IDLE 30 Cap (Steam hard limit: 32)
REFRESH_INTERVAL_SECONDS 600 How often the selection pipeline re-runs
CHECKPOINT_MINUTES 0 Write JSON/MD checkpoints every N min (0 = off)
DURATION_MINUTES 0 Stop after N min (0 = run until interrupted)
POST_RUN_VERIFY_SECONDS 0 Re-scrape card counts N s after stopping
AUTO_BROWSER_COOKIES true Recover a community session from a logged-in browser

๐Ÿ” Card-drop filtering needs an authenticated web:community session. See the authentication & accuracy guide.


Documentation

๐Ÿ‡บ๐Ÿ‡ธ English ๐Ÿ‡ง๐Ÿ‡ท Portuguรชs (BR)
Full guide README README
Command sheet USAGE USAGE
Security SECURITY SECURITY
Roadmap & backlog BACKLOG BACKLOG

Requirements

  • Python 3.12+ โ€” managed for you by uv
  • A Steam account with games that have trading cards
  • Steam Web API key (recommended) โ€” library sync + badge data
  • For drop filtering โ€” an authenticated Steam web session

Contributing

Contributions welcome in both languages. Run uv run ruff check . && uv run mypy src && uv run pytest -q before opening a PR. See the developer guides: ๐Ÿ‡บ๐Ÿ‡ธ English ยท ๐Ÿ‡ง๐Ÿ‡ท Portuguรชs. The prioritized roadmap lives in BACKLOG.md.

License

MIT โ€” see LICENSE. Not affiliated with Valve. Use responsibly and follow Steam's Terms of Service.

About

๐ŸŽฎ A lightweight Python script that idles Steam games to farm trading cards automatically. Runs in the background, supports multiple games, and keeps things simple. Perfect for boosting your Steam inventory and earning card drops without extra effort or risky third-party tools.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors