# Booster Roles

Booster Roles are a way to give members a role in return for boosting your server.


> [!info]
> To ensure the bot functions correctly, it requires the following permissions:
> - `Manage Server`: To read the audit log and respond to relevant events.
> - `Manage Roles`: To assign roles to members and to create the booster role.

## Setup

### Using the Dashboard

To get started, visit the [dashboard](https://antidote.bot/dashboard), select your server, then navigate to **Modules** from the sidebar and then select the Booster Roles module.

### The configuration page

Set-up the booster role module how you want it, each option is super straight-forward.

After this, users can see information about the booster role in the server.

We recommend setting a pinned role, so that new booster roles will be pinned to the top of the server.

> [!warning] Note that new booster roles will clone the permissions of the pinned role.

![Booster Roles Configuration](https://i.gyazo.com/da6467db2730daac66dc4404ab9ea17f.png)

![Booster Roles Information](https://i.gyazo.com/5272bceec501b0c38689607aa0c2007b.png)

### Booster Roles - Configuring

Users can see information about the booster role in the server by typing `!br` in your server.

They will be able to create their own booster role using the `!br create` or `!br setup` command.

1. Configuring your booster role

![Configure booster role](https://i.gyazo.com/043704a8e44aef36d739ca96e6d6c2ce.png)

2. Updating a booster role

![Updating a booster role](https://i.gyazo.com/adedf0490314f23ef5a25d63ab8d54c8.png)

3. Setting an icon

![Setting an icon](https://i.gyazo.com/0de42edaab3afedc51f57f48719a8ab6.png)

4. Deleting a booster role

![Deleting](https://i.gyazo.com/23a0b12c2d3a6dbbafbf4e5825ddfb34.png)

### Booster Roles - Sharing

Users can share their booster role with others by using the `!br share` command.

![Share booster role](https://i.gyazo.com/3f4b9836881677d4315be594c8302e39.png)

Booster roles

# Introduction

Let's discover **Antidote in just a few minutes**.

## What is Antidote?

Antidote is a multi-purpose Discord bot, created to make setting up a server easier than ever. We offer a wide variety of features that can help you set up your server quickly and completely.

Antidote also comes with an RPG game system, which you can play with your friends. This game includes fighting monsters, PvP, leveling, a stable economy, player-owned casinos, and much more.

## Key Features

Antidote offers a simple setup process, which can be completed in a few minutes.

### RPG Game

Antidote comes with a fully functional RPG game system, which you can play with your friends. This game includes fighting monsters, PvP, leveling, a stable economy, player-owned casinos, leaderboards, and much, much more.

### Voice Control

Voice control allows you to permit users to create and manage their own voice channels. They can, for example, lock it, hide it, kick people, ban people, rename it, and manage a whitelist.

If you want to find out how to set it up, you can check out the [Voice Control](/docs/voice-control/setup) page.

### Antinuke

Antinuke allows you to set up a system that can detect malicious behavior and act accordingly. You can, for example, prevent your server from being grieved and instead kick the user, take their roles, or ban them. All Antinuke actions will also be logged, if you decide to enable logging.

### Auto Moderator

Auto moderator is a tool that can automatically moderate your server. You can, for example, automatically warn and punish users who misbehave. We even went as far as implementing an AI moderator for you!

### Welcomer / Leaver

Antidote can automatically welcome new users and send them a message. You can also set up a leaver message, which will be sent to users who leave your server.

We created a complete embed system that you can also choose to set up. This will send a pre-made embed to the user when they join your server.

![Welcome embed example](https://i.gyazo.com/7b434637c8dfdaedb4104ddf31445f7a.png)

### Fun Commands

Antidote comes with a ton of fun commands that you can use to entertain your friends. These commands include, for example, reactions such as kiss or hug, which will be counted.

There are also commands such as 8ball, quote, anime, urban dictionary, and much more. For a list of all fun commands, view our [commands](https://antidote.bot/commands) page.

### Role Menus + Auto Roles

Antidote comes with a role menu system that you can use to create a menu for your users to select roles from. This can be used to give users roles based on their activity, or to give them roles based on their interests.

We also offer an auto role system that you can use to automatically give users roles based on their activity.

### And Much More

Antidote's features go a lot farther than the ones listed on this page. We would like to invite you to take a look in our documentation to discover more that you might need.

Introduction

# Antinuke

Antinuke allows you to setup a system that protects your server from grieving.

> [!info] Permissions required
> The bot requires the following permissions to function properly:
> * `Manage Server`: To view the audit log which is what we use to trigger on  events such as:
>  * Deleting channels
>  * Deleting emojis/stickers
>  * Banning users
>  * ... etc
> * `Manage Channels`: To read channels
> * `Manage roles`: To take roles away from grievers
> * `Manage members`: To punish grievers

## Setup

### Using the Dashboard

To configure your Antinuke settings, visit your [dashboard](https://antidote.bot/dashboard). Navigate to your server and select "Antinuke" from the left-handed menu.

### Module Selection

Go to "Antinuke settings" and select the specific setting you want to manage. For example, choose "Ban guild member events":

![example](https://i.gyazo.com/c2d4ca9c84ee645108758ccf31212f9f.png)

### Setting Configuration

> [!warning] Warning:
Your settings will be applied immediately upon clicking the "Save" button.

The configuration process is straightforward. Define the "interval," which represents the number of events that trigger the Antinuke. Then, set the "time interval," specifying the timeframe within which these events must occur.

For example:
5 bans in 5 minutes is highly suspicious, while 2 bans in an hour is not.

![example](https://i.gyazo.com/86a23028f0c70aead006d2cd0226496a.png)

## Whitelist and Trigger Management

To prevent trusted individuals from being punished, use the whitelist.

The following command manages your whitelist:

~~~
!anw <show|add|remove> <user|role> <id|mention>

!anw show (This would show the status of the whitelist, which roles and/or users are in it)
!anw add user @Thrallix (This would add someone to the whitelist)
!anw remove role @owner (This would remove the owner role from the whitelist)
~~~

### Status Viewing

View a user's current trigger status with the `!an status` command. This displays an overview of events triggered by the user.

~~~bash
!an status <mention|id> (Shows the status of someone)
~~~

### Trigger Resetting

Reset a user's trigger status using the `!an clear` command. This is useful for staff members who perform bulk actions like deleting channels, but are not on the whitelist.

~~~
!an clear <mention|id> (Clears the trigger and time interval of a user)
~~~



Antinuke

# Autoresponder Configuration

Antidote's Autoresponder offers a streamlined method for automating server responses. Utilize it for welcome sequences, staff notifications, phrase-based reactions, and more. Tailor your responses with options for message removal, embedded content, and beyond.

> [!info] Free servers support up to 5 autoresponder rules.

## Autoresponder Access

To begin configuring your Autoresponder rules, follow these steps:

1.  Access your [dashboard](https://antidote.bot/dashboard).
2.  Select your server and navigate to "Autoresponder" from the left-side menu.
3.  Click "Create New Autoresponder."

## Autoresponder Naming

Assign a unique and descriptive name to your autoresponder. This ensures easy identification and prevents conflicts, as duplicate names are not permitted.

## General Settings

Fine-tune the behavior of your autoresponder with these options:

* **Delete Trigger:** Enable this to automatically remove the initiating message, keeping your channels tidy.
* **Reply Instead of Send:** Configure the response to appear as a reply, maintaining context within the conversation.
* **Timed Deletion:** Set the autoresponse to automatically delete after a specified duration, preventing clutter.

## Triggering Conditions

Define the circumstances under which your autoresponder will activate:

**Trigger Type:**

* **Message or Reaction:** Choose between triggering based on message content or reactions.
  * **Message:** Activate the autoresponder when a specific phrase is detected. Use "Trigger on specific phrase..." to define your trigger.
  * **Reaction:** Activate the autoresponder when a designated emoji reaction is added. Use "Trigger on specific reaction..." to define your trigger.

**Trigger Location:**

* Specify the portion of the message that should activate the autoresponder. You can choose from:
  * Beginning of the message.
  * End of the message.
  * Entire message content.

## Response Options

Customize the format of your autoresponder's reply:

**Response Format:**

* **Send Embedded Message:** Deliver an aesthetically pleasing and informative embedded message as the autoresponse.
* **Send Plain Text:** Deliver a standard, straightforward text message as the autoresponse.
* **Add Reaction:** React to the triggering message with a chosen emoji, adding a quick and simple response.

Autoresponder

# Role Menus

Role menus allow your server members to assign themselves roles by interacting with a menu.

> [!info] To ensure the bot functions correctly, it requires the following permissions:
> - `Manage Server`: To read the audit log and respond to relevant events.
> - `Manage Roles`: To assign roles to members.
> - `Send Messages` and `Embed Links`: To send the role menus in your channels.

## Setup

### Using the Dashboard

To get started, visit the [dashboard](https://antidote.bot/dashboard), select your server, then navigate to **Role Menus** from the sidebar.

### Creating a Role Menu

Click the **Create Role Menu** button.

![Create Role Menu](https://i.gyazo.com/8149ef817b82735f53783ec1ff5e417b.png)

---

### Menu Configuration

1. **Menu Name**
Give your role menu a descriptive name.

2. **Persistent Role**
Decide whether users must always have one role from this menu, even if they try to unselect all.

3. **Replace Previous Role**
Choose whether selecting a new role should remove the previously selected role.

![Menu Settings](https://i.gyazo.com/27cfcb06535460dfec24ea238ef4d703.png)

---

### Role Behavior Configuration

> [!warning] Changes will apply immediately after clicking save.

You can configure how roles interact with the menu:

- **Ignored Roles**: Roles that the menu will not affect.
- **Required Roles**: Users must have one of these roles for the menu to respond.

![Role Settings](https://i.gyazo.com/eb4d4efce0a8f77b60a8db35473fb32c.png)

---

### Adding Roles to the Menu

Click **Add Role** to start configuring your menu options.

For each option:
- Choose an emoji (custom or default, e.g. `:exclamation:`).
- Assign the role to be given when a user selects that option.

---

### Deploying the Menu

Once your menu is configured, you can post it in your server using one of two methods:

---

## Method 1: Using Text

1. Go to the **Edit Menu** page.
2. Copy the generated command.
3. Paste and send the command in any text channel where the bot has permissions.

![Copy Command](https://i.gyazo.com/b13cf80fa1ff763256138a47e15ee90b.png)

![Text Menu Example](https://i.gyazo.com/c407972fb7b50aeee767172bb2ad9372.png)

![Text Menu Output](https://i.gyazo.com/c563e4586c9bd4ff9a7fa34be8f544fd.png)

---

## Method 2: Using Embeds

You can also attach role menus to custom embeds:

1. Open your **Embed Manager** and create or edit an embed.
2. Use the `!embed preview <embed_id>` command to post the embed.

![Preview Embed](https://i.gyazo.com/1b485a92cff767028bc08a46d3415e8d.png)

3. Reply to that embed with your role menu command.

![Attach Role Menu](https://i.gyazo.com/990dc29262890c6874ee50163bc37b77.png)

![Resulting Menu](https://i.gyazo.com/a9373ad59d58e8bddf8a1eb93f9c0748.png)


Role menus

# Items

Items exist in Antidote and can be used for multiple purposes.\
Equipment will increase your stats in battles, giving you a higher chance to win.\
Some items will boost your skills, while others boost your rob/crime chance.

Some items are also used for skilling, these items would include wood types, ores, leather and other resources.

## Inventory

You can view your inventory by using the `!inventory` command.\
This will show you all the items you have in your inventory.

## Shop

You can buy items from the store by using the `!shop` command.\
This will show you all the items you can buy from the store.

> [!info] Items 
> Each item has their own stats, trading price, the ability to buy, sell or 
> trade and more.
> Some items can not be sold or traded and can only be fought by [battling monsters](/docs/rpg/battle) or by [skilling](/docs/rpg/skilling).

![example item](https://i.gyazo.com/e08400c6865ff50febade260111137db.png)

## Equipping items

Some items such as weapons and armour can be equipped by using the `!equip` command.\
This will equip the item to your character.

You can view your equipped items and stats by using the `!equipment` command.

RPG - Items 

# Pets

Pets will spawn randomly at a rate of **1 in 2500** messages sent in the server.\
You can claim a pet by pressing the adopt button until you claimed it.\
The odds of claiming a pet is 40% chance per attempt.

As of june, they can now also be found while training the hunter skill.

![example](https://i.gyazo.com/f59eae89677df085db61a6fb584eb8f6.png)

Pets have a certain rarity, which will affect their base skills.\
You can view your pet by using the `!pet` command.

## Base skills and stats + Training

### Base skills and stats

Pets will have a base set of skills, for example one pet could start with 10 attack and 5 health...\
While the other could be 7 attack and 3 health.\
You can train your pet until level 30, which will increase the stats of your pet.

![example pet](https://i.gyazo.com/a838c46d4a6a37c47f09a6b63b540f2f.png)

### Training your pet

You can train your pet by using the `!battle` command and fighting monsters.\
Your pet will also help you in battles by fighting your opponent.

In Player-Versus-Player battles, your pet will be the one fighting your opponents pet first, and then continue to fight the opponent.

![training](https://i.gyazo.com/f3165c809c17ae02d139147d14488b81.png)

## Renaming a pet

You can rename your pet by using the `!pet rename` command.\
This is currently free, but might cost in-game money later on.

![renaming](https://i.gyazo.com/51c05aed670d2c28228eead4bdf20126.png)

## Discarding a pet

If you no longer want your pet, or you would like to be able to claim a different pet, or a more rare one...\
You can discard your pet by using the `!pet discard` command.

![heartbreak](https://i.gyazo.com/52bc07c0f0480313f3e6c6fe2d3699c5.png)

RPG - Pets

# Skilling

Antidote comes with trainable skills that can give you more benefits in the game.\
You can use the `!skills` command to view your skills and their stats.

> [!info] **Did you know?**
> Skill levels are calculated by using a similar formula to OldSchool RuneScape.

![skills example](https://i.gyazo.com/a2c284f1936d0997391fb793f5c7e7e0.png)

## How to train your skills

Each skill requires a corresponding tool to train.\
These tools can usually be bought using the `!shop` command.
Tools can be equipped in your tool slot, and you can view your equipped tools by using the `!equipment` command.

**Skill and tool requirements:**
- Woodcutting: Any axe
- Mining: Any pickaxe
- Fishing: Fishing net
- Hunting: Any dagger

### Hunting

Hunting is the process of killing animals for their meat and other resources.\
You can hunt by using the `!hunt` command.

You can view all animal species by using the `!animalinfo` command.

You can get started by using `!buy bronze dagger` to buy a hunting knife.

![hunting](https://i.gyazo.com/19a0c9e58412b2ef6be3b538334a3026.png)

### Cooking

You can use the following command to cook raw food (fish):\
`!cook <raw_food_name>`

This food can then be used in battles to heal.


### Fishing

Fishing is the process of catching fish from rivers, lakes, and oceans.\
You can fish by using the `!fish` command.

You can view all fish species by using the `!fishinfo` command.

You can get started by using `!buy fishing net` to buy a fishing net.

![fishing](https://i.gyazo.com/1d116557e51f999cdf65cffb35849ffa.png)

### Mining

Mining is the process of extracting valuable materials from the earth.\
You can mine ores by using the `!mine` command.

You can view all ore species by using the `!rockinfo` command.

You can get started by using `!buy bronze pickaxe` to buy a pickaxe.

![mining](https://i.gyazo.com/46ccefc26fcb7369a36a631b116522d4.png)

### Woodcutting

Woodcutting is the process of cutting down trees to obtain wood.\
You can cut down trees by using the `!chop` command.

You can view all tree species by using the `!trees` command.

You can get started by using `!buy bronze axe` to buy an axe.

![woodcutting](https://i.gyazo.com/9188cd7642a33fdc7f2c0a264f04913a.png)

### Crafting

Crafting is the process of combining resources to create new items.\
You can craft items by using the `!craft` command.

You can view crafting recipes by using the `!recipes` command.

Crafting does not require any tools, but you will need the resources to craft the item.

![selection](https://i.gyazo.com/d18e12fdaf4eb1916b18b9c37369aee2.png) \
![result](https://i.gyazo.com/81c6bdb5fb969c9e2c8bc57f6f12fb56.png)

### Salvaging
Similar to crafting, you can use salvaging to break down existing items that you have gathered or crafted for resources.

This will give you half of the resources that the item consists of, along with experience.

You can use `!salvageinfo` to see recipes.

RPG - Skilling

# Battling

In Antidote, you can battle other players or monsters.\
This will increase your profile experience and give you rewards.

![battle](https://i.gyazo.com/f3165c809c17ae02d139147d14488b81.png)

## Battling monsters

You can battle monsters by using the `!battle` command.
Monsters will have a certain level, which will affect their stats.\
They will also have the ability to drop items, which include resources and equipment.

Resources can be used to craft items, while equipment can be equipped to increase your stats.

## Battling players

You can battle players by using the `!battle <player_name> [stake]` command.\
Staking is optional, and is used to bet money on the battle.\
If you win the battle, you will receive the stake, and if you lose, you will lose the stake.

## Pet assistance

Your pet will assist you in battles, and will fight your opponent's pet first.\
If your pet defeats the opponent's pet, it will continue to fight the opponent.

As monsters can not own a pet, your pet will always fight monsters after your turn.

## Dungeon

> [!warning] This feature is currently in development.
> The dungeon can give you many great rewards, but it is also very dangerous.
> You could lose the entry fee of 500.000 and not make anything in return.

You can also battle monsters in the dungeon by using the `!dungeon` command.\
This will take you to a dungeon, where you can battle monsters and collect rewards.

RPG - Battle

# Cars

In Antidote, you can steal cars, race other players, repair them or sell them.\
Durability will play a part in your car's performance and price.

## Stealing cars

You can steal cars by using the `!steal` command.\
This can be done **once every hour**.

The stolen car will have a random durability.\
Price is calculated based on durability, rarity and type of car.

## Selling cars

You can sell your car by using the `!car sell <car_id>` command.

## Racing

You can race other players by using the `!race` command.\
You can also race for money, this can be done by using `!race <user> <amount>`.\
The other user will have to accept the race.

You can then both select the car you want to use.

## Repairing cars

Repairing cars is also randomized.\
Running the repair command will cost you money based on how damaged the car is.\
The repair percentage is randomized, meaning sometimes you will get lucky with a 100% repair, or unlucky with a 2% repair.

The end result will affect the speed and price of your car.

RPG - Cars

# RPG Game

Antidote comes with a fun and interactive RPG game that allows you to level up skills, make money, trade and fight other players and monsters, and much more.

## Getting started

In order to start playing, you have to create a profile by using the `!start` command.\
This will create a player account for you that you can level up, you can view this by using `!profile`.\
This profile will also be linked to the economy system, so you can use the `!balance` command to see how much money you have.

## Making money

There are several ways that you can use to start making money.
You can for example trade players, you can gamble in the player owned casinos (`!casinos`), and much more.

These commands include:
- !steal` (Steal a car)
- `!work`
- `!crime` (This could also result in a loss, but earns more than working)
- `!daily`
- `!weekly`
- `!monthly`
   - Only available to premium users
- `!battle` (Fight monsters, this could also result in a loss)

## Items

Some items can be bought and sold in the shop, while others can only be traded.\
You can gain items by fighting monsters, playing the `!dungeon` minigame, or by crafting them using `!craft`.

You can also equip weapons and armour by using `!use`.\
You can view your equipped items by using `!equipment`.\
The items you equip will affect your stats, such as your attack and defence.

![Item example](https://i.gyazo.com/e08400c6865ff50febade260111137db.png)

## Pets

Pets will spawn randomly at a rate of **1 in 2500** messages sent in the server.\
You can claim a pet by pressing the adopt button until you claimed it.\
The odds of claiming a pet is 40% chance per attempt.

![example](https://i.gyazo.com/f59eae89677df085db61a6fb584eb8f6.png)

## Leveling up

Leveling up can be done by sending a message in a server, or by joining a voice channel.

> [!info]
> Profile experience is not the same as skill experience.
> You can view profile experience by using `!profile` and skill experience by using <mark class="warning">!skills</mark>.

> [!warning]
> There is no point in spamming messages, as you will only receive experience once per minute.
> You must be unmuted in the voice channel in order to receive experience, also per minute.

RPG Game

# Server Events

Antidote enhances server engagement through a variety of automated events. These events are designed to boost activity and provide interactive experiences for your community.

## Money Drops

By default, Antidote will trigger a money drop once every 250 messages sent within your server. This encourages active participation and rewards users for their contributions.

You can customize this feature through the economy module in your dashboard:

![server drops](https://i.gyazo.com/dc463f4f332618e90f11d07a790707ce.png)

Within the economy settings, you have the option to disable money drops entirely or restrict them to a specific channel. While disabling is possible, we recommend keeping money drops active, as they consistently generate engagement each time a user claims the reward.

## Pet Spawns

Pet spawns occur less frequently, triggering once every 2500 messages. When a spawn occurs, a random pet is selected, with the selection weighted to reflect pet rarity. Users can claim these pets, adding a fun, collectible aspect to your server and driving user interaction.

Similar to money drops, pet spawns can be configured to only occur in a designated channel or be disabled altogether:

![pet settings](https://i.gyazo.com/8d00daebc1dfeea973d7f3fc9f28b9ce.png)

## Events

Similar to pet spawns, event can also be disabled in the fun module.
It can also be limited to a single channel, to prevent spam.

Documentation

Booster roles

Booster Roles

Setup

Using the Dashboard

The configuration page

Booster Roles - Configuring

Contents