Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

examples

README.md

Example Configurations

This directory contains pre-configured giveaway_config.json examples for various use cases.

How to Use

  1. Choose an example that fits your needs.
  2. Copy the content to .../Streamer.bot/data/Giveaway Bot/config/giveaway_config.json.
  3. Modify any specific values (like API keys, ObsScene names).
  4. Resave the file. The bot will automatically reload (if RunMode is not set to ReadOnlyVar).

Available Examples

01-minimal-starter.json

Start here if you're new! Contains just the "Main" profile with essential commands (!enter, !draw). Good for testing.

02-multi-profile-setup.json

A complete setup exhibiting the bot's power:

  • Main: Standard giveaway for everyone.
  • Weekly: A separate long-running giveaway.
  • SubOnly: Restricted to subscribers logic (via sub luck).

03-advanced-features.json

For power users who need strict control:

  • Bot Protection: Entropy check enabled.
  • Account Age: Minimum 30 days.
  • Username Pattern: Restricted alphameric names.
  • External Bots: Parsing entries from Nightbot.

04-wheel-of-names.json

Focuses on the visual experience:

  • Wheel Integrated: Automatically sends entries to Wheel of Names.
  • OBS Control: Switches scenes automatically.
  • Toast Notifications: Detailed desktop alerts.

05-timed-and-custom-messages.json

Advanced timed giveaway and messaging features:

  • Timed Giveaway: A "Flash Giveaway" profile that closes automatically after 5 minutes (TimerDuration).
  • Custom Messages: Customized "HYPE" messages using the Messages dictionary.
  • Toast Notifications: Enabled for high-priority events.

06-multi-platform-and-metrics.json

Demonstrates how to configure the bot for a multi-streaming setup:

  • Platforms: Enables Twitch, YouTube, and Kick support simultaneously.
  • Fallback: Sets a fallback platform for system messages if the bot is offline.
  • Metrics: Example of exposing internal stats to Streamer.bot global variables.

07-logging-persistence.json

For server-grade reliability and debugging:

  • Persistence: Configures StatePersistenceMode to "Both" (File + Variables).
  • Logging: detailed retention policies (30 days, 50MB cap) and rotation settings.
  • Dump Options: Configures automatic entry dumping to CSV format.

08-full-reference.json

DO NOT USE DIRECTLY. A comprehensive reference file containing every available configuration option with default values. Use this to look up specific settings or copy-paste snippets into your own config.