twitch-miner-go

README

1. Twitch Channel Points Miner — Go Edition

A high-performance Go rewrite of the Twitch Channel Points Miner v2. Mines channel points, claims bonuses, places predictions, joins raids, claims drops, and more — all with a fraction of the resource usage.

1.1. Table of Contents

1. 1. Twitch Channel Points Miner — Go Edition
   1. 1.1. Table of Contents
   2. 1.2. Features
   3. 1.3. Resource Comparison
   4. 1.4. Running Locally
      1. 1.4.1. Flags
   5. 1.5. Configuration
      1. 1.5.1. Quick Start
   6. 1.6. Environment Variables
      1. 1.6.1. Global
      2. 1.6.2. Per-Account Authentication
      3. 1.6.3. Per-Account Notifications
      4. 1.6.4. .env File Support
   7. 1.7. Notifications
      1. 1.7.1. Supported Providers
      2. 1.7.2. Example: Telegram
      3. 1.7.3. Event Filtering
      4. 1.7.4. Notification Batching
      5. 1.7.5. Testing Notifications
   8. 1.8. Authentication
      1. 1.8.1. When to use the env vars
   9. 1.9. Docker
   10. 1.10. Deploy to Fly.io
       1. 1.10.1. Setup
       2. 1.10.2. CI/CD Auto-Deploy
       3. 1.10.3. Manual Deploy
       4. 1.10.4. Alternative Deployment
   11. 1.11. Development
   12. 1.12. Auto-Update Checker
   13. 1.13. License

1.2. Features

• Multi-account support — run multiple Twitch accounts from a single binary
• Channel points mining — automatic minute-watched events, bonus claims, watch streaks
• Predictions — configurable betting strategies (SMART, HIGH_ODDS, MOST_VOTED, etc.)
• Drops — automatic campaign sync and drop claiming
• Raids — automatic raid joining
• Community moments — automatic moment claiming
• Community goals — automatic goal contributions
• Gift sub detection — notifies when your account receives a gifted subscription
• Category watcher — auto-discover streamers by game category
• Notifications — Telegram, Discord, Webhook, Matrix, Pushover, Gotify
• Analytics dashboard — built-in web UI for monitoring
• Fly.io ready — deploy with a single command; Docker Compose also supported

1.3. Resource Comparison

Resource	Python (per account)	Go (per account)
Memory	~80–120 MB	~5–15 MB
Docker image	~800 MB	~10–15 MB
Startup time	~5–10 s	< 100 ms
Threads	60+	~10–20 goroutines

1.4. Running Locally

Prerequisites: Go 1.24+

Unix (macOS/Linux):

./run.sh

Windows:

run.bat

With custom flags:

./run.sh -config configs -port 9090 -log-level debug

The scripts build the binary and run it in one step. You can also build manually with go build -o twitch-miner-go ./cmd/twitch-miner-go.

1.4.1. Flags

Flag	Default	Description
-config	configs	Path to the configuration directory
-port	8080	Port for the health/analytics server
-log-level	INFO	Log level: DEBUG, INFO, WARN, ERROR (effective default: INFO)
-version	false	Print version and exit

1.5. Configuration

Create one YAML file per account in the configs/ directory. The filename (without extension) becomes the Twitch username — no username field is needed in the YAML.

For example, to add an account for Twitch user guliveer_, create configs/guliveer_.yaml.

# Copy the example and customize for your account
cp configs/example.yaml.example configs/your_twitch_username.yaml

See configs/example.yaml.example for the full schema. Files with a .yaml.example extension are not loaded as configs — only .yaml and .yml files are loaded.

1.5.1. Quick Start

# configs/your_twitch_username.yaml
# The filename IS the username — no username field needed.

# Set to false to disable this account without deleting the config (default: true)
enabled: true

features:
  claim_drops_startup: false
  enable_analytics: true

max_watch_streams: 2

priority:
  - STREAK
  - DROPS
  - ORDER

streamer_defaults:
  make_predictions: true
  follow_raid: true
  claim_drops: true
  claim_moments: true
  watch_streak: true
  community_goals: false
  chat: "ONLINE"
  bet:
    strategy: "SMART"
    percentage: 5
    max_points: 50000
    delay: 6
    delay_mode: "FROM_END"

streamers:
  - username: "streamer1"
  - username: "streamer2"
    settings:
      make_predictions: false

# Blacklisted streamers excluded even if followed
blacklist:
  - "unwanted_streamer"

# Follow mode — also watch all followed channels
followers:
  enabled: false
  order: "ASC"

1.6. Environment Variables

Secrets and auth tokens are injected via environment variables. Per-account variables require a _<USERNAME> suffix (uppercase) to scope them to the correct account.

Use the configs/ directory for per-account behavior such as watched streamers, betting strategy, and feature toggles. Use environment variables or .env for secrets and global runtime values that should not be duplicated per account.

For example, for user guliveer_ the Telegram token variable is TELEGRAM_TOKEN_GULIVEER_ and the auth token variable is TWITCH_AUTH_TOKEN_GULIVEER_.

1.6.1. Global

Variable	Description	Default
LOG_LEVEL	Log level (DEBUG, INFO, WARN, ERROR)	INFO
PORT	HTTP server port for health/analytics	8080
DATA_DIR	Persistent data directory (cookies, state)	.
TWITCH_CLIENT_ID_TV	Twitch TV client ID (falls back to built-in default if unset; override recommended)	built-in default
TWITCH_CLIENT_ID_BROWSER	Twitch browser client ID (falls back to built-in default if unset; override recommended)	built-in default
TWITCH_CLIENT_VERSION	Twitch browser client version (falls back to built-in default if unset; override recommended)	built-in default
TWITCH_CLIENT_ID_MOBILE	Twitch mobile web client ID (falls back to built-in default if unset)	built-in default
TWITCH_CLIENT_ID_ANDROID	Twitch Android client ID (falls back to built-in default if unset)	built-in default
TWITCH_CLIENT_ID_IOS	Twitch iOS client ID (falls back to built-in default if unset)	built-in default

Note: Twitch client IDs and versions have compiled-in defaults (from internal/constants) that are used when the corresponding environment variables are unset. These defaults may become stale as Twitch updates their clients, so it is recommended to set these environment variables explicitly.

1.6.2. Per-Account Authentication

Variable	Description
TWITCH_AUTH_TOKEN_<USERNAME>	OAuth token (fallback for headless auth)
TWITCH_PASSWORD_<USERNAME>	Twitch password (last-resort auth, may require 2FA)

1.6.3. Per-Account Notifications

Variable	Description
TELEGRAM_TOKEN_<USERNAME>	Telegram bot token
TELEGRAM_CHAT_ID_<USERNAME>	Telegram chat ID
DISCORD_WEBHOOK_<USERNAME>	Discord webhook URL
WEBHOOK_URL_<USERNAME>	Generic webhook URL
MATRIX_HOMESERVER_<USERNAME>	Matrix homeserver URL
MATRIX_ROOM_ID_<USERNAME>	Matrix room ID
MATRIX_ACCESS_TOKEN_<USERNAME>	Matrix access token
PUSHOVER_TOKEN_<USERNAME>	Pushover API token
PUSHOVER_USER_KEY_<USERNAME>	Pushover user key
GOTIFY_URL_<USERNAME>	Gotify server URL
GOTIFY_TOKEN_<USERNAME>	Gotify app token

1.6.4. .env File Support

The project supports loading environment variables from a .env file at startup using joho/godotenv. This is optional — if no .env file is present, the app runs normally using YAML configs and/or standard environment variables.

Environment variables (whether from .env or the system) override the corresponding values from YAML config files for notification secrets only. This allows you to keep sensitive tokens out of version-controlled YAML files.

Example .env file:

# Global
LOG_LEVEL=DEBUG
PORT=9090

# Required Twitch runtime identifiers
TWITCH_CLIENT_ID_TV=your_tv_client_id
TWITCH_CLIENT_ID_BROWSER=your_browser_client_id
TWITCH_CLIENT_VERSION=your_client_version

# Optional Twitch client identifiers for future compatibility
TWITCH_CLIENT_ID_MOBILE=your_mobile_client_id
TWITCH_CLIENT_ID_ANDROID=your_android_client_id
TWITCH_CLIENT_ID_IOS=your_ios_client_id

# Notification secrets for user "guliveer_"
TELEGRAM_TOKEN_GULIVEER_=123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
TELEGRAM_CHAT_ID_GULIVEER_=987654321
DISCORD_WEBHOOK_GULIVEER_=https://discord.com/api/webhooks/...

See .env.example for the starter template.

How To Obtain Twitch Runtime Identifiers

The safest way to obtain these values is from real Twitch client requests that you control. Do not assume older values stay valid forever.

Browser values

1. Open https://www.twitch.tv in your browser.
2. Open DevTools and go to the Network tab.
3. Filter for gql.
4. Open a request to https://gql.twitch.tv/gql.
5. Copy these request headers:
   • Client-Id -> TWITCH_CLIENT_ID_BROWSER
   • Client-Version -> TWITCH_CLIENT_VERSION

TV client ID without owning a TV

You do not need a physical television. Practical options:

1. Use an Android TV emulator and inspect Twitch app traffic with a local proxy.
2. Use an Android phone emulator and the Twitch TV/device-login flow if you already proxy mobile traffic.
3. Reuse the TV client ID from a previously working setup and only replace it when Twitch invalidates it.

For this project today, the most important runtime values are:

• TWITCH_CLIENT_ID_TV
• TWITCH_CLIENT_ID_BROWSER
• TWITCH_CLIENT_VERSION

The mobile and platform-specific IDs are kept for future compatibility, but the current runtime path depends primarily on the TV and browser values.

1.7. Notifications

The miner supports multiple notification providers. Configure them in your account YAML file under the notifications key. Sensitive credentials (tokens, API keys) are injected via environment variables — see Environment Variables above.

1.7.1. Supported Providers

Provider	Config key	Required env vars
Telegram	telegram	TELEGRAM_TOKEN_*, TELEGRAM_CHAT_ID_*
Discord	discord	DISCORD_WEBHOOK_*
Gotify	gotify	GOTIFY_URL_*, GOTIFY_TOKEN_*
Pushover	pushover	PUSHOVER_TOKEN_*, PUSHOVER_USER_KEY_*
Matrix	matrix	MATRIX_HOMESERVER_*, MATRIX_ROOM_ID_*, MATRIX_ACCESS_TOKEN_*
Webhook	webhook	WEBHOOK_URL_*

* = _<USERNAME> suffix (uppercase). For example, user guliveer_ → TELEGRAM_TOKEN_GULIVEER_. See the full variable list in Environment Variables.

1.7.2. Example: Telegram

notifications:
  telegram:
    enabled: true
    token: "YOUR_BOT_TOKEN"
    chat_id: "YOUR_CHAT_ID"
    events:
      - "DROP_CLAIM"
      - "DROP_STATUS"
      - "STREAMER_ONLINE"
      - "STREAMER_OFFLINE"
      - "BET_WIN"
      - "BET_LOSE"
    disable_notification: false

Tip: The token and chat_id fields in YAML are optional — if omitted, the miner reads them from TELEGRAM_TOKEN_<USERNAME> and TELEGRAM_CHAT_ID_<USERNAME> environment variables instead. This is the recommended approach for production/headless deployments.

1.7.3. Event Filtering

The events list controls which events trigger a notification for a given provider. Events are configured per notification provider in the YAML config under notifications > {provider} > events.

• If the events list is empty or omitted, all events are sent to that provider.
• If specific events are listed, only those events trigger notifications for that provider.

Available events:

Event	Emoji	Description
STREAMER_ONLINE	🟢	Streamer goes online
STREAMER_OFFLINE	⚫	Streamer goes offline
GAIN_FOR_RAID	💵	Points gained from a raid
GAIN_FOR_CLAIM	💵	Points gained from claiming bonus
GAIN_FOR_WATCH	💵	Points gained from watching
GAIN_FOR_WATCH_STREAK	💵	Points gained from watch streak
BET_WIN	🏆	Prediction bet won
BET_LOSE	💸	Prediction bet lost
BET_REFUND	↩️	Prediction bet refunded
BET_FILTERS	🎰	Prediction filtered by settings
BET_GENERAL	🎰	General prediction info
BET_FAILED	🎰	Prediction bet failed
BET_START	🎰	Prediction started
BONUS_CLAIM	💵	Bonus claimed
MOMENT_CLAIM	🎉	Community moment claimed
JOIN_RAID	⚔️	Joined a raid
DROP_CLAIM	📦	Drop claimed
DROP_STATUS	📦	Drop progress status
CHAT_MENTION	💬	Mentioned in chat
GIFTED_SUB	🎁	Received a gifted sub (via IRC)
TEST	—	Test notification (see below)

Note: Emojis are prepended to log messages and notifications automatically. The emoji mappings are defined in eventEmoji. The event type constants are defined in internal/model/settings.go.

Example — send only specific events to Telegram:

notifications:
  telegram:
    enabled: true
    token: "..."
    chat_id: "..."
    events:
      - "GIFTED_SUB"
      - "BET_WIN"
      - "BET_LOSE"
      - "DROP_CLAIM"

1.7.4. Notification Batching

Instead of receiving a separate notification for every single event, you can enable batching to group events by streamer or category and deliver them as a single message at a configurable interval.

Global defaults with per-provider overrides:

notifications:
  batch:
    enabled: true
    interval: 30m # flush buffered events every 30 minutes
    max_entries: 15 # max lines per message; splits into multiple if exceeded
    immediate_events: # these bypass batching (empty list = batch everything)
      - "BET_WIN"
      - "BET_LOSE"
      - "DROP_CLAIM"

  discord:
    enabled: true
    batch:
      interval: 15m # override: Discord flushes every 15 minutes
  telegram:
    enabled: true
    batch:
      enabled: false # override: Telegram sends instantly

How it works:

• Events are grouped by their notification title (e.g. oliwer | xQc, oliwer | Valorant).
• At each interval, all buffered events for a group are joined as newline-separated lines and sent as one message.
• If a single event arrives in a batch window, it is sent as a regular (unbatched) message.
• If the buffer exceeds max_entries, the message is split into multiple sends.
• On graceful shutdown, all pending batched events are flushed before the process exits.
• Events listed in immediate_events are always sent instantly, bypassing the buffer.
• If immediate_events is empty or omitted, all events are batched.
• Per-provider batch config overrides the global defaults. Omitted fields inherit from global.

1.7.5. Testing Notifications

The miner exposes a POST /api/test-notification endpoint on the analytics server to verify your notification setup. It sends a test message to all enabled notification providers, bypassing event filters.

curl -X POST http://localhost:8080/api/test-notification

A successful response looks like:

{
  "status": "ok",
  "message": "Test notification sent to all enabled notifiers"
}

If some providers fail, you'll get a partial status with error details:

{
  "status": "partial",
  "errors": ["telegram: 401 Unauthorized"]
}

Note: Replace 8080 with your configured port (the -port flag or PORT env var). This endpoint is useful for verifying that tokens, chat IDs, and webhook URLs are correctly configured before relying on notifications in production.

1.8. Authentication

Authentication is automatic — on first run the miner walks through a priority chain until one method succeeds:

Priority	Method	Description
1	Cookie file	Saved from a previous successful login. Reused automatically. If expired, a refresh token flow is attempted first.
2	Auth token from config	Token set directly in the YAML config file (auth_token field).
3	TWITCH_AUTH_TOKEN_* env	Fallback — read via os.Getenv().
4	TWITCH_PASSWORD_* env	Last resort — password login via os.Getenv(). May require 2FA.
5	Device code flow	Interactive — displays a code in the terminal and waits for activation at twitch.tv/activate. (RECOMMENDED)

Once authenticated, the token is validated against the Twitch OAuth2 endpoint to confirm it belongs to the expected user (derived from the config filename). If there's a mismatch — for example, you completed the device code flow with the wrong Twitch account — the system will show a clear error like:

authenticated as "wrong_user" but config expects "your_username" — please log in with the correct account

The validated token is then saved to a cookie file and reused on subsequent starts — so the device code flow is typically a one-time step.

See internal/auth/auth.go for the full authentication implementation.

Warning: Password login (priority 4) may trigger Twitch's two-factor authentication (2FA) prompt, making it less reliable in fully headless environments. Prefer TWITCH_AUTH_TOKEN_<USERNAME> over TWITCH_PASSWORD_<USERNAME> whenever possible. Use the password method only as a last resort when you cannot obtain an OAuth token.

1.8.1. When to use the env vars

The TWITCH_AUTH_TOKEN_<USERNAME> env var is the recommended fallback when the interactive device code flow is impractical:

• Headless deployments — servers or containers without interactive terminal access (e.g., Fly.io, Docker hosts, cloud VMs)
• Multi-account setups — pre-seed tokens for several accounts without running the device flow for each
• CI/CD environments — automated pipelines where no human is present to complete the device flow

The variable name is TWITCH_AUTH_TOKEN_ followed by the uppercase username with hyphens replaced by underscores. Examples:

Username	Env var
guliveer_	TWITCH_AUTH_TOKEN_GULIVEER_
my-user	TWITCH_AUTH_TOKEN_MY_USER

Note: Both TWITCH_AUTH_TOKEN_<USERNAME> and TWITCH_PASSWORD_<USERNAME> are read directly in the auth flow (os.Getenv()), not through the config layer or applyEnvOverrides().

1.9. Docker

# Build
docker build -t twitch-miner-go .

# Run (DATA_DIR is required to persist cookies across container restarts)
docker run -d \
  -p 8080:8080 \
  -v miner_data:/data \
  -v $(pwd)/configs:/configs:ro \
  -e DATA_DIR=/data \
  --env-file .env \
  twitch-miner-go

# Run with auth token (recommended — for headless environments)
docker run -d \
  -p 8080:8080 \
  -v miner_data:/data \
  -v $(pwd)/configs:/configs:ro \
  -e DATA_DIR=/data \
  --env-file .env \
  -e TWITCH_AUTH_TOKEN_YOUR_USERNAME=your_oauth_token \
  twitch-miner-go

# Run with password (optional — last resort, may require 2FA)
docker run -d \
  -p 8080:8080 \
  -v miner_data:/data \
  -v $(pwd)/configs:/configs:ro \
  -e DATA_DIR=/data \
  --env-file .env \
  -e TWITCH_PASSWORD_YOUR_USERNAME=your_twitch_password \
  twitch-miner-go

Docker Compose

docker compose up -d

The included docker-compose.yml uses the published GHCR image by default:

ghcr.io/guliveer/twitch-miner-go:latest

Set TWITCH_MINER_IMAGE in .env if you want to pin a version or use a different registry/tag.

The compose setup mounts:

• ./configs to /configs as read-only account configuration
• a named volume to /data for cookies and persisted session state
• .env for required Twitch client identifiers, dashboard auth, and account secrets

GitHub Container Registry

This repository publishes Docker images to GHCR with GitHub Actions.

• main pushes publish latest and a short SHA tag
• version tags such as v1.2.3 publish 1.2.3 and 1.2

Example image references:

• ghcr.io/guliveer/twitch-miner-go:latest
• ghcr.io/guliveer/twitch-miner-go:1.2.3
• ghcr.io/guliveer/twitch-miner-go:sha-abcdef1

1.10. Deploy to Fly.io

The repo includes fly.toml — the Fly.io deployment config. Fly.io is a personal preference and comes pre-configured, but the miner is portable and runs on any platform that supports Go (AWS, GCP, Azure, DigitalOcean, etc.).

1.10.1. Setup

# 1. Copy the example account config and customize (filename = your Twitch username)
cp configs/example.yaml.example configs/your_twitch_username.yaml

# 2. Install flyctl
curl -L https://fly.io/install.sh | sh

# 3. Login
fly auth login

# 4. Create the app (first time only)
fly launch --no-deploy

# 5. Create a volume for persistent data
fly volumes create miner_data --region fra --size 1

# 6. Set required Twitch runtime identifiers
fly secrets set TWITCH_CLIENT_ID_TV=your_tv_client_id
fly secrets set TWITCH_CLIENT_ID_BROWSER=your_browser_client_id
fly secrets set TWITCH_CLIENT_VERSION=your_client_version

# 7. (Optional) Set auth token for headless login — skips the interactive device code flow (recommended)
fly secrets set TWITCH_AUTH_TOKEN_YOUR_USERNAME=your_oauth_token

# 8. (Optional) Set password for last-resort login — less reliable than auth token, may require 2FA
fly secrets set TWITCH_PASSWORD_YOUR_USERNAME=your_twitch_password

# 9. Set notification secrets (replace YOUR_USERNAME with your Twitch username in uppercase)
fly secrets set TELEGRAM_TOKEN_YOUR_USERNAME=your_bot_token
fly secrets set TELEGRAM_CHAT_ID_YOUR_USERNAME=your_chat_id

1.10.2. CI/CD Auto-Deploy

Pushes to main are automatically deployed via the CI workflow after build and version bump succeed. This requires a FLY_API_TOKEN GitHub secret:

# 1. Generate a deploy token scoped to your app
flyctl tokens create deploy -a twitch-miner-go

# 2. Set it as a GitHub repo secret
gh secret set FLY_API_TOKEN --repo <owner>/<repo>
# (paste the token when prompted)

If FLY_API_TOKEN is not set, the deploy step is skipped gracefully — build and version bump still run normally.

1.10.3. Manual Deploy

fly deploy

# View logs
fly logs

# Check health
curl https://your-app-name.fly.dev/health

1.10.4. Alternative Deployment

For self-hosted deployments, Docker Compose is also supported — see the Docker Compose section above and DEPLOYMENT.md for a comprehensive guide covering both Fly.io and Docker workflows.

1.11. Development

This project uses Conventional Commits and automated versioning. See CONTRIBUTING.md for the full commit convention, git hooks setup, and versioning workflow.

1.12. Auto-Update Checker

On startup, the miner automatically checks for new releases in the background via updater.CheckForUpdate(). If a newer version is available, a notification is printed to the terminal. This check is non-blocking and does not affect startup time.

1.13. License

This project is licensed under the GNU GPL v3.0 License. See the LICENSE file for details.