đApplications Master Tutorial
A heavy breakdown on the Applications Module (lots of scrolling here, check the sidebar!)
This configuration takes place in the /configuration/applications.json file!
You might need Discord Developer Mode on to get ID's and such!
Key words:
Boolean: A true or false switch
String: An assortment of "text" or "numbers" like this
Numbers: Just numbers!
Array: Strings or Numbers["in", "a", "pattern", "like", "this"]
Welcome!
Here we'll go over the Applications Module setup in its entirety, with brief (or not so brief!) explanations and descriptions on things.
I made sure to separate everything the best possible so that the sidebar has a quick reference to what you're looking for.
Feedback is welcome!
If you think something is missing, or needs a bit more work, then make sure to leave us a note at our support server!
Basic Configuration Tutorial
"staff_management_hook"
If set to true the accepted user will be automatically given his roles, the staff roster panel will be updated and a promotion message will be generated depending on the staff_management configuration. (Boolean) For more information please take a look at the staff_management config.
Default: true,
A simple Boolean statement, this basically sets up Athena in a way where if someones' Staff Application gets accepted, they will automatically get their roles, the staff panel will update, and Athena will send the user their promotion message (if configured to do so). This is super useful for on-the-fly promotions.
It has to be either true or false, so there's no leaving it blank!
Usage:
On false, you will have to manually give people their roles when Staff Applications are accepted, sync the staff roster, and more.
On true, Athena will handle the roles and staff roster automatically
"application_channel_name"
Application channel name, available placeholders: %random%, %creator%, %created_total% (String)
Default: "app-%random%",
A String statement, this allows your staff application's channels to have a specific naming scheme.
You theoretically could leave it blank, but we don't recommend it. It could break things.
Examples:
"app-%random%" creates a channel named app-24513
(the default channel name and a random assortment of numbers)
"app-%creator%" creates a channel named app-Wumpus
(the default channel name and the application creator's name)
Application Configuration Setup
An imaginary example will be used, that way it's easier to follow along!
All IDs, Channels, and Config names are imaginary.
Name the Application
First of all, we wanna set the Application name! This can be anything you want it to be, since it's a String. Let's say we wanna call it Super Special Staff!
Add a Description
Then we add a description so people know what the category is. That way people aren't lost about what it's meant to be used for.
Add an Emoji
Afterwards, we can either copy paste an emoji directly into the config file, or we can use custom emojis by using \<whatever emoji you want to use>, or if you want a guide, that's here! A default police officer emoji is fine here.
Send It To a Specific Category
So we have a category set up, but it's not going anywhere without a category ID. So we set that here! To get a category ID, you right click on the category you want the applications to go to. In this case, the category we want our applications to go to is our Senior Staff channel.
Setting Application Question Set ID
Done with setting the category? Now we have to assign questions to our application category. You're able to make question sets for the application modals, yes, modals! In this case you assign whatever ID you're gonna make your question set with. We'll go over what application question sets are in just a moment. For now, let's say we wanna call it super_special_questions.
IDs cannot have spaces! This will break the plugin!
Please use _ instead of spaces: eg. "first_set" instead of "First Set"
Setting Role Visibility IDs
Alright, almost done with this stage of the Application configuration, at least the setup of it!
This step involves setting up the roles that are able to access the Applications. Basically, any IDs you set up in this Array get access to Applications. Want only one role handling all of them? Cool. Want your whole staff team taking care of them? Okay. It's really up to you as to how you want to do it.
Note: In this case, Arrays can be either written horizontally or vertically. whatever helps you keep it more organized is best. Something like below!
Right now, I want 3 roles to be able to see my Super Special Staff applications: My Staff, Senior Staff, and the Owner, so I add them accordingly.
Setting Role Mention IDs
Final step for the basics on an Application!
This step involves setting up the roles that get pinged when new Applications are created. Basically, any IDs you set up in this Array get mentioned on Application creation. Want only one role getting it? Sure thing. Want your whole staff team taking care of them? Alright. It's really up to you as to how you want to do it.
Note: In this case, Arrays can be either written horizontally or vertically. whatever helps you keep it more organized is best. Something like below!
I want all three roles to be able to get pinged when we get new Super Special Staff applications: My Staff, Senior Staff, and the Owner, so I add them accordingly.
Checkpoint! đŠ
You set up your first Application category, and any further Application categories can be set up in exactly the same way using these steps! Once you get used to how the system works, your file can be even made smaller without the comments attached to each category! But overall, your config should look something like the below example. Once you get used to how it's formatted, you'll be able to make the new categories without all the comments in between. We've still got some work to do though!
Application Question Set Setup
What's this for?
Now we move onto the Application Question Sets.
Application Question Sets are what they sound like, they're sets of questions specifically made for an Application modal. Let's say you want to get Developers and Staff Members, you can make a series of questions for each of those categories that will pop up in a modal for the users to answer, they can even be multiple pages!
What are the limitations?
They can only have 45 characters in them. That's a Discord limitation!
How do I configure them?
Application Question Sets aren't hard to make! They just take a bit of time. We have to assign an ID to the set, the questions we want to ask, the minimum and maximum response length, and if they're required or not.
This is the format:
For every additional question you want to add, you need to add it after the },, and then to add other additional set of questions, you add them after the], bracket by separating them with }],
This configuration behaves similarly to the Ticket Config file.
Something like this:
And that's it! You can add more question sets for new categories you make!
But for now, this is what our completed configuration looks like! You can even copy it if you want to look at it more!
Congrats! đ
You're all done here! Now you can move onto other plugins and see how they work!
Last updated
