# Custom Instances

Elyxir maintains full support for Custom Instances with our **Deluxe Tier**. Once you purchase the bot in [our store](https://store.elyxir.dev), setting it up is easy!

#### OBJECTIVES

* [Create a custom instance for **Elyxir**](#creating-your-bot)
* [Customise this custom instance to use your server's branding](#customising-your-bot)

<figure><img src="/files/F4WZZ2nronsUBSqJ27kt" alt=""><figcaption><p>Your custom instance could look like this!</p></figcaption></figure>

#### **REQUIREMENTS**

Custom Instances are only available for servers with the **Deluxe Tier**. You can purchase it [**in our store**](https://store.elyxir.dev).

## Creating a Custom Instance

In order to set your custom instance up, you'll first need to create the bot on the [**Discord Developer Portal**](https://discord.com/developers), where you'll need to log in and press the **New Application** button at the top.

<figure><img src="/files/tQ8dSojM0LzqW642qdkN" alt=""><figcaption></figcaption></figure>

Next, name your bot and click **Create**.  Now, navigate to the **Bot** tab and scroll down to the **Privileged Gateway Intents** section. You need to enable all of these for Elyxir to be able to function properly.

<figure><img src="/files/gY6TduQYbDDqiRxVrF7f" alt=""><figcaption></figcaption></figure>

Once you have enabled all of these intents, make sure to press **Save Changes** before continuing.

{% hint style="warning" %}
Elyxir cannot function without all of these intents enabled, these are prerequisites for many functions so the bot will refuse to start.
{% endhint %}

Now that all of the privileged intents have been enabled we can now focus on setting up Elyxir to work on this bot. To do this, with the main Elyxir#1470 bot in your Discord server [(invite it using this link if you haven't already)](https://invite.elyxir.dev), run the [`/branding setup`](/commands/branding/setup.md) command. This command will spawn a form, which you need to provide two pieces of information.

#### Client ID:

The first property is the Client ID which you can obtain in the **General Information** tab. In this tab it is listed as the Application ID.

<figure><img src="/files/iu6LJwVW4woNZPwbDZD9" alt=""><figcaption></figcaption></figure>

#### Token

The second and final property is the token, which you can obtain in the **Bot** tab. Press the **Reset Token** button (if required enter your 2FA code) and then copy the token.

<figure><img src="/files/O7WGZQMPuAdwOal7rnvv" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
Do not share this token with anyone, including our team! It has the potential to be extremely destructive to your server. The only bot which will ever ask for your token for our purposes is Elyxir#1470.

**If you are concerned that you may have been victim of social engineering,** [**reset your bot token**](https://support-dev.discord.com/hc/en-us/articles/6470840524311-Why-can-t-I-copy-my-bot-s-token#h_01G56XRFF5AN811CKKMQ9T2HQT)**!**
{% endhint %}

You're all set! In this section you have successfully setup a custom instance of Elyxir. We recommend kicking the main **Elyxir** bot to avoid conflicts.

{% hint style="danger" icon="light-emergency" %}
Do **not** use your custom instance in conjunction with other bots, especially not Mass DM bots. In the event that your bot is quarantined by discord for sending Mass DMs, it will automatically be paused by Elyxir to prevent repercussions for our infrastructure.
{% endhint %}

## Customising the Custom Instance

There are numerous aspects of customisation for the bot which will all help to improve the appearance of the bot in your server. You must run these commands on your **custom instance** (not @Elyxir#1470)

#### Embed Colour

To change the colour which is used by default in embeds, you should run the [`/branding colour`](/commands/branding/colour.md).  which accepts a hexadecimal colour as an argument, you can generate a color code online.

#### Embed Footer

You can also customise the default footer for embeds by running the [`/branding footer`](/commands/branding/footer.md) command.

#### Status

You can customise the bot's status using the [`/branding status`](/commands/branding/status.md) command. It supports parameters for more advanced behaviour, which will be periodically refreshed to show the up to date information.

```
{fivemPlayers}     *    - The number of active players on your FiveM Server
{fivemMax}         *    - The player count cap for your FiveM Server
{guildMembers}          - The number of members in your Discord Server.
{guildName}             - The name of your discord server
{gangCount}             - The number of registered gangs in your server
{ticketsOpen}           - The number of open tickets in your server
{ticketsCount}          - The total count of tickets made in your server
```

{% hint style="info" %}
Parameters marked with `*` require the [FiveM Integration](/fivem-integration.md) to be configured.
{% endhint %}

#### About Me

To customise the About Me for the bot, open the [**Discord Developer Portal**](https://discord.com/developers) and select the correct application. Then, select the **General Information** tab and in the **Description** field, enter the desired text for your About Me. Once you are finished, save your changes and your bot's biography will be updated!

<figure><img src="/files/wCJp4w0Ra3oGAAdb5fjg" alt="" width="276"><figcaption></figcaption></figure>

<figure><img src="/files/IiSiOE9XcBYvVNb3Fy8v" alt=""><figcaption><p><a href="https://zap-hosting.com/deluxe"><strong>Click here to be redirected to our affiliate link!</strong></a></p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.elyxir.dev/features/custom-instances.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
