Skip to content

Instantly share code, notes, and snippets.

@Joshuliu
Last active August 21, 2018 07:15
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Joshuliu/e2504ea21d78f478815462f06a5a515d to your computer and use it in GitHub Desktop.
Save Joshuliu/e2504ea21d78f478815462f06a5a515d to your computer and use it in GitHub Desktop.
How to configure the bot with AppBot. Github Gists power AppBot's website.

Configuration

The configuration command allows administrators and specific roles to create, edit, and delete applications. It also allows members to set up channels for logging, various permissions, bot settings, and much more.

/config

Alias: /configuration

To start, type /config in your server. You must have the administrator permission, or an application editing role in order to run this command. If you have just added the bot and/or have not created any applications, the bot will DM you with this message: Start The bot will guide you through the process of creating your first application. Answer the questions in the DM with the bot. After you've finished, typing /config will let you see the menu below. If you've previously created an application, you will also see this menu. Configuration This menu consists of 5 menu items - Application Settings, Channels and Permissions, Bot Settings, Reset, and Exit. Use reactions to select the corresponding menu item. This guide will cover what each menu item does.

1. Application Settings

When you select the first option, application settings, you will get a menu that looks like this: Application Settings Use reactions to select your next action. This is what each menu item does.

Create an Application

When you select this option, the bot will follow up with questions and steps on setting up your new application. After following each step, you'll be able to create another application, along with your current one(s).

Edit an Application

Selecting this option will bring up yet another menu. The bot may ask for which application you would like to edit if you have more than one application set up. Edit Application From here, select what part of the application you would like to edit. Note: Selecting the third option, configure questions, will pull up another menu. This menu allows you to pick wether you'd like to add, remove, or edit questions.

Delete an Application

Selecting this option will allow you to delete an application. Another menu may appear asking which application you would like to delete if you have more than one application.

Open/close an Application

This option allows you to close opened applications, or open closed applications. Closing an application means that members can no longer apply for a position. You can reopen it any time if you'd to let people apply.

Back

Go back to the main menu.

2. Channels and Permissions

The second menu option allows you to set various permissions for different users or roles. You can also set channels to log actions, post reviewed applications, and more. Channels and Permissions The information below shows what each menu item does.

Blacklist or Whitelist Roles

This menu item allows you to blacklist or whitelist roles. Anyone with a blacklisted role in their roles will not be able to apply. This is useful for stopping users submitting spam applications. Blacklisting Type the name of a role you would like to blacklist or whitelist. If you have not set any blacklisted roles, this message would say "(None set)". Otherwise, a list of blacklisted roles would be in the message, like shown above. Entering a blacklisted a role below it will automatically whitelist the role, while entering a whitelisted role would blacklist the role.

Set a Log Channel

Set a channel to log all application related actions. This means that a message will be sent here every time someone does anything, like creating an application, editing an application, changing a prefix, etc. When entering the name of a channel, you must enter the exact name, without #, and without linking the channel. This means that if you have a channel called #appbot-logs, you would type appbot-logs. Not #appbot-logs or a link to the channel, but appbot-logs as text by itself.

Set an Archives Channel

An archives channel means that whenever an application has been accepted or denied, a copy of the reviewed application will be sent to the channel. When entering the name of a channel, you must enter the exact name, without #, and without linking the channel. This means that if you have a channel called #archived-apps, you would type archived-apps. Not #archived-apps or a link to the channel, but archived-apps as text by itself.

Add/remove an App Editing Role

Adding an app editing role would allow users without the administrator permission to run the /config command, allowing them to configure the bot, applications, and more. Note that these users can also give themselves permission to review members. Type the name of an app editing role you would like to add or remove. If you have not set any application editing roles, this message would say "(None set)". Otherwise, a list of app editing roles would be in the message. Entering a role that's on the list will automatically remove it. Otherwise, the bot will add the role to the list.

Add/remove an App Reviwing Role

Adding an app editing role would allow users without the administrator permission to run the /review command, without actually having the administrator permission. This does not give the user permissions to configure applications. Type the name of an app reviewing role you would like to add or remove. If you have not set any application reviewing roles, this message would say "(None set)". Otherwise, a list of app reviewing roles would be in the message. Entering a role that's on the list will automatically remove it. Otherwise, the bot will add the role to the list.

Back

Go back to the main menu.

3. Bot Settings

Bot Settings

Add/remove Custom Prefixes

This bot allows you to set more than one custom prefix for your bot. Bot mention is a required prefix, but you can remove / and add your own custom prefix(es). Type a prefix that you would like to add or remove. Entering a prefix that's on the list will automatically remove it. Otherwise, the bot will add the role to the list.

Toggle Channel or DM

By default, the bot DMs you the config menu and review menu. That means that you will receive DMs from the bot instead of getting the response from the same channel as the bot. By selecting this menu option, the bot will from now on send menus to the same channel if the bot is currently DMing you, or start to DM you if you're in the same channel where you ran /config (Hence, toggle channel or DM).

Back

Go back to the main menu.

4. Reset

Reset the bot. This means that all your settings will be destroyed. This can also fix any potential bugs that may have occured with AppBot for your server. This is a dangerous action.

5. Exit

Exit the configuration Menu.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment