User Guide

User Guide

Comprehensive manual for operating the Giveaway Bot.

Note: For installation instructions, see the Deployment Guide.

---

🏁 The Giveaway Lifecycle

Every giveaway follows this simple 4-step cycle:

1. Open (!start / !giveaway start)

• What happens: The bot starts accepting entries.
• Notifications:
  • Live Chat: "🎉 Giveaway is now OPEN! Type !enter to join!"
  • Display: OBS Overlay appears (if configured).
  • Toast: Windows notification "Giveaway Started".
  • Discord: Announcement posted to configured channel/webhook.

2. Enter (!enter / !join)

• Users: Viewers type the command in chat.
  • Standard: !enter
  • With Game Choice: !enter <Game Name/Key> (if enabled)
• Validation:
  • Checks cooldowns (MaxEntriesPerMinute).
  • Validates user requirements (Subscriber, Account Age).
  • Checks for duplicate entries.
• Confirmation: Bot replies "✅ {User}, you're entered!" (optional).
  • If a Game Name was provided, the confirmation will include it (e.g., "Entered for: Elden Ring").

3. Draw (!draw / !giveaway draw)

• What happens: The bot picks a random winner from the pool.
• Process:
  • Wheel of Names: If enabled, the browser opens and spins the wheel.
  • Direct: If wheel is disabled, the winner is picked instantly.
• Announcement:
  • Live Chat: "🏆 WINNER is {User}!"
  • Toast: Windows notification "Winner Selected: {User}".
  • Discord: "🎉 Check out the winner!"
• Winner Tracking: Detailed winner info is logged to dumps/Winners.txt.

4. Close (!end / !giveaway end)

• What happens: Entries are locked. No new users can join.
• Cleanup: Entry list is cleared (unless persistent mode is on).
• Notifications:
  • Live Chat: "❌ Giveaway is CLOSED."

---

🔔 Toast Notifications

The bot sends Windows "Toast" notifications (pop-ups near the system tray) to keep you informed while you are gaming or streaming.

Enabled Events

By default, you get notified for:

• Giveaway Opened: Confirms the start command worked.
• Winner Selected: Shows the winner's name immediately.
• Giveaway Closed: Confirms the end command.
• Winner Selected: Shows the winner's name immediately.
• Giveaway Closed: Confirms the end command.
• Security Alerts: Warnings about potential bot attacks or errors.
• Updates: Alerts when a new version of the bot is available.

To disable these, see the Configuration Reference.

---

⚙️ Commands Overview

Full command list is available in the Commands Reference.

Command	Usage	Description
!enter	Public	Join the specific active giveaway.
!start	Mod	Opens the default "Main" profile.
!draw	Mod	Picks a winner for the active profile.
!end	Mod	Closes the giveaway.
!giveaway	Mod	Master command system (see below).

Master Command (!giveaway)

Use !giveaway help to see all options.

• !giveaway list: Show all winners this session.
• !giveaway config reload: Reloads giveaway_config.json without restarting bot.
• !giveaway update: Checks for and installs the latest version.
• !giveaway profile <name>: Switch active profile (e.g., !giveaway profile Weekly).

---

📂 Configuration & Advanced Features

🔄 Bidirectional Config Sync (Mirror Mode)

New in v1.5.11!

When RunMode is set to Mirror, you can now modify your profile configuration directly inside Streamer.bot using Global Variables. The bot will detect these changes in real-time and automatically save them back to your giveaway_config.json.

Syncable Settings:

• MaxEntriesPerMinute
• RequireSubscriber
• SubLuckMultiplier
• TimerDuration
• EnableWheel
• DiscordMessage
• ...and many more!

How it works:

1. Change a variable in Streamer.bot (e.g., set Giveaway Main Timer Duration to 5m).
2. The bot detects the change within 30 seconds (or on next interaction).
3. It updates the active configuration and saves it to disk.
4. It logs the change: [Mirror] Detected external change: TimerDuration -> 5m.

---

• Configuration Reference: Detailed JSON settings.
• Advanced Configuration: Tweaking performance and security.
• FAQ: Common issues and troubleshooting.

---

← Back to Home