This documentation goes over everything needed for our Hiring Bot. Information about the config and setup is all stated below. We also have answered some of the fequently asked questions, and give information that needs to be know or just may help users.
Important Note
Changing or modifing any of the bots code except what is withinconfig.jsonandcolors.jsonis not recommended at any time.
Once you have purchased the Hiring Bot and your payment is recieved you will get access to download the bot.
You will need to have Node.js version
14.17.6or higher installed onto your computer.
Go to your profile on our store page and you will see a download button. After you download you will get a .zip file.
.zip wherever you want the bot's files to be..zip file and drag the contents into the other file you created..zip are in the folder where you want the bot's files.Once you have the files installed open the command window of your choice. Once you have it open make sure you are in the directory of your bot.
Tip
We recoment using Windows Terminal as it has the most support, easy to use functions, and looks quite clean.
This will only work for Windows Users!
Once you are in your command window and have the correct directory open do the following command: npm i
Doing this will install all the nessisary node packages to run the bot.
You must have the original package.json that was given in the download for this to work properly.
Before we get to all the settings within the config.json a couple base variables need to be set.
The bot token is an extremely important part of the setup. Without the token the bot wouldn't start or work at all.
Once you have your token go into your config.json and put the token in the where it says "Token": "Bot Token Here".
It should look something like this: "Token": "NzIyMjExMjM1NTQ1NzQzMzYx.XufxoA.sHrNVRY69wUMKeDKj0eA1AOTRKs"
This bot has a plethora of configurable settings that are easily changed within the config.json.
You can find a blank config.json in the Resrouce section of this page.
If in the config a section had [] around it then DO NOT remove them. Those are there because it allows you to set serveral items, if you only want one itme then just do this:
["Thing"]and multiply should look like this:["Thing", "Thing2", "Ect"]. Also if the [] are not present then DO NOT add them as the bot is not looking for serveral inputs.
If you need help with the config or break something reach out to the Agent Squad Productions Support Team! We can help you set things up or explain things further.
{
"Prefix": "!",
"Token": "Bot Token Here",
"bot_setup": {
"server_name": "Your Roleplay",
"bot_status": "online",
"bot_game_type": "WATCHING",
"bot_game": ["for applicants.", "amazing applications.", "departments grow!"],
"main_embed_color": "#fff"
},
}
This sets your bot's prefix. The prefix is what is put infront of all commands to use them. You can also ping the bot as a prefix. (Do not type "ping" or anything, the ping function will always work.)
This should already be setup. If not go back to here and do so.
This is your server's name. Anytime the bot goes to say your server's name it will use what you put here.
This is the stats of the bot. You can also use the following, custom imputs will not work: online / dnd / idle / offline
This is the game used in the bot's status. You can use the following, custom imputs will not work: PLAYING / WATCHING / LISTENING
This is the things that follow the bot_game text in the bot's status. If you want to add or remove things do it within the []. Make sure you add "" and , as needed.
This is simply the color of base embeds that the bot may posts for certain commands. Make sure to input a hex color. This is just like the color codes Discord uses. You can also go to htmlcolorcodes.com/color-picker/ to easily get a color you like.
{
"settings": {
"department_names": ["Police", "Sheriff", "State", "Fire", "Dispatch"],
"apps_open_dep_number": "4",
"apps_closed_dep_number": "1",
"owners": ["User ID of Owner"],
"all_app_logs": true,
"notice_ping": true,
"department_status_use": true,
"enable_logo": true,
"restrict_cmd_channel": true,
"preAppMSG": true,
"DMAppLink": false,
"depHead_see_apps": true
},
}
This is where you list all of your department names.
This is the total number of open applications.
This is the total number of closed applicaitons.
This is where all the owner's IDs are placed.
Allow all applications to be logged in one area. They are also logged in the seperate channels defined later.
This sets the wether the bot will ping a role for new applications or not.
This sets wether the bot shows the open / closed status of each department in the departments command.
This sets wether the logo of the department is displayed in the info and application commands.
This sets wether the bot restricts the join command to a certain channel that is defined later. |
This sets wether the bot displays a pre-application message when someone goes to apply for any department.
This turns on / off the DM Link system.
ON(true): The bot will DM applicants a message with information / a link for the department's application.
OFF(false): The bot will create a channel with an information message and allow the applicant to run another command to do an in server application based off questions defined later.
Allow the main department head role, defined later, to see application channels when created. Only applies if the DM Link system is off.
Make sure that the Department Names match with the ones listed in the settings!
You can set anything for the department status, but if you want to prevent people from apply for that department you must set the start as: Closed
You can add extra departments and status if you want, but again the department names must match with the ones in the settings.
{
"department_status": {
"police": "Open",
"sheriff": "Open",
"state": "Open",
"fire": "Part-Time",
"dispatch": "Closed"
},
}
Department Status
Make sure that the Department Names match with the ones listed in the settings!
You can add extra departments and info if you want, but again the department names must match with the ones in the settings.
{
"department_info": {
"police": "This is information about the police department.",
"sheriff": "This is information about the sheriff's office.",
"state": "This is information about the state police department.",
"fire": "This is information about the fire department.",
"dispatch": "This is information about the communications department."
},
}
Department Information
Make sure that the Department Names match with the ones listed in the settings!
You can add extra departments and messages if you want, but again the department names must match with the ones in the settings.
{
"department_aplicantMSG": {
"police": "Pre-application Message for the police department.",
"sheriff": "Pre-application Message for the sheriff's office.",
"state": "Pre-application Message for the state police department.",
"fire": "Pre-application Message for the fire department.",
"dispatch": "Pre-application Message for the communications department."
},
}
Department Pre-Application Message
Make sure that the Department Names match with the ones listed in the settings!
You can add extra departments and links if you want, but again the department names must match with the ones in the settings.
{
"department_appLink": {
"police": "Link",
"sheriff": "Link",
"state": "Link",
"fire": "Link",
"dispatch": "Link"
},
}
Application Link
Make sure that the Department Names match with the ones listed in the settings!
You can add extra departments and image links if you want, but again the department names must match with the ones in the settings.
{
"department_logo": {
"police": "Image Link",
"sheriff": "Image Link",
"state": "Image Link",
"fire": "Image Link",
"dispatch": "Image Link"
},
}
Imagine Link
Make sure that the Department Names match with the ones listed in the settings!
You can add extra departments and image links if you want, but again the department names must match with the ones in the settings.
{
"department_colors": {
"police": "#111b88",
"sheriff": "#184e13",
"state": "#2ca9ba",
"fire": "#f50a0a",
"dispatch": "#f5d60a"
},
}
Color Hex Code
To easily gets colors you can go to htmlcolorcodes.com/color-picker/.
Make sure that the Department Names match with the ones listed in the settings!
Not inputting a channel ID can lead to the bot crashing.
You can add extra departments and channel IDs if you want, but again the department names must match with the ones in the settings.
{
"channel_ids": {
"hiringCMD": "Channel ID",
"app_category": "Channel ID",
"all_app_logs": "Channel ID",
"police": "Channel ID",
"sheriff": "Channel ID",
"state": "Channel ID",
"fire": "Channel ID",
"dispatch": "Channel ID"
},
}
Where the join command is restricted to. (If restriction is active.)
Category ID of where application channels are moved to when created. (Only applies if not using DM Link System.)
Channel ID where all applications will be logged.
Channel ID of where departments will be notified of new applicant / application
Make sure that the Department Names match with the ones listed in the settings!
Not inputting a role IDs can lead to the bot crashing.
You can add extra departments and channel IDs if you want, but again the department names must match with the ones in the settings.
{
"role_ids": {
"staff": "Role ID",
"depHead": "Role ID",
"all_app_logs": "Role ID",
"police": "Role ID",
"sheriff": "Role ID",
"state": "Role ID",
"fire": "Role ID",
"dispatch": "Role ID"
},
}
Main Server Staff Role ID.
Main Department Head Role ID.
Role ID for department role to be pinged for new application. (Ping function is configable setting.)
Make sure that the Department Names match with the ones listed in the settings!
Not inputting a questions will lead to application not working properly. (Only if DM Link system is disabled.)
You can add extra departments and channel IDs if you want, but again the department names must match with the ones in the settings.
{
"department_info": {
"police": ["Question 1", "Question 2", "Question 3", "Question 4", "Question 5"],
"sheriff": ["Question 1", "Question 2", "Question 3", "Question 4"],
"state": ["Question 1", "Question 2", "Question 3"],,
"fire": ["Question 1", "Question 2", "Question 3", "Question 4", "Question 5", "Question 6"],
"dispatch": ["Question 1", "Question 2"]
},
}
Questions for the application.
Below are all the configs used for this bot. A default and blank version is provided incase you break something, want to start over, or need to look at the original configs.
{
"prefix": "!",
"token": "Bot Token Here",
"bot_setup": {
"server_name": "Your Roleplay",
"bot_status": "online",
"bot_game_type": "WATCHING",
"bot_game": ["for applicants.", "amazing applications.", "departments grow!"],
"main_embed_color": "#fff"
},
"settings": {
"department_names": ["Police", "Sheriff", "State", "Fire", "Dispatch"],
"apps_open_dep_number": "4",
"apps_closed_dep_number": "1",
"owners": ["User ID of Owner"],
"all_app_logs": true,
"notice_ping": true,
"department_status_use": true,
"enable_logo": true,
"restrict_cmd_channel": true,
"preAppMSG": true,
"DMAppLink": false,
"depHead_see_apps": true
},
"department_status": {
"police": "Open",
"sheriff": "open",
"state": "Open",
"fire": "Part-Time",
"dispatch": "closed"
},
"department_info": {
"police": "This is information about the police department.",
"sheriff": "This is information about the sheriff's office.",
"state": "This is information about the state police department.",
"fire": "This is information about the fire department.",
"dispatch": "This is information about the communications department."
},
"department_aplicantMSG": {
"police": "Pre-application Message for the police department.",
"sheriff": "Pre-application Message for the sheriff's office.",
"state": "Pre-application Message for the state police department.",
"fire": "Pre-application Message for the fire department.",
"dispatch": "Pre-application Message for the communications department."
},
"department_appLink": {
"police": "https://shadowdevs.com",
"sheriff": "https://shadowdevs.com",
"state": "https://shadowdevs.com",
"fire": "https://shadowdevs.com",
"dispatch": "https://shadowdevs.com"
},
"department_logo": {
"police": "https://pngimg.com/uploads/police_badge/police_badge_PNG72.png",
"sheriff": "https://pngimg.com/uploads/sheriff/sheriff_PNG66.png",
"state": "https://images.vexels.com/media/users/3/158398/isolated/preview/13adf46d954beb393caa1e82b7d9db3d-badge-police-star-silhouette-by-vexels.png",
"fire": "https://1000logos.net/wp-content/uploads/2017/07/Fire-Department-Logo.png",
"dispatch": "https://cdn.discordapp.com/attachments/633499606164176897/817218064742875166/dispatch.png"
},
"department_colors": {
"police": "#111b88",
"sheriff": "#184e13",
"state": "#2ca9ba",
"fire": "#f50a0a",
"dispatch": "#f5d60a"
},
"channel_ids": {
"hiringCMD": "Channel for join command (Only needed if restricting command in settings)",
"app_category": "Category for where application channel is moved (Only needed if not using DM Link system)",
"all_app_logs": "Where the all applicants / applications are logged (Can be disabled in settings)",
"Police": "Where the Police Department is notified of new applicant / application",
"Sheriff": "Where the Sheriff's Department is notified of new applicant / application",
"State": "Where the State Police Department is notified of new applicant / application",
"Fire": "Where the Fire Department is notified of new applicant / application",
"Dispatch": "Where the Dispatch is notified of new applicant / application"
},
"role_ids": {
"staff": "Main Server Staff Role ID",
"depHead": "Main Department Head Role ID",
"Police": "Role ID for Police role to be pinged for new application (Ping function is configable setting)",
"Sheriff": "Role ID for Sheriff role to be pinged for new application (Ping function is configable setting)",
"State": "Role ID for State Police role to be pinged for new application (Ping function is configable setting)",
"Fire": "Role ID for Fire role to be pinged for new application (Ping function is configable setting)",
"Dispatch": "Role ID for Dispatch role to be pinged for new application (Ping function is configable setting)"
},
"application_questions": {
"Police": ["PD Question 1", "PD Question 2", "PD Question 3", "Question 4"],
"Sheriff": ["Sheriff Question 1", "Sheriff Question 2", "Sheriff Question 3"],
"State": ["State PD Question 1", "State PD Question 2", "State PD Question 3", "Question 4", "Question 5"],
"Fire": ["Fire Question 1", "Fire Question 2"],
"Dispatch": ["Dispatch Question 1", "Dispatch Question 2", "Dispatch Question 3"]
}
}
{
"prefix": "",
"token": "",
"bot_setup": {
"server_name": "",
"bot_status": "",
"bot_game_type": "",
"bot_game": ["", "", ""],
"main_embed_color": ""
},
"settings": {
"department_names": ["", "", "", "", ""],
"apps_open_dep_number": "",
"apps_closed_dep_number": "",
"owners": [""],
"all_app_logs": true,
"notice_ping": true,
"department_status_use": true,
"enable_logo": true,
"restrict_cmd_channel": true,
"preAppMSG": true,
"DMAppLink": false,
"depHead_see_apps": true
},
"department_status": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"department_info": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"department_aplicantMSG": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"department_appLink": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"department_logo": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"department_colors": {
"police": "",
"sheriff": "",
"state": "",
"fire": "",
"dispatch": ""
},
"channel_ids": {
"hiringCMD": "",
"app_category": "",
"all_app_logs": "",
"Police": "",
"Sheriff": "",
"State": "",
"Fire": "",
"Dispatch": ""
},
"role_ids": {
"staff": "",
"depHead": "",
"Police": "",
"Sheriff": "",
"State": "",
"Fire": "",
"Dispatch": ""
},
"application_questions": {
"Police": ["", "", "", ""],
"Sheriff": ["", "", "", ""],
"State": ["", "", "", ""],
"Fire": ["", "", "", ""],
"Dispatch": ["", "", "", ""]
}
}
{
"purple_dark": "#6a006a",
"purple_medium": "#a958a5",
"purple_light": "#c481fb",
"orange": "#ffa500",
"gold": "#daa520",
"red_dark": "#8e2430",
"redlight": "#f94343",
"blue_dark": "#3b5998",
"cyan": "#5780cd",
"blue_light": "#ace9e7",
"aqua": "#33a1ee",
"pink": "#ff9dbb",
"green_dark": "#2ac075",
"green_light": "#a1ee33",
"white": "#f9f9f6",
"cream": "#ffdab9"
}