Quick Setup Guide

This guide covers the high-level flow of setting up Nocturne. For detailed explanations of the mechanics behind these commands, click the links provided in each step.

1. Proper Setup & Permissions

   Before running any commands, ensure Nocturne’s role is placed higher in your server’s role list than any roles it needs to assign or remove.

   • Required Permission: Manage Roles
   • Optional Permission: Manage Webhooks (Required if you plan to use the logging system).

   Make sure to you have gone through our Before You Start Guide to have a better understanding.

2. Create a Tree

   A “Tree” is the container for your hierarchy. Consider it as a promotional pathway or a ladder. You can create as many trees as you need (e.g., one for Moderation, one for Events).

   Command

   /tree create <name>
   

   Example

   /tree create name:Moderation
   

   Want to dive deeper into managing trees? Check out the Tree Basics page.

3. Add Base Roles to the Tree

   Base roles dictate the actual rank of the staff member.
   The position parameter dictates the hierarchy level, where 1 is the lowest rank. If left blank, it defaults to the highest available position.

   Command

   /tree role add <tree> <role> [position]
   

   Example

   /tree role add tree:Moderation role:@Trainee
   

   Curious about how position math and hierarchy levels are calculated? Read the Base Roles Guide.

4. Add Linked Roles (Optional)

   Linked roles are cosmetic or secondary roles (such as Staff Lounge Access, Raid alert, Ban Permission role) that are automatically assigned or removed alongside a base role.

   Command

   /tree linked-role add <tree> <base> <role>
   

   Example

   /tree linked-role add tree:Moderation base:@Moderator role:@Raid Alert
   

   Discover how to automate linked role assignments in the Linked Roles Documentation.

5. View Your Tree

   Verify that your base roles, positions, and linked roles are configured correctly by viewing the tree layout.

   Command

   /tree view [tree]
   

   Example

   /tree view tree:Moderation
   
6. Configure Server Flags

   Nocturne has three major behaviour flags you can toggle to fit your server’s needs.

   • Instant Fire: Allows firing a member directly from a higher position without having to demote them step-by-step first.
   • Persistence: Keeps linked roles assigned from previous (lower) base roles when a user is promoted.
   • DM Messages Default: A global toggle that sets whether DM notices are sent to users by default.

   Command

   /config flags
   

   Use the interactive menu provided to toggle each of the above-mentioned flags.

   Need a deeper explanation of how these toggles affect your server? See the Configuration Overview.

7. Whitelist Roles (Optional)

   By default, only those with the Manage Roles permission can run staff commands. You can whitelist specific roles to allow them to Hire, Fire, Promote, or Demote.

   Command

   /config whitelist-role <role>
   

   Example

   /config whitelist-role role:@Recruiters
   

   Learn how to delegate bot access without giving out full server rights in the Whitelist Roles Section.

8. Set Up the Log Channel (Optional)

   Keep an audit log of every staff action taken by Nocturne. This requires the bot to have Manage Webhooks permissions in the target channel.

   Command

   /config log-channel set <channel>
   

   Example

   /config log-channel set channel:#staff-logs
   

   Find out more about this in Log Channel Guide.

9. Customise DM Notices (Optional)

   Personalise the direct messages sent to users when an action is taken against them. You can set these globally, or uniquely per tree. Each action globally or for the tree gets its own custom message.

   Command

   /config dms edit <action> [tree]
   

   Example

   /config dms edit action:Promote tree:Moderation
   

   To preview your messages and view the full list of placeholders you can use, head to the DM Notices Guide and the Variables Cheat Sheet.

10. Run Staff Commands!

    Your bot is fully configured. You can now start managing your team using the core staff commands.

    Command

    /staff hire <user> <tree> [reason] [dm-user] [notes]
    /staff fire <user> <tree> <reason> [dm-user] [notes]
    /staff promote <user> <tree> [reason] [dm-user] [notes]
    /staff demote <user> <tree> <reason> [dm-user] [notes]
    

    Example

    /staff hire user:@ArcticFox tree:Moderation
    

    Visit the Staff Actions Page to know more!