Bot Configuration
This is the third step in configuring True Sheets, this guide assumes you have already completed step one & two.
Last updated
Was this helpful?
This is the third step in configuring True Sheets, this guide assumes you have already completed step one & two.
Last updated
Was this helpful?
Inside your guild that you want to configure the bot with run the command /config
. The fields in the configuration are exampled in-depth below.
callsign_logs
- The channel where callsign changes, assignments, demotions and promotions will be logged.
admin_logs
- The channel where all administrative changes will be logged, including configuration changes and department changes.
callsign_admin
- A role that all allows all users with it to manage, assign, promote and demote users in any department.
spreadsheet_id
- Your google sheets spreadsheet ID, this is found in your spreadsheets URL. To find this, load up your spreadsheet in a browser and gather the ID from the URL like the following.
True Sheets works with a list of departments, separated by individual sheets inside your spreadsheet. To create a department you must first go to your callsign sheet and create a new sheet with your department name (E.g: If the sheet name is "Law Enforcement", your department name should be "Law Enforcement"). Make sure you follow the correct sheet format as described in the Setting Up Spreadsheet page.
Once a new sheet has been created use the command /add_department
to add a department to your guild. The fields are described below in-depth.
name
- The department name (Must be the same as your sheet name)
base_role
- The department base role (The role that all members in the department have, not the starting role, but a role with a name such as Law Enforcement or Civilian)
starting_role
- The role as position 0 of your department ranking structure, also known as the starting role. This will act as the lowest possible role in your department.
starting_row
- The complimentary starting row name/value inside the callsign sheet (The row name is the the value entered under Rank in the callsign sheet)
You can add multiple different ranks into a department that automatically increase from the lowest value up, once creating a department you will only have 1 rank, the starting ranks. To add more ranks after that stage you will need to use the /add_rank
command, keep in mind that the next rank you add should be the next highest after the starting rank (E.g: If the starting rank is Probationary Officer, the next rank would be Officer I). The add_rank command fields are described below.
department_id
- The ID of the department you are adding this rank to (Can be found view either /view_department
or in the admin logs)
role
- The ranks role inside discord.
row
- The ranks row name in the callsign sheet.
To proceed further and get more information about commands and features view the page below.