Custom Instances

This feature is a base functionality which means that it cannot be disabled

Elyxir maintains full support for Custom Instances with our Deluxe Tier. Once you purchase the bot in our store, setting it up is easy!

OBJECTIVES

Your custom instance could look like this!

REQUIREMENTS

Custom Instances are only available for servers with the Deluxe Tier. You can purchase it in our store.

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, where you'll need to log in and press the New Application button at the top.

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.

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

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), run the /branding setup 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.

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.

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.

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. which accepts a hexadecimal colour as an argument, you can generate a color code online.

You can also customise the default footer for embeds by running the /branding footer command.

Status

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

{fivemPlayers:cfx_code} - The number of active players on your FiveM Server
{fivemMax:cfx_code}     - 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

Make sure you replace cfx_code with your FiveM CFX code. For example, 4epke8.

About Me

To customise the About Me for the bot, open the Discord Developer Portal 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!

Last updated