FiveUnityManual

Departments

Departments let your in-character services (Police, EMS, Fire, DOJ) track duty time with /clock in and /clock out, and let members ask for a department role instead of chasing staff in DMs.

Note

Where: Dashboard โ†’ Roleplay โ†’ Departments ยท In Discord: /setup โ†’ Departments

#How it works

A department is a name plus up to three settings: who may clock in, which role marks them as on duty, and where the shift is logged. When a member clocks in, FiveUnity adds the on-duty role and starts a shift. When they clock out, the shift is closed and the length is saved for reporting.

A member can only have one open shift at a time, across every department. If they leave the Discord server while clocked in, the shift is closed for them automatically.

#Create a department

Fill in Create department and press Create department. Creating your first one switches the departments module on.

SettingWhat it does
NameDisplay name, up to 80 characters. Must be unique in the server.
Member roleWho is allowed to clock in for this department. Leave it on Anyone and every member can.
On-duty roleAdded on clock-in and removed on clock-out. Leave it on Use server default to fall back to the module default.
Log channelWhere clock-in and clock-out embeds are posted. Empty falls back to the module default.
Warning

FiveUnity needs Manage Roles, and its own role must sit above the on-duty role in Server Settings โ†’ Roles. If it does not, clocking in still records the shift but the reply carries a Role Warning instead of the role.

#The Departments list

Every department appears as a row with an enabled or disabled badge, its log channel, and a one-line summary such as "Police Officer can go on duty as On Duty."

  • Toggle a department off to pause clock-ins without losing anything. Members already clocked in stay clocked in and can still clock out; nobody new can clock in until you switch it back on.
  • Delete removes the department. The Discord roles stay exactly as they are: deleting the department does not touch anybody's roles.

#Module defaults

Two fallbacks live on the Modules page, under Departments module defaults, so departments that do not set their own still work.

SettingWhat it does
Departments module enabledMaster switch. Off, /clock in refuses to run for every department.
Default on-duty roleUsed by any department whose On-duty role is left empty.
Fallback log channelUsed by any department whose Log channel is left empty.

See Modules and utilities.

#Clocking in and out

CommandWhoWhat it does
/clock in [department]MembersStarts a shift. The department option autocompletes to the enabled departments you are eligible for. Leave it out and FiveUnity picks for you when you belong to exactly one.
/clock outMembersEnds the current shift and saves the length.
/clock status [department]MembersLists everyone clocked in right now, grouped by department, with how long each has been on.
/clock log viewStaffStored department hours, filtered by user, department and period (Last 7 Days, Last 30 Days, All Time). Shows totals and the top 15 members.
/clock log forceout user:StaffClocks someone else out of their active shift and saves it.
/clock log reset confirm:True [department]StaffWipes stored records for one department or all of them.

Replies to /clock in, /clock out and /clock status are only visible to the person who ran them.

Danger

/clock log reset permanently deletes the stored shifts. Before deleting, FiveUnity posts a summary to the department log with the totals and the leaderboard as they stood, so you keep a record. Any active shifts are ended and the on-duty role is removed.

#Staff duty is a separate clock

/duty is the staff clock: it toggles a staff member on and off duty and writes to the staff log. /dutylog [user] [period] pages through those staff sessions. The Duty column in Staff metrics counts /duty hours, not department shifts. See Staff. Department hours are reported with /clock log view. Both systems can run side by side.

#Role requests

Members press a button (or run /rolerequest) to ask for a department role. Staff approve or deny from a review channel.

#Set it up

  1. Under Add a requestable role, pick the Role, give it a Button label, and press Add role. Up to 25 roles.
  2. Optionally set an Approver role for that role, and tie it to a Department.
  3. Choose a Review channel; this is where the Approve / Deny buttons are posted.
  4. Choose a Panel channel and press Post panel.
SettingWhat it does
Role requests enabledMaster switch for the feature. Adding a role or posting the panel turns it on.
Review channelWhere requests land for staff. A role with its own review channel overrides this.
Panel channelWhere Post panel publishes the button panel.
Wait after a denial (hours)How long a denied member waits before asking for the same role again. 0 turns it off, up to 720 (30 days). Quick picks: Off, 1 day, 3 days, 7 days.
Button labelThe text on the panel button, up to 80 characters. Also the name in /rolerequest autocomplete.
Approver roleA role that may approve or deny this request on top of your normal staff permissions.
Department (optional)Records which department the request belongs to.

#What members see

The panel is an embed titled Role requests with one button per requestable role. Pressing one submits a request. FiveUnity refuses it if the member already has the role, already has a pending request for it, or is still inside the deny cooldown, and it tells them when they may try again.

#Approving and denying

The request is posted to the review channel with the member, the role, and Approve / Deny buttons. A decision can be made by anyone holding the rolerequests permission, by anyone holding the setup permission, by anyone holding that role's Approver role, and always by Discord Administrators and the server owner.

Most servers use the Approver role on each requestable role, because that is the one that needs no permission work at all. On the default ladder, rolerequests is handed out from the Moderator step upwards, so a Moderator can approve without any extra setup; tick it onto a Support group if you want the ticket desk handling requests too. See Permissions.

On approve, FiveUnity adds the role: same Manage Roles and role-order rules as above. Either way the review message is updated in place: the colour changes, the buttons disappear, and the footer records who decided. The decision is also written to your server logs.

#Tips

Tip

Give each department its own log channel and give the shared fallback to a quiet staff channel. Busy departments then keep their clock traffic out of everyone else's way.

Tip

Use one Member role per department and make that same role requestable. New members then request the role from the panel, and the moment it is approved they can /clock in.