Configuration Reference

Configuration Reference

Detailed reference for giveaway_config.json settings.

GiveawayBotConfig

Setting	Type	Default	Description
Instructions	string[]	(Complex Object)	Example instructions displayed at the top of the JSON config file. These are for user guidance and are not used by the bot logic.
TriggerPrefixHelp	string[]	(Complex Object)	Help text for configuring triggers, displayed in the JSON file.
Profiles	GiveawayProfileConfig>	(Complex Object)	Dictionary of giveaway profiles. Key is the profile name (e.g., "Main").
Globals	GlobalSettings	(Complex Object)	Global settings applicable to all profiles.

GiveawayProfileConfig

Setting	Type	Default	Description
RequireFollower	bool	false	Require user to be a follower to enter.
RequireSubscriber	bool	false	Require user to be a subscriber to enter.
MaxEntriesPerMinute	int	45	Maximum entries accepted per minute across all users.
EnableWheel	bool	false	Enable Wheel of Names integration.
DiscordWebhookUrl	string	null	Optional: Discord Webhook URL for winner announcements.
DiscordChannelId	string	null	Optional: Streamer.bot Discord Channel ID for native announcements. Note: Requires the bot to be connected to Discord in Streamer.bot settings.
DiscordMessage	string	"Congratulations {winner}!"	Optional: Custom message for Discord announcements. Supports placeholders like {winner}.
EnableObs	bool	false	Enable OBS Browser Source control.
ObsScene	string	"Giveaway"	OBS Scene name for the wheel source.
ObsSource	string	"WheelSource"	OBS Browser Source name to update with wheel URL.
ExposeVariables	bool	false	Expose profile state to global variables.
DumpFormat	DumpFormat	DumpFormat.TXT	Format for entry and winner dump files.
WheelSettings	WheelConfig	(Complex Object)	Settings for the Wheel of Names display.
DumpEntriesOnEnd	bool	true	Dump all entries to a file when the giveaway ends.
DumpEntriesOnEntry	bool	false	Write entries to file in real-time (batched).
DumpEntriesOnEntryThrottleSeconds	int	10	Throttle interval for real-time entry dumps.
DumpWinnersOnDraw	bool	true	Dump winner details to file on draw.
DumpSeparateGameNames	bool	false	If true, generates a separate content-only file for winners/entries containing just the GameName (or UserName). Useful for copy-pasting into game clients.
SubLuckMultiplier	decimal	2.0m	Ticket multiplier for subscribers.
UsernameRegex	string	null	Regex pattern to validate usernames.
MinAccountAgeDays	int	180	Minimum account age in days to allow entry.
EnableEntropyCheck	bool	true	Enable username entropy check for spam detection.
GameFilter	string	null	Preset game filter (e.g., 'GW2') to apply specific validation rules.
RedemptionCooldownMinutes	int	0	Cooldown in minutes for user redemptions.
AllowedExternalBots	List<string>	(Complex Object)	List of external bot usernames allowed to trigger events.
ExternalListeners	List<BotListenerRule>	(Complex Object)	Rules for listening to external bot messages.
ToastNotifications	bool>	(Complex Object)	Toast notification settings per event type.
WinChance	double	1.0	Probability (0.0-1.0) that any entry is accepted.
Messages	string>	(Complex Object)	Custom message overrides.
TimerDuration	string	null	Duration string for auto-closing giveaways.