DOCSEARCHbyAlgolia
Submit Docs

NyxBots Documentation

website·Indexed 30 days ago

https://docs.nyxbots.fr

Documentation for the NyxBots management bot, featuring guides on getting started, creating Discord bots, and managing internal permissions using commands like +createperm, +perms, +delperm, and +moveup. Includes details on ticket system configuration and custom message variables.

Tokens
3.2K
Snippets
16
Records
28
Agent score
50%

What's inside NyxBots

  1. Understand the NyxBots ticket system workflow

    The ticket system allows server members to request help or report issues by creating tickets. The general workflow is as follows:

    1. Creation: A user creates a ticket via a button or select menu (depending on the server configuration).
    2. Channel Generation: The bot automatically creates a private channel dedicated to that specific ticket.
    3. Communication: The user communicates with moderators within this private channel.
    4. Assignment: A specific moderator can take charge of the ticket.
    5. Closure: The ticket channel can be closed by a manager or a moderator once the issue is resolved or if the ticket is abandoned.

  2. Understand NyxBot permission hierarchy and structure

    NyxBot uses a hierarchical permission system where a member with a role associated with a higher-positioned permission is considered superior to members with lower permissions. Each permission has a specific position that defines its place in this hierarchy.

  3. Use Channel variables in custom messages

    Use these variables to insert information about the Discord channel where the message is sent.
    VariableDescriptionExample
    {ChannelName}Channel namegeneral
    {ChannelID}Channel ID123456789012345678
    {ChannelMention}Channel mention#general
    {ChannelTopic}Channel topicBienvenue !
    {ChannelNSFW}Whether the channel is NSFWoui/non
    {ChannelCreatedAt}Channel creation date2021-01-01T00:00:00.000Z

  4. Use Server (Guild) variables in custom messages

    Use these variables to insert information about the Discord server (Guild).
    VariableDescriptionExample
    {GuildName}Server nameMon Serveur
    {GuildID}Server ID123456789012345678
    {GuildIcon} / {GuildIconURL}Server icon URLhttps://cdn.discordapp.com/icons/...
    {GuildBanner} / {GuildBannerURL}Server banner URLhttps://cdn.discordapp.com/banners/...
    {GuildBannerColor}Server banner color#FF0000
    {GuildAccentColor}Server accent color#FF0000
    {GuildMemberCount}Number of server members150
    {GuildRegion}Server regioneurope
    {GuildCreatedAt}Server creation date2021-01-01T00:00:00.000Z

  5. Assign command access to a custom permission

    You can restrict a command to a specific custom permission. Users with a role associated with that permission, or any permission level higher than the specified one (e.g., Whitelist, Owner, or Buyer), will be able to use the command.
    +change <command> <custom_perm_name>

  7. Create a Discord Bot application for NyxBot

    To use NyxBot, you must first create a bot application on the Discord Developer Portal. Follow these steps:

    1. Go to the Discord Developer Portal.
    2. Click on "New Application", enter your bot's name, and click "Create".
    3. In the left-hand menu, navigate to the "Bot" tab.
    4. In the "Presence Intent" section, enable all three checkboxes and click "Save Changes".
    5. Retrieve the bot token. This token is required to configure your NyxBot.

    Important: For security reasons, NyxBots will never display your token once it has been configured. If you lose it, you must reset it via the Discord dashboard.

  8. Create and activate a NyxBots bot

    To set up a NyxBots bot, use the NyxBots dashboard. You will need a Discord account and a bot token (obtained from the Discord Developer Portal).

    Steps to create and activate the bot:

    1. Log in to the NyxBots Dashboard using Discord.
    2. Navigate to the "Bots" page in the left-hand menu.
    3. Click "Créer un bot" (Create a bot).
    4. Enter the bot's name and the Discord bot token, then click "Créer".
    5. To activate premium features, go to the "Premium" tab in the left menu.
    6. Select your newly created bot.
    7. Enter your purchased premium code in the "Code Premium" field and click "Activer le code".
    8. Return to the "Bots" tab and click "Démarrer" (Start) to bring the bot online.

  9. Restrict command access to buyers only

    To remove a command from all special permission levels and restrict its use exclusively to 'buyers' (who possess most administrative rights), associate the command with the buyer permission.
    +change ping buyer

  10. Create and manage custom permissions

    In addition to system permissions, you can create custom permissions. Unlike built-in permissions, custom permissions are not present by default. You can create, delete, modify, and assign these permissions to specific roles to define which members possess them.

  11. Create and configure a ticket panel

    Ticket panels allow you to categorize different types of support requests. To create one, select 'Créer un panel' and provide a name (which can be replaced by an emoji later).

    Once created, use 'Modifier ce panel' to access the following settings:

    Panel Information & Routing

    • Panel Name & Emoji: The visual identifier for the panel.
    • Destination Channel: The channel where the ticket creation panel will be sent.
    • Ticket Category: The Discord category where new ticket channels will be created.
    • Panel Log Channel: A specific channel for this panel's logs (opening, closing, member additions) and transcripts.

    Access & Notifications

    • Management Roles: Roles specific to this panel that can view, close, or claim tickets.
    • Ping Roles: Roles notified via mention when a user opens a ticket (ensure the bot has permission to mention these roles).

    Automation & Behavior

    • DM Transcripts: If enabled, the online transcript link is sent to the user via DM upon ticket closure.
    • Auto-close on Leave: Automatically closes the ticket if the user leaves the server.
    • Delete on Close: Automatically deletes the ticket channel upon closure.
    • Button Style: Sets the style of the creation button (only applicable if the global display type is set to 'Buttons').