Skip to main content

Rewards

The Invite Rewards Bot allows you to set up rewards based on the number of invites a user has. This system encourages users to invite others to your server by providing them with special rewards once they reach specific invite milestones.

Managing Rewards​

Add a Reward​

To create a new reward for a specific invite threshold, use the following command:

/rewards add-reward [name:"reward-name"] [type:"reward-type"] [threshold:invite-threshold] [role:@role] [removable:true/false] [store:message-store-file]

Options:

  • name: The name of the reward.
  • type: The type of reward. You can choose from:
    • role: A role reward (assigns a role to users when they reach the threshold).
    • message: A message reward (sends a special message to users when they reach the threshold).
    • messageStore: A store of messages (assigns one of a set of messages when they reach the threshold).
  • threshold: The invite threshold at which the reward is given.
  • role (optional): The role to assign if the reward type is role.
  • removable (optional): Whether the role should be removed if the user falls below the invite threshold. This option is only relevant for role rewards.
  • store (optional): An attachment with a file containing a collection of messages to assign as rewards. This option is only relevant for messageStore rewards.

Example:

/rewards add-reward [name:"Invite Master"] [type:"role"] [threshold:10] [role:@VIP] [removable:true]

This command creates a new reward called "Invite Master" that grants the @VIP role to users once they reach 10 invites, and removes the role if the user falls below the invite threshold.

Remove a Reward​

To delete a reward from your server based on the invite threshold, use the following command:

/rewards remove-reward [name:"reward-name"]

Options:

  • name: The name of the reward to remove.

Example:

/rewards remove-reward [name:"Invite Master"]

This command will delete the reward named "Invite Master" from the server.

View All Rewards​

To view all the rewards set up for your server, use the following command:

/rewards view

This command will display a list of all rewards for your server, including their invite thresholds and types.

Reward Types​

There are three types of rewards that you can configure:

  1. Role Rewards: These rewards assign a specific role to users once they reach the specified invite threshold. The role can be removable or adjusted based on your settings.

  2. Message Rewards: When users reach the threshold, they will receive a special message sent to them in their DMs.

  3. Message Store Rewards: This reward type sends a unique message to each user who claims this reward. After a unique message has been sent to a user, it is deleted from the database, making this reward type depletable.

How Message Store Rewards Work​

  • Unique Messages: You upload a .txt file containing multiple messages, and each time a user reaches the invite threshold, one of these messages will be sent to them in a DM. Each message is sent only once, and after it is sent, it is deleted from the database.

  • Refilling the Message Store: Since the messages are depletable, it's important to refill the message store periodically.

  • Use Cases: Message Store Rewards are perfect for sending personalized or unique content to your members. For example, you can use it to send:

    • Event Invitations: Send special invites to exclusive events or promotions once users hit the invite target.
    • Milestone Recognition: Acknowledge and congratulate users with unique messages for their contributions.
    • Link-based Rewards: Send a unique discord nitro link (or any other unique link) to each user who is eligible for this reward.

File Structure​

  • The .txt file you upload should contain one message per line. Each message will be sent to a user upon claiming the reward.
  • You can use placeholders such as {server-name} and {threshold} to let the user know which server is the bot affiliated with or to let the user know how many invites they reached to get this reward.

Example .txt file structure (with Nitro links):

Congratulations!, you've earned a special Nitro link! Enjoy: https://discord.gift/ABC123XYZ  
Congratulations!, you've earned a special Nitro link! Enjoy: https://discord.gift/ABC234XYZ  
Congratulations!, you've earned a special Nitro link! Enjoy: https://discord.gift/ABC345XYZ  
Congratulations!, you've earned a special Nitro link! Enjoy: https://discord.gift/ABC456XYZ  
Congratulations!, you've earned a special Nitro link! Enjoy: https://discord.gift/ABC567XYZ

Uploading the File​

When creating the reward, use the following command to upload the .txt file:

/rewards add-reward [name:"Invite Bonus"] [type:"messageStore"] [threshold:50] [store:[file-input]]

Where [file-input] is your .txt file containing the messages.

Important Notes​

  • Message Uniqueness: Be sure to update the file with fresh, engaging messages to keep users excited about their rewards.
  • Personalization: Use placeholders like {server-name} and {threshold} to make the messages dynamic.
  • File Size: Ensure that the .txt file is not too large, as this may cause issues during uploading or reward assignment.

Conclusion​

Setting up rewards based on invites is a great way to incentivize users to invite others to your server. Whether you're assigning roles, sending messages, or offering unique rewards through the Message Store, you can easily tailor rewards to fit the needs of your community. The commands above allow you to manage rewards, track invites, and create dynamic systems that keep your server engaged and growing.