> ## Documentation Index
> Fetch the complete documentation index at: https://help.crab.tropicalsys.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Shift Management

> Easily log your department personnel's shifts with our shift logging system!

## Configuration

To begin the configuration, please open the dropdown menu and select **"Shift Management"**.

<Tabs>
  <Tab title="Configure Shift Logging">
    The **Shift Logging** configuration will have you select the channel to which all logs will be sent in regards to the shift management within your department.

    To configure this, simply select the select menu that says **"Shift Logging"** when the **Shift Management** configuration embed has appeared. Then, select the channel you wish to use as your shift logging channel.
    <Tip>If you cannot see the channel you are looking for, try typing it in. Discord limits the amount of channels displayed on the select menu dropdown.</Tip>
  </Tab>

  <Tab title="Configure Shift Roles">
    The **On Duty** and **On Break** configuration dropdowns will allow you to select **one** role to set as your **On Duty** role and your **On Break** role which will automatically set hthe roles based on the current shift status.

    To configure the **On Duty** role, select the dropdown menu that displays the text **"On Duty Role"**. Once you have selected it, now select which role you wish to set as the role to be added when the user is **On Duty**.

    To configure the **On Break** role, select the dropdown menu that displays the text **"On Break Role"**. Once that is selected, now choose which role you want to set as the role to be applied when the user is **On Break**.
    <Tip>If you cannot see the role you are looking for, try typing it in. Discord limits the amount of roles displayed on the select menu dropdown.</Tip>
  </Tab>

  <Tab title="Configure Shift Types">
    The **Shift Types** configuration will set the shift types you wish to add to your server. When a department personnel member selects a shift type, it will only allow them to select the shift types that are currently active within your department.

    To configure which **Shift Types** you want to allow, please open the dropdown menu. Once you have opened it, you will see four (4) options: **"Patrol, SWAT, Internal Affairs, Detective"**. Select which of the four (4) options you want to allow. If you do not select any, no shift types will be configured.
  </Tab>
</Tabs>

## Using the Module

| Command         | Description                                                           |
| --------------- | --------------------------------------------------------------------- |
| `/shift manage` | Allows department personnel to manage their shift                     |
| `/shift active` | Displays online and on break personnel.                               |
| `/shift admin`  | Allows department High Commanders to manage other personnel's shifts. |

### Using `/shift manage`

When you type in the command `/shift manage`, you will get an **optional** option to select a shift type. You can choose **one** shift type from the list provided. If your department doesn't allow the shift type you selected, the command will not allow the shift type to be selected.
<Tip>If you do not select a shift type, it will set the shift type to **Default**.</Tip>

### Using `/shift active`

When you run the command `/shift active`, it will display two embeds: one for **Active Personnel** and one for **On Break Personnel**. It will display all personnel that are either **On Duty** or **On Break** in their respective embed.

### Using `/shift admin`

When you run the command `shift admin`, it will output an embed with the option to select a user. When you select a user, and if the user has a department personnel role, it will display another embed that will allow you to manage their shift in many ways. Those ways being:

> * **Edit Shift Time**
> * **Remove a Shift**

<Warning>Each Sunday, all shifts are cleared. We are planning on adding customization for this in the coming weeks.</Warning>

### Using `/shift leaderboard`

When you run the `/shift leaderboard` command, you will find an output which outputs all shifts and will display how long each user has been on shift.