Giveaway Bot

Giveaway System for Streamer.bot

📖 READ THE WIKI DOCUMENTATION

Active Development! There may be breaking changes until things get ironed out a bit better

📖 Documentation

All documentation has moved to the GitHub Wiki.

• User Guide: Installation, commands, and configuration.
• Advanced Guide: Custom triggers, OBS integration, and power-user features.
• FAQ: Troubleshooting and common questions.
• Developer Guide: Architecture, contributing, and building.

✨ Key Features

• Multi-Profile Support: Run "Daily", "Weekly", and "Sub-Only" giveaways simultaneously.
• Remote Control & Automation: Control giveaways programmatically via Streamer.bot variables (Stream Deck ready).
• Timed Giveaways: Set a duration (e.g., "10m") and the bot automatically closes the giveaway.
• Configurable Messages: Customize every chat response to match your stream's personality.
• Enterprise Security: AES-256-CBC (DPAPI) Auto-Encryption for API Keys, GDPR Data Deletion, & anti-loop protection.
• Smart Validation: Blocks bots using entropy checks and account age verification.
• Rich Feedback: Windows Toast Notifications, Localization support, and highly visible chat alerts.
• Automated Config: Auto-Import global variables (API keys) from JSON on startup.
• Observability: Real-time OBS variables and automated wheel spins.
• Wheel of Names Integration: Seamlessly sync entries to the wheel and trigger spins.
• Discord Integration: Automatically announce winners to a Discord channel (Native or Webhook).
• Bidirectional Sync (Mirror Mode): Update config settings directly from Streamer.bot Global Variables.
• Separate Game Name Dumps: Export just the "Game Name" (e.g., Player.1234) for easy import into other tools.
• Auto-Update: Built-in command !giveaway update to check for and download the latest version.

🚀 Quick Start

1. Download the latest GiveawayBot.cs from Releases.
2. Import into Streamer.bot:
   • Create a new Action named "Giveaway Bot".
   • Add a "Code > Execute C# Code" sub-action.
   • Paste the contents of GiveawayBot.cs.
   • Click "Compile" (Ensure you have added the references first).
3. Configure:
   • The bot will generate a config file at .../Streamer.bot/data/Giveaway Bot/config/giveaway_config.json.
   • Edit this file or use the Example Configs.
4. Run:
   • Type !giveaway system test in chat to verify installation.
   • See the Deployment Guide for details.

⚙️ Compatibility

Runtime Environment: C# 7.3 / .NET Framework 4.8 (Streamer.bot's current runtime)

📦 Release Assets

Each GitHub release is expected to include these assets:

• GiveawayBot.cs
• CHANGELOG.md

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide and Code of Conduct.

🔒 Security

We take security seriously. See our Security Policy for details.

---

Maintained by Sythsaz

Website Homepage