# 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

# 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 (server protection)

Antinuke is Antidote’s **automated raid / griefing guard**. You set **how many** sensitive actions someone may perform in a **rolling time window**; if they exceed it, the bot applies the **punishment** you chose (for example jail, strip dangerous roles, kick, or ban).

> [!info] [!outlined] How it decides “who did it”
> When Discord fires an event (for example a ban or a channel delete), Antidote reads the **server audit log**, finds the **executor** for that action, and counts that action **against that user** for the matching protection module. The bot must have **View Audit Log** or it cannot attribute actions reliably.

![Dashboard Antinuke overview](https://i.gyazo.com/f8641fe26f1f1d2bf2aead09d7dffd5f.png)

## What you should configure first

1. Turn **Antinuke** on in the [dashboard](/dashboard) (or complete the in-Discord setup flow).
2. Confirm Antidote’s role is **high enough** in the role list to **manage roles** and **apply your jail role** (if you use jail).
3. Set **jail channel** and **jail role** under **Moderation** if you want the **Jail** punishment to work; otherwise the bot may fall back to **strip roles** when jail is not configured.

> [!warning] Audit log and timing
> Detection is driven by **audit log entries** Discord exposes to the bot. Very recent actions can occasionally be missing or delayed; keep thresholds sensible for your server size.

## Where to open settings

- Run your server prefix then **`setup`** (aliases: **`setups`**, **`install`**) and choose **Antinuke**, or  
- Run **`antinuke config`** / **`antinuke setup`** (aliases include **`an`**), or  
- Use the **[dashboard](/dashboard)** Antinuke section for the full editor.

![Discord Antinuke config](https://i.gyazo.com/2890e24065f55954da21d513d660c357.png)

## Protection modules

Each row is a **separate counter** per staff member (executor from the audit log), with its own **threshold**, **punishment**, and optional **Cmd detection** toggle.

| Module | What it tracks (summary) |
| ------ | ------------------------ |
| **Vanity protection** | Changes to the server **vanity invite URL**. |
| **Deny bot joins** | **Bots** being added to the server. |
| **Ban protection** | **Member bans**. |
| **Kick protection** | **Member kicks** (audit-driven). |
| **Role deletion** | **Roles** being **deleted**. |
| **Channel creation / deletion** | **Channels** being **created or deleted** (Antinuke uses the shared channel protection bucket for this). |
| **Emoji deletion** | **Custom emojis** removed. |
| **Webhook creation** | **Webhooks** being **created**. |
| **Sticker deletion** | **Stickers** removed. |

## Threshold presets (rolling window)

Presets are expressed as **N actions** inside a **single rolling window** (not “per calendar hour”). Pick stricter values for public servers and looser ones for small staff teams.

| Preset (dashboard) | Meaning |
| ------------------ | ------- |
| **Instant (first action)** | The **first** qualifying action in the window can trigger the consequence (use with care). |
| **3 actions / 5m** | Up to **3** actions within **5 minutes**. |
| **5 actions / 10m** | Up to **5** actions within **10 minutes** (common default). |
| **7 actions / 30m** | Up to **7** actions within **30 minutes**. |
| **10 actions / 60m** | Up to **10** actions within **60 minutes**. |
| **15 actions / 60m** | Up to **15** actions within **60 minutes**. |
| **20 actions / 60m** | Up to **20** actions within **60 minutes**. |

> [!tip] Separate counters
> Hitting the limit on **one** module does **not** reset counts on other modules; each module has its own rolling list of recent actions.

## Punishments

| Punishment | What the bot does |
| ---------- | ----------------- |
| **Jail + strip** | Removes **high-risk permissions** (see below), saves a **role buffer** where configured, then applies your **jail role** and moves the member toward your **jail channel** setup. If jail is not configured, stripping may still run. |
| **Strip roles** | Strips roles that grant **dangerous permissions** (Administrator, Ban Members, Kick Members, Manage Server, Manage Channels, Manage Roles, Manage Webhooks, Manage Expressions, Manage Messages, View Audit Log, and similar). |
| **Ban** | **Bans** the executor from the server. |
| **Kick** | **Kicks** the executor from the server. |

> [!error] [!outlined] Scope of “strip”
> Jail / strip logic is aimed at **removing moderation and structure-breaking powers** quickly. It is not the same as manually auditing every role on the server.

## Cmd detection (“Cmd detection” switch)

Per module, **Cmd detection** controls whether actions that the backend classifies as **command-sourced** (for example some **slash / app-command** moderation flows) are **included** in the same counters as normal audit-driven events.

- **On** — command-classified paths **count** toward thresholds (when the bot labels them that way).  
- **Off** — those command-classified paths are **ignored** for Antinuke counting for that module.

> [!info] Practical note
> All protections ultimately depend on **Discord audit log** data the bot can read. If an action cannot be tied to an executor, Antinuke may not see it.

## Whitelists and trusted staff

- **Super admins** — Discord user IDs stored in Antinuke settings who can **manage Antinuke** and are treated as **trusted** for enforcement logic.  
- **Member whitelist** — users who should **not** be punished by Antinuke.  
- **Role whitelist** — optional; members with a whitelisted role can be skipped depending on configuration.

Use whitelists for **known-good bots** (logging bots, ticket bots) and **owner-approved staff** who routinely perform bulk actions.

![Whitelist / super admins](https://i.gyazo.com/d324f710f638550c74519b01c372b3de.png)

## Bot permissions (checklist)

Antinuke and jail workflows expect Antidote to have (at minimum) the permissions used in the setup validator, including:

- **View Audit Log** — attribute bans, kicks, deletes, and similar.  
- **Ban Members** / **Kick Members** — apply those punishments.  
- **Manage Roles** — strip dangerous roles and assign **jail**.  
- **Manage Channels** — support channel-related protections and jail routing where applicable.  
- **Manage Webhooks** — webhook protection.  
- **Manage Guild Expressions** — emoji and sticker protections.  
- **Manage Server** — some guild-level updates used in protections.

If Antidote is **missing** permissions, consequences may **fail silently** or log errors while the server remains exposed.

## Clearing counters and inspecting status

- **`antinuke clear @user`** (and related helpers) clear **cached** Antinuke action timestamps for a member so they can “cool down” without changing settings.  
- **`antinuke view @user`** shows how full the rolling counters are **right now** (based on live cache).

Counters are **in-memory on the bot shard** with a bounded lifetime; treat **view/clear** as operational tools, not a permanent audit trail.

## Related

- **[Dashboard](/dashboard)** — full Antinuke editor, thresholds, punishments, whitelists.  
- **Moderation module** — jail channel / role and role-buffer behaviour used by jail.  
- **Server logging** — pair Antinuke with log channels so staff see **who** did **what** when a limit trips.


Antinuke

# Autoresponder

Autoresponders let Antidote **watch messages or reactions** in your server and **automatically respond** with plain text, a **saved embed**, and/or a **reaction** on the trigger message. You create and edit them in the **dashboard**; the bot loads rules from the API and runs them on every matching event.

> [!info] [!outlined] Where to configure
> Open **[Dashboard](/dashboard)** → Your server → **Auto responders**. There is no separate prefix command flow for building responders in Discord.

![Autoresponder list in dashboard](https://i.gyazo.com/f2666d7034116c3f4b8291c5775f2c27.png)

## Limits

Your plan caps how many autoresponders a server may have. Typical defaults in the API are **2** on free tiers and **50** on premium (exact numbers follow your live **Server limits** / billing configuration).

> [!warning] At least one response
> Saving a rule requires **at least one** of: **send message**, **send embed**, or **send reaction** to be enabled, with the matching content or IDs filled in.

## How the bot runs them

1. On **each guild message**, the bot loads your server’s autoresponder list and runs handlers whose **trigger method** is **message**.
2. On **reaction add** (and optionally **remove**), it runs handlers whose **trigger method** is **reaction**.
3. Rules are cached **per server** for about **10 minutes**. After you edit responders in the dashboard, allow a short delay or use your normal **cache clear** tooling if changes do not appear immediately.

> [!tip] Order and scope
> Message autoresponders are evaluated **before** prefix commands are parsed in the message pipeline. They apply to normal channel messages the bot can see (subject to channel permissions and intents).

## Trigger: Message

| Field | Purpose |
| ----- | ------- |
| **Match type** | How the trigger text is compared to the message **content** (case-insensitive). |
| **Trigger text** | The string users must match (required for message triggers). |

| Match type (value) | Behavior in the bot |
| ------------------ | -------------------- |
| **0** — “Check entire message…” | The message must **contain** the trigger as a substring (`includes`). |
| **1** — “Check start…” | The message must **start with** the trigger text. |
| **2** — “Check end…” | The message must **end with** the trigger text. |

> [!info] Naming vs behavior
> The dashboard label for type **0** suggests “entire message”, but the implementation is a **substring** match anywhere in the message. Use **starts with** or **ends with** when you need stricter boundaries.

## Trigger: Reaction

| Field | Purpose |
| ----- | ------- |
| **Reaction to monitor** | A **server custom emoji** to watch for (required). Unicode-only reactions are not selectable here. |
| **Reaction filter type** | **Any message** vs **only messages whose full text matches** a target string. |
| **Message content to match** | When filter type is **message**, the reacted message’s content must match **exactly** (after lowercasing), character-for-character aside from case. |
| **Also check remove reaction events** | When enabled, **removing** that emoji can fire the same responses as adding it (if other checks pass). |

**Bot reactions are ignored** — reactions from Discord bots do not run reaction autoresponders.

![Reaction trigger settings](https://i.gyazo.com/1cbbb27a3552c66cc710671b6068d5ca.png)

## Basic options (message and reaction)

| Option | Effect |
| ------ | ------ |
| **Delete trigger message** | After a match, the **trigger message** is deleted after **self destruct time** seconds (same delay field as self-destruct; set to **0** for immediate delete when that path runs). |
| **Use reply rather than send to channel** | Plain **send message** responses become a **reply** to the trigger message instead of a standalone channel message. |
| **Self destruct** | After the configured delay (**0–60** seconds), the **trigger message** is deleted (message triggers and reaction triggers both target the reacted message for reactions). |

## Responses (can combine)

| Response | Notes |
| -------- | ----- |
| **Send a message** | Free text (large limit in storage). Honors **use reply** when enabled. |
| **Send an embed** | Uses a **saved server embed** from the embed library. The bot currently sends this as a **normal channel message** (not a reply), even if “use reply” is on for text. |
| **Send a reaction** | Antidote reacts on the **trigger message** with a **server emoji** you pick; the emoji must be visible to the bot in cache (custom emojis defined on the server). |

## Validation (API)

The server rejects saves when, for example:

- **Message** trigger is chosen but **trigger text** is empty.
- **Reaction** trigger is chosen but **monitor emoji** is missing.
- **Reaction filter type** is **message** but **message content to match** is empty.
- **Send embed** is on but the embed ID is not a valid embed for that server.
- **Send reaction** is on but no reaction is chosen.
- **Self destruct** is on but **time** is outside **0–60** seconds.

## Ideas for safe use

- Prefer **starts with** or a very specific substring to avoid accidental fires in busy channels.
- Test in a **private channel** first; multiple enabled responders can all evaluate the same message.
- Keep **self destruct** and **delete trigger** in mind for moderation and audit trails.

## Related

- **[Dashboard — autoresponder list](/dashboard)** — create, search, edit, delete (per-server URL).
- **Custom embeds** — build embeds used by **Send an embed**.
- **`thrallix/clearcaches`** (bot operator) — can clear **`autoresponderServerCache`** if you need configs to reload immediately after changes.


Autoresponder

# 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

# Role templates

A **role template** stores a **package** of data: one or more **embed definitions** (titles, colors, bodies, optional images, fields, and similar) and matching **reaction-role rows** (role **name**, **colour**, **reaction icon** per role). Templates are edited in the dashboard, then **executed** so Antidote can create **Discord roles**, register **embeds** on your server, and attach **role menus** to messages.

> [!info] Dashboard areas
> **My templates** — server-owned copies you can edit, execute, or delete. **Templates library** — read-only catalog from the API (`role-template-get-all`); which rows appear depends on what is stored for that Antidote installation. **Execute template** — wizard: pick **channel**, optional **anchor role** for sort order, then run execution.

![My templates and library](https://i.gyazo.com/caad27e8c61e53681eeb7f068e4fa474.png)

## Library → server copy

1. Open **Templates library** and inspect a row (**view**).  
2. **Copy to server** creates a **server-specific** row under **My templates** (same name/description payload as returned by the copy API).  
3. The new row can be **edited**, **executed**, or **deleted** independently of the library entry.

Deleting a **server** template removes only the **saved configuration** in Antidote; it does **not** remove Discord roles or channel messages already created by an earlier run.

## Editing a server template (`role-templates/edit`)

The editor rebuilds **one card per embed** with:

- **Embed name** — Label for that block.  
- **Colour**, **title**, **description** — Standard embed presentation.  
- **Author / footer / images / thumbnail / timestamp / fields** — Optional layout pieces (same shape as the server embed editor).  
- **Roles under that embed** — Each role: **display name**, **hex colour**, **icon** (emoji used later on the reaction menu).

**Validation enforced in the UI before save:**

- Every role row must have an **icon** (reaction emoji).  
- Within each embed, **two roles cannot share the same icon** (duplicate reaction detection).

## Executing a template (`role-templates/execute`)

- **Select channel** — Required. Embeds and role-menu messages are created **there**.  
- **Anchor role** — Optional. New Discord roles are positioned **relative** to this role in the list.  
- **Execute** — Calls the execute API; on success the UI summarizes **created roles**, **saved embeds**, and **menus** (exact labels depend on API response).

Execution may create many roles and posts in one go. If a **role name already exists**, Antidote **reuses or adjusts** that role so the template can still apply (see the on-screen warning before confirming).

The account running the flow needs dashboard access to the server; the bot needs **Manage roles** and a role **above** the roles it creates.

## Optional: Discord `template` command

For administrators working **in a channel**, the bot exposes **`template <template_id>`** (see your server’s prefix and help). It loads the same server template payload, creates missing roles, posts embeds, and registers collectors. The **numeric `template_id`** is the identifier shown for the **server** template in the dashboard.

Use **Execute template** when you want explicit **channel** and **anchor role** choices without typing IDs by hand.

## Related

- **Role menus** — behavior of standalone menus, groups, DMs, and `rolemenu create` / `rolemenu clear`.


Role templates

# Role menus

Role menus are **reaction-based role pickers**: you map each **Discord role** to an **emoji** (Unicode or a **custom emoji from your server**), save the configuration in the Antidote dashboard, then run a short **Discord command** on the **target message** so Antidote attaches reactions and listens for clicks.

> [!info] Where this lives in the dashboard
> **Server dashboard** → sidebar **Role menus** (expand) → **Role menus** for the list and create/edit. **Role menu groups** opens the group editor. **My templates** and **Templates library** are separate; see the **Role templates** doc.

![Role menu editor](https://i.gyazo.com/2ccf41b94c642990e446fb6a4ddb9f6c.png)

## Limits (plan defaults in code)

- **Role menus** — typical caps **10** (free) / **250** (premium).  
- **Role menu groups** — typical caps **2** / **25**.

Exact numbers follow your **server’s plan** in the dashboard.

## Per-menu options (reaction menu editor)

These fields apply when the menu is **not** assigned to a group (see **Grouped menus** below).

- **Reaction menu name** — Internal label in the dashboard list.  
- **Role menu group (optional)** — Attach this menu to a **group**. When set, several per-menu controls move to the **group** (see below).  
- **Require users to keep a role in this menu** (`force_role`) — When enabled, members must **keep at least one** role from this menu’s reaction list (only for **standalone** menus).  
- **Remove previously given role from menu** (`remove_old_role`) — When enabled, picking a new role from **this** menu can **remove** another role that came from the **same** menu (standalone only).  
- **Reaction roles** — One row per choice: **emoji** (picker: native or server custom) + **Discord role**. Add/remove rows with **Add role** / trash. Each row is one reaction Antidote will place on the posted message.  
- **Required roles** — Member must have **at least one** of these roles to use the menu.  
- **Ignored roles** — Members with **any** of these roles **cannot** use the menu.  
- **Role notification DMs** — Only for **standalone** menus; see **DM mode** below.

**DM mode** (`role_dm_mode`) for standalone menus:

- **Default bot messages** — Antidote sends its **built-in** short DM text when roles are given or taken.  
- **Disabled** — **No DM** when roles change from this menu.  
- **Custom embeds** — Two saved **server embeds**: one when a role is **given**, one when a role is **taken** (from **Server embeds**). The editor links to the embed manager and offers a **variables** reference (User, Guild, Menu, Role placeholders).

## Grouped menus

If **Role menu group** is set on a menu:

- **Force role**, **Remove old role**, **Required roles**, and **Ignored roles** on **that menu** are **not** edited there — the **group** defines them for all menus in the group.  
- **Role notification DMs** for menus in the group are configured under **Role menu groups** (not on the single menu). If you later **remove** the menu from the group, the menu’s **own** DM settings are kept.

The group editor exposes:

- **Group name** — Required; max **100** characters in validation.  
- **Ignored roles** — Users with any of these roles **cannot** interact with menus in this group.  
- **Required roles** — User must have **at least one** of these roles to interact.  
- **Remove old roles when selecting new ones** — Turning a role on in one menu in the group can **strip** conflicting roles from **other** menus in the same group (useful for mutually exclusive color roles).  
- **Force users to have at least one role from this group** — Same idea as standalone `force_role`, scoped to the **group**.  
- **Role notification DMs** — Same three modes as a standalone menu (**default** / **disabled** / **custom** with give/take embeds).

## Posting the menu in Discord

After **Create** or **Update**, the editor shows a fixed **initialization command** of the form **`rolemenu create <menu_id>`**. The dashboard may display a default prefix character; use whatever your server uses.

- **Reply** to the message that should become the menu **or** pass the **message ID** as an argument.  
- Antidote uses that message to add reactions and register collectors.

> [!warning] Hierarchy
> Antidote’s highest role must be **above** roles it assigns, or Discord will reject changes.

## Clearing a menu from a message

Use **`rolemenu clear`** with the **menu message’s ID** (Developer Mode → copy ID), or follow the bot’s usage for **replying** to that message — see in-Discord help for your prefix.

## Related

- **Role templates** — bulk packages of embeds, roles, and menus; optional shortcut if your host exposes a template library.


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 

# Invasion Boss

The invasion boss is a boss that you can kill with everyone in the server.\
It appears every <mark class="info">1 in 3000</mark> messages.

## Rewards

Kill it for explicit rewards, in the form of items, resources or more.

## Dangers

> [!error] Losing Profile Experience
> The boss has a 5% chance to hit you, which will deal direct damage to your experience and profile level.

![Invasion Boss](https://api.antidote.bot/media/invasion_boss.jpg)

RPG - Invasion Boss

# 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

# 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

# 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

# Automod

Automod helps your server **stay clean automatically**. You create **rules** in the Antidote dashboard: each rule watches for something specific (bad words, sketchy links, spam, and more), counts how often someone trips it over a window of time, then **warns** them and/or applies a **consequence** (like a mute or jail).

> [!info] [!outlined] Where you set it up
> Open the **Antidote website**, go to your **server dashboard**, then open **Automod**. You will see your list of rules, a button to **create** a new one, and **Manage blacklisted words** for word-based rules.

![Automod rules list in the dashboard](https://i.gyazo.com/dc1d9ac60db60a868fadde68cbbc86df.png)

## What you need on Discord

Antidote must be able to **read messages**, **delete messages** when you choose that option, and **apply** whatever consequence you pick (timeouts, kicks, etc.). If the bot is missing permissions, rules may not run fully—check Antidote’s role and channel permissions like any other moderation bot.

## How a rule works (in plain terms)

1. **Someone sends a message** that matches the rule (for example a blocked word or too many pings).
2. The bot counts that as **one hit** toward that rule for that person.
3. If they hit the rule **often enough** within the **time window** you set, the **consequence** runs (for example mute or jail).
4. You can optionally **log** hits to a channel you pick, **delete** the bad message, and **warn** the member by DM or in the channel.

> [!tip] One rule per “trigger type” when creating
> When you **add** a brand-new rule, you usually **cannot duplicate** the same trigger type twice—if you already have “blacklisted word in message,” edit that rule instead of making a second one with the same trigger.

## Blacklisted words

Word-based rules use a **shared word list** for your server. Use **Manage blacklisted words** on the Automod page to add or remove entries. Different rules can then focus on:

- **Message only** — only the message text is checked.  
- **Name only** — username or server nickname.  
- **Message or name** — either can trip the rule.  
- **Strict** — a tighter match style for blacklisted terms in text or names.

Turn on **Check unicode** when you want to catch people trying to **disguise** letters with fancy Unicode lookalikes.

## Other triggers you can pick

| Trigger (as shown in the dashboard) | What it does in practice |
| ------------------------------------ | ------------------------- |
| **Message matches regex** | Fires when the message matches a **pattern** you define (for advanced setups). Invalid patterns are ignored so the bot does not crash. |
| **Emote spam** | Fires when a **single message** contains more emojis than your limit (custom Discord emojis and common Unicode emojis count). |
| **Someone spams mentions** | Fires when a message has **more user mentions** than your limit. |
| **URL that is not related to Discord** | Fires when the message has **web links** that are not the basic allowed Discord links the bot always trusts. |
| **Discord server invites** | Fires on invites that lead to **another server** (your own server’s normal invite / vanity is allowed). |
| **Harmful images / scam images** | Compares images in the message (attachments, embeds, image links) against **known bad fingerprints** your staff or Antidote maintain—useful for scam screenshots that keep coming back. |

> [!tip] Try it in a quiet channel first
> After you turn on a new rule, send a few test messages in a **staff-only** channel so you can confirm warnings, deletes, and consequences feel right before opening it to everyone.

## Spam limits and “how many times”

For spam-style triggers you set **how many** emojis or mentions (or similar) count as **one bad message**. Separately you set:

- **How many times** someone must trip the rule, and  
- **Within how many minutes**,

before the **consequence** applies. Think of it as: “this many strikes in this many minutes, then take action.”

## Consequences and warnings

You choose what happens when the limit is reached—for example **warn only**, **jail**, **mute**, **timeout**, **kick**, **ban**, or **no further action**.

- For **mute** and **timeout**, you also set **how long** (in minutes).  
- **Warn** can be the main outcome, or an **extra heads-up** before a stronger action.  
- You can send warnings to the member’s **DM** or post them **in the channel**, and you can attach a **custom embed** for warnings if you use saved embeds elsewhere.

**Delete trigger message** removes the message that caused the hit—useful for slurs, invite spam, or scam links.

## Ignored roles

Pick roles that should **never** be punished by a rule—usually **staff** or **bots**. Members with any of those roles skip that rule entirely.

## Limits

How many rules you can save depends on your **plan** (free vs premium). If the dashboard says you are at the cap, remove an old rule or upgrade.

## After you save

The bot **remembers settings for a short time** before refreshing from the server. If a change does not seem live right away, wait a minute or two or ask your host how they **refresh** Antidote’s cache after dashboard edits.

## Related

- **Antinuke** — big-picture raid protection, separate from per-message Automod rules.  
- **Jail / moderation** — make sure jail channels and roles exist if you use **jail** as a consequence.


Automod

# 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.

RPG - Pets

Base skills and stats + Training

Base skills and stats

Training your pet

Renaming a pet

Discarding a pet

Contents