giveaways
Last updated
Last updated
[p] stands for your server's prefix
<> means the parameter is required, () means its optional
You do not have to type <> or (), they are simply parameters.
<time> is for how long you want the giveaway to last. For example, if you want the giveaway to last for 1 minute, enter 1m. Use the table below to figure out how to use different times.
Time | Usage |
---|---|
You can use multiple times together, for example, 1h30m.
<winners> is the amount of winners you want for your giveaway. If you want 1 winner, put 1, if you want 2 winners, put 2. Simple.
<prize> is the prize you want for the giveaway.
(tags) are the tags you can use to set extra requirements, bypass or extra entries for your giveaways. Refer to the following list for more information.
--req - set role requirements - --req <role1>;;(role2)
--multi - sets extra entries - --multi <role>:<amount of entries>
--bypass - allows specific roles to bypass requirements - --bypass <role1> (role2)
--messages - set a message requirement - --messages <amount>
--message-channel - set a channel that messages must be sent it - --message-channel <channel>
You can reply to the giveaway embed to end, reroll, cancel it without having to use a message ID.
The base command to configure the giveaways module is [p]gsettings
or [p]gset
for short.
These are roles that can use giveaway commmands. If there are no roles, it defaults to users with Manage Server permissions.
These are roles that are banned from entering giveaways. If a user tries entering one with a blacklisted role, the bot will remove their reaction.
If this setting is set to true, the bot will DM the host once their giveaway ends. It is set to false by default.
If this setting is set to true, the bot will DM the winner once they win a giveaway. It is set to false by default.
React the emoji you want to set as the custom giveaway emoji to the embed the bot sends after the command is ran. The emoji must be in a server that the bot is also in.
This is the embed the bot sends once a gstart command is ran. If you don't know how to create an embed, read getting started.
Use the following variables below and the variables in embed variables to help design your embed.
This is the embed that the bot edits once the giveaway is ended. The method is similiar to the start embed above.
This is the message the bot sends once a giveaway ends, announcing the winners. The variables are similiar to the start embed above.
Command | Explanation |
---|---|
Variable | Usage |
---|---|
second
s
minute
m
hour
h
day
d
[p]g start 1h 1w nitro
starts a simple giveaway for 1 hour, with 1 winner for nitro.
[p]g start 1h 1w nitro --req boosters
a giveaway similiar to the one above, but only users with the role boosters, are allowed to join
[p]g start 1h 1w nitro --bypass donators ---req boosters
a giveaway similiar to the one above, but users with the role donators can bypass the requirement
[p]g start 1h 1w nitro --messages 10
a giveaway where users are required to send 10 messages in the server to join
[p]g start 1h 1w nitro --messages 10 --message-channel #msg
a giveaway where users are required to send 10 messages only in #msg to join
[prize]
giveaway's prize
[time]
timestamp of when the giveaway ends
[host]
giveaway's host mention
[winners] (used in start embed)
number of winners in the giveaway
[winners] (used in end embed)
user mentions of all the giveaway winners