Giveaways

Giveaways module

Introduction

Giveaway module is a module which allows server managers to create and manage their giveaways.

Giveaway

Giveaway command allows server managers to create and manage giveaways.

A guide about running giveaways can be found here.

giveaway create

This command is used to create a new giveaway. The following parameters are required:

• channel: The channel in which you want to host the giveaway.

• time: For how long should the giveaway be hosted. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• winners: The number of winners there will be.

• price: The prize that will be given to the giveaway winner.

The following parameters are optional:

• required-role: The role(s) that users are required to have in order to participate in the giveaway. Please leave a space between role IDs.

• unbelievaboat-patch: This parameter is only applicable if the Unbelievaboat bot is installed on the server. It specifies how much of the currency managed by Unbelievaboat will be given to the giveaway winner.

• auto-ticket: Enable automatic creation of a ticket for the giveaway winner. By default, this option is disabled.

• message-count: The number of messages a user needs to send in order to join the giveaway. By default, this value is 0, meaning that any user can join the giveaway without sending any messages.

• message: Message which will be send bellow the giveaway.

• mention: A role which will be mentioned in the beginning of the giveaway.

• delay: How much time should pass before the giveaway is created. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• auto-reroll: The amount of time the winner of the giveaway has to claim their prize before the giveaway is considered forfeited and the prize is rerolled. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

Usage: /giveaway create <channel> <time> <winners> <price> [optional]

giveaway list

Lists every giveaway currently hosted. No parameters are required.

Usage: /giveaway list

giveaway reroll

Rerolls a winner of a specific giveaway. The following parameters are required:

• giveaway-id: The ID of the giveaway you want to reroll the winner for.

• winner-id: The ID of the winner you want to reroll.

Usage: /giveaway reroll <giveaway-id> <winner-id>

giveaway info

This command gives you all the information about a specific giveaway, such as the channel it's hosted in, the duration, the number of winners, etc. The following parameters are required:

• giveaway-id: The ID of the giveaway you want to get information about.

Usage: /giveaway info <giveaway-id>

giveaway end

This command allows you to end a giveaway, before it should. The following parameter is required:

• giveaway-id: The ID of the giveaway you want to end.

Usage: /giveaway end <giveaway-id>

giveaway cancel

This command allows you to cancela giveaway. The following parameter is required:

• giveaway-id: The ID of the giveaway you want to cancel.

Usage: /giveaway cancel <giveaway-id>

giveaway edit

This command is used to edit a active giveaway. The following parameter is required:

• giveaway-id: The ID of the giveaway you want to cancel.

The following parameters are optional:

• winners: The number of winners there will be.

• prize: The prize that will be given to the giveaway winner.

• message-count: The number of messages a user needs to send in order to join the giveaway. By default, this value is 0, meaning that any user can join the giveaway without sending any messages.

• auto-ticket: Enable automatic creation of a ticket for the giveaway winner. By default, this option is disabled.

• unbelievaboat-patch: This parameter is only applicable if the Unbelievaboat bot is installed on the server. It specifies how much of the currency managed by Unbelievaboat will be given to the giveaway winner.

Usage: /giveaway edit <giveaway-id> [optional]

Schedule

This command allows server managers to create, list, remove, and edit schedules for giveaways in their Discord server.

schedule create

Creates a new schedule for a giveaway. The following parameters are required:

• interval: The amount of time in seconds, minutes, hours, or days between each giveaway. Type 0 to disable repetition. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• start-in: The amount of time in seconds, minutes, hours, or days before the first giveaway is created. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• channel: The channel in which the giveaway will be hosted.

• time: The amount of time in seconds, minutes, hours, or days that the giveaway will last. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• winners: The number of winners that will be selected.

• prize: The prize that will be given to the winners.

The following parameters are optional:

• required-role: The role(s) that users are required to have in order to participate in the giveaway. Please leave a space between role IDs.

• unbelievaboat-patch: This parameter is only applicable if the Unbelievaboat bot is installed on the server. It specifies how much of the currency managed by Unbelievaboat will be given to the giveaway winner.

• auto-ticket: Enable automatic creation of a ticket for the giveaway winner. By default, this option is disabled.

• message-count: The number of messages a user needs to send in order to join the giveaway. By default, this value is 0, meaning that any user can join the giveaway without sending any messages.

• message: Message which will be send bellow the giveaway.

• mention: A role which will be mentioned in the beginning of the giveaway.

• auto-reroll: The amount of time the winner of the giveaway has to claim their prize before the giveaway is considered forfeited and the prize is rerolled. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

Usage: /schedule create <interval> <start-in> <channel> <time> <winners> <price> [optional]

schedule list

Lists all current giveaway schedules. No parameters are required.

Usage: /schedule list

schedule remove

Removes a giveaway schedule. The following parameter is required:

• schedule-id: The ID of the schedule to remove.

Usage: /schedule remove <schedule-id>

schedule info

Provides information about a giveaway schedule. The following parameter is required:

• schedule-id: The ID of the schedule to get information about.

Usage: /schedule info <schedule-id>

schedule edit

Edits an existing giveaway schedule. The following parameter is required:

• schedule-id: The ID of the schedule to edit.

The following parameters are optional:

• interval: The amount of time in seconds, minutes, hours, or days between each giveaway. Type 0 to disable repetition. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• channel: The channel in which the giveaway will be hosted.

• time: The amount of time in seconds, minutes, hours, or days that the giveaway will last. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• winners: The number of winners that will be selected.

• prize: The prize that will be given to the winners.

• required-role: The role(s) that users are required to have in order to participate in the giveaway. Please leave a space between role IDs.

• unbelievaboat-patch: This parameter is only applicable if the Unbelievaboat bot is installed on the server. It specifies how much of the currency managed by Unbelievaboat will be given to the giveaway winner.

• auto-ticket: Enable automatic creation of a ticket for the giveaway winner. By default, this option is disabled.

• message-count: The number of messages a user needs to send in order to join the giveaway. By default, this value is 0, meaning that any user can join the giveaway without sending any messages.

• message: Message which will be send bellow the giveaway.

• mention: A role which will be mentioned in the beginning of the giveaway.

• auto-reroll: The amount of time the winner of the giveaway has to claim their prize before the giveaway is considered forfeited and the prize is rerolled. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

Usage: /schedule edit <schedule-id> [optional]

Lottery

Lottery command is used to manage lotteries.

lottery create

This command is used to create a new lottery. The following parameters are required:

• channel: The channel in which the lottery will be hosted.

• time: The amount of time in seconds, minutes, hours, or days that the lottery will last. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• entry-fee: The amount of money, from the unbelievaboat, that will be taken from the user when joining the lottery and added to the prize pool.

The following parameters are optional:

• mention: A role which will be mentioned in the beginning of the lottery.

• delay: How much time should pass before the lottery is created. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

Usage: /lottery create <channel> <time> <entry-fee>

lottery list

This command is used to list all the lotteries currently hosted. No parameters are required.

Usage: /lottery list

lottery info

This command is used to get all the information about a specific lottery. The following parameter is required:

• lottery-id: The ID of the lottery you want to learn more about.

Usage: /lottery info <lottery-id>

lottery end

This sub-command is used to end a specific lottery. The following parameter is required:

• lottery-id: The ID of the lottery you want to end.

Usage: /lottery end <lottery-id>

Group-giveaways

Giveaway command allows hosts to create and manage group giveaways.

A guide about running group-giveaways can be found here.

In order to create a Group-Giveaway you have to create a guild group and set auto-ticket category.

group-giveaway create

This command is used to create a new group-giveaway. The following parameters are required:

• group-id: The ID of the group in which the giveaway will be hosted.

• time: For how long should the group-giveaway be hosted. The value should be a number followed by "s" for seconds, "m" for minutes, "h" for hours, or "d" for days.

• winners: The number of winners there will be.

• prize: The prize that will be given to the winner.

The following parameters are optional:

• cross-server-rules: Additional entry/bypass/blacklist roles between servers will be considered when joining a giveaway.

Usage: /group-giveaway create <group-id> <time> <winners> <prize> [cross-server-rules]

group-giveaway list

Lists every group-giveaway currently hosted. No parameters are required.

Usage: /group-giveaway list

giveaway reroll

Rerolls a winner of a specific group-giveaway. The following parameters are required:

• giveaway-id: The ID of the group-giveaway you want to reroll the winner for.

• winner-id: The ID of the winner you want to reroll.

Usage: /group-giveaway reroll <giveaway-id> <winner-id>

group-giveaway end

This command allows you to end a group-giveaway, before it should. The following parameter is required:

• giveaway-id: The ID of the group-giveaway you want to end.

Usage: /group-giveaway end <giveaway-id>

group-giveaway cancel

This command allows you to cancel a group-giveaway. The following parameter is required:

• giveaway-id: The ID of the giveaway you want to cancel.

Usage: /group-giveaway cancel <giveaway-id>