Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/resynceddesign/giveawaybot/llms.txt

Use this file to discover all available pages before exploring further.

GiveawayBot stores per-guild settings in SQLite so every server can have its own look and feel. Each time the bot joins a new server, a record is created automatically with sensible defaults — no manual setup required. Server admins can then use /gconfig to view or change any of the settings below.

​
Available settings

SettingOption nameDefaultDescription
Embed colorcolor#ff8e4dHex color applied to all giveaway embeds in the server
Entry emojiemoji🎊Shown on the entry button and the giveaway header message
@everyone pingeveryoneDisabledWhen enabled, giveaway posts include ||@everyone|| (spoiler-tagged)
These defaults come from the guilds table schema in guildManager.ts. They are applied the moment the bot joins a server via the guildCreate event — you never need to run /gconfig before creating your first giveaway.

​
Viewing the current config

Run /gconfig with no options to see the server’s current settings. The bot replies with a message showing all three values and an example embed rendered in the current color. 
/gconfig
The response looks like: 
Guild config:
Color: #ff8e4d
Emoji: 🎊
Ping Everyone: no
An example embed using the current color is shown alongside, so you can preview the result before making changes.

​
Updating settings

Pass one or more options to /gconfig to update them in a single command.

​
Set a custom embed color

The color option accepts a 6-digit hex code. The # prefix is required. 
/gconfig color:#5865f2
If the value is not a valid hex code, the bot replies with Invalid color code and makes no changes.

​
Set a custom entry emoji

The emoji option accepts any Unicode emoji or custom Discord emoji. 
/gconfig emoji:🎁

​
Enable or disable the @everyone ping

The everyone option is a boolean toggle. 
/gconfig everyone:true
/gconfig everyone:false

​
Updating multiple settings at once

All three options can be combined in a single invocation: 
/gconfig color:#e74c3c emoji:🎉 everyone:true

​
How settings affect giveaway appearance

When /gcreate runs, it reads the current guild settings from SQLite and applies them immediately:
  • Embed color — the EmbedBuilder calls .setColor() with the stored hex value, coloring the left border of every giveaway embed.
  • Entry emoji — appears in three places: the giveaway header message (🎊 **GIVEAWAY** 🎊), the embed description (React with 🎊 to enter), and the label on the entry button.
  • @everyone ping — when enabled, the giveaway post includes ||@everyone|| on its own line. The spoiler tags mean users must click to reveal the ping, softening the notification while still reaching the whole server.
Changes made with /gconfig take effect on the next giveaway created — existing giveaway messages are not retroactively updated.

Build docs developers (and LLMs) love

Get started for freeTalk to us