- Documentation
- 02Day to day
Citizens
The file of your server’s characters, and the record that brings together their identity, criminal record, vehicles, weapons and files.
The Citizens module is the file of your server’s characters. It’s shared across the whole organization: the police, the medical service and the justice department look at the same file, and each one only sees the sections their rank gives them access to.
The list
Section titled “The list”Citizens are sorted by last name. Each row shows the photo (without one, your organization’s default image or a neutral silhouette; the initials if the Photo field is hidden), the last name first then the first name, the date of birth and the age, worked out in your organization’s time zone. Two badges can be added:
- Wanted: the citizen is the subject of an active warrant;
- Deceased: the citizen is marked as deceased; their row is also dimmed.
Click a row to open the file.
Searching
Section titled “Searching”The Search citizens field filters as you type, by first name, last name, phone or date of birth. For a phone, type the full number or its beginning, with or without dashes or spaces (“555-0177”, “5550177”, “555-01”): only the files whose number matches are shown. Accents and capitals don’t matter. The Clear search cross empties the field.
Show more
Section titled “Show more”The list loads 25 citizens at a time. The footer tells you how many are shown (“25 citizens shown”) and, if there are more, the Show more button loads the next 25.
Creating a citizen
Section titled “Creating a citizen”- Click New citizen, at the top right of the list.
- If you have one, add the Photo: drop the image on the area, click Add a photo or paste it with Ctrl+V (see Photos).
- Fill in at least the First name and Last name (up to 40 characters each).
- If you know them, add the Date of birth, the Gender (Male, Female, Other or Not specified) and the Phone.
- Notes hold distinguishing marks, habits, anything useful to officers.
- Fill in the Additional information, if there is any.
- Click Create file: the new citizen’s file opens.
The Additional information is the fields you added to the Citizen record in Forms: a blood type, distinguishing marks, a license… They’re grouped under their sections, and required fields must be filled in to create the file.
The base fields themselves (photo, first name, date of birth…) may have another name on your server, and the optional ones may be hidden: that’s set in Forms › Base fields.
A citizen’s file
Section titled “A citizen’s file”The identity column
Section titled “The identity column”On the left, the file shows:
- the ID photo, the name, age and gender, with the Wanted and Deceased badges when they apply;
- a summary: the number of active warrants, the total of unpaid fines and the total jail time;
- the Born, Gender, Phone and File created details;
- the status button (Alive or Deceased), and the Edit and Delete file buttons.
These buttons are always there. Without the matching permission, they stay visible but locked, with a small padlock and a “Restricted: …” hint naming the permission to ask for (for example “Restricted: Citizens › Delete a citizen”); see Permissions.
Citizens at the top of the column takes you back to the list.
The warrant alert
Section titled “The warrant alert”When the citizen is the subject of an active warrant, a banner shows above the tabs: Active arrest warrant (or Active search warrant), with the reason, the date, who issued it and, if it has one, its expiry date. An arrest warrant always comes first; if there are others, the banner says so. View warrants opens the Warrants module.
The tabs
Section titled “The tabs”The rest of the file is organized in tabs. The number of items shows next to the tab’s name. From the keyboard, the left and right arrows move from one tab to the next.
Each tab only appears if you’re allowed to see what’s in it (a tab you can’t read is hidden, not locked):
| Tab | What it shows | Permission needed |
|---|---|---|
| Overview | identity, additional information, notes | nothing more |
| Record | their offense files and fines | Records & fines › See records and files |
| Vehicles | vehicles in their name | Vehicles › See vehicles |
| Weapons | weapons in their name | Weapons › See weapons |
| Reports | the operations where they are a suspect | nothing more (the content is filtered) |
| Warrants | all their warrants | Warrants › See warrants |
| BOLOs | the BOLOs targeting them | BOLOs › See BOLOs |
| Medical | their medical visits | Medical records › See medical records |
| Complaints | the complaints where they are the complainant or the accused | Complaints › See complaints |
| Licenses | their licenses read in game (game character, “Licenses” integration on) | Licenses › See licenses |
| Properties | their homes read in game (game character, “Character properties” integration on) | Properties › View properties |
| Tag | their electronic tag and past tags (game integration, Electronic tags module on) | Electronic tags › View tags |
| Documents & evidence | the documents issued for them and the evidence linked to them | nothing more (each block follows its own rights) |
| Player | the character’s game account and its other characters | Players › See game accounts |
The same rule applies to the summary: active warrants only show with access to warrants, fines and jail time only with access to criminal records. Permissions are set in Ranks and permissions; the full catalogue is in Permissions.
When the tabs don’t fit on one line, the overflowing ones move to the More menu, at the right of the bar; the open tab always stays visible.
Tabs show 8 items first; Show more adds the next ones, and the counter tells you where you are (“8 of 12”).
Overview
Section titled “Overview”The Identity (first name, last name, date of birth and age, gender, phone, status), then the Additional information that has been filled in (empty fields are hidden) and the Notes.
Record
Section titled “Record”The Criminal record lists the citizen’s offense files, newest first. Each file gives its number, type, date of the offense and legal status, then its offenses: code, label, level, computation details (quantity, degree), notes, Fine with its state (Unpaid, Paid or Cancelled) and Jail. A line of a file still awaiting review shows “Not on the record yet”. The Unpaid total shows at the top of the tab; files load page by page, with Show more. Sentences are written in the penal code’s unit (minutes or months), and a file being served shows its cell time left (or “Cell time over”, or the cell placement time to fill in): see Procedure times and cell time. The summary badge under the name adds up the record’s sentences per unit.
citizen-sheet-filesClicking a file opens its page. With the Records & fines › Create an offense file permission, the New file button opens the offense file window, with this citizen already picked. All the details are in Offense files and fines.
Vehicles and Weapons
Section titled “Vehicles and Weapons”The vehicles in their name (model, plate, colour and status) and the weapons in their name (model, serial number and status). A click opens the vehicle’s or weapon’s record: see Vehicles and weapons.
Reports
Section titled “Reports”The operations where this citizen is a suspect, newest first: number, title, date, service and state (In progress, Writing, Submitted, Approved or Rejected). A click opens the operation.
citizen-sheet-operationsYou only see operations from services where you have Operation reports › See all operations, plus the ones you took part in or opened.
Warrants
Section titled “Warrants”All of the citizen’s warrants, active ones first: type (Arrest warrant or Search warrant), state (Active, Executed or Cancelled), reason, address for a search warrant, issue date and author, expiry date of an active warrant. Warrants are issued and closed from the module: Open the Warrants module (see Warrants and BOLOs).
The BOLOs targeting this citizen, active or Resolved. They are issued and resolved from the module: Open the BOLOs module (see Warrants and BOLOs).
Medical
Section titled “Medical”Medical visits, newest first: date, title, procedures performed, author, total and payment state (Paid or Due). The tab is read only: visits are entered from the medical module (see Medical records).
Complaints
Section titled “Complaints”The citizen’s complaints, picked with the Citizen’s role switch: Complainant (the ones they filed) or Accused. With Complaints › Record a complaint, the Record a complaint button records one with this citizen already chosen. See Complaints.
Properties, Tag
Section titled “Properties, Tag”For a game character: Properties shows their homes read in game, read-only (see Properties); Tag shows their current electronic tag and the previous ones (see Electronic tags).
Documents & evidence
Section titled “Documents & evidence”Two blocks: Issued documents (the documents issued for this citizen, and Issue a document when a template fits: see Documents) and Evidence (the evidence linked to this citizen: see Evidence).
The ID photo
Section titled “The ID photo”citizen-editWith the Citizens › Edit a citizen permission, buttons show on the photo, at the top of the file:
- Add a photo (or Change photo): pick a PNG, JPEG or WebP image of 5 MB at most;
- Remove photo: the file shows your organization’s default image again, or a neutral silhouette if there isn’t one.
The photo can also be changed in Edit, where you can drag and drop the image, paste it (Ctrl+V, or Cmd+V on a Mac), Replace it or Remove it. Clicking the photo enlarges it in the viewer (Escape to close). In the in-game tablet, if your server turned it on, Take an in-game photo photographs the character directly with the game camera.
The photo also shows in the list and in citizen pickers. If your organization hid the Photo field, it shows nowhere, but photos already uploaded are kept. All the details (formats, default image, viewer) are in Photos.
Editing a file
Section titled “Editing a file”Edit (Citizens › Edit a citizen permission) opens the same panel as for creation, prefilled: identity, custom fields, notes and photo. It adds the Status: Alive or Deceased, which can only be changed with Citizens › Change status (otherwise the choice stays locked). Click Save; changes are visible right away to all your services.
Recording a death
Section titled “Recording a death”The status has its own permission, Citizens › Change status, and its own button on the file: a rank can record a death without being able to edit the identity, and the other way round. Set the Status to Deceased, from the file’s Status picker or in Edit. The file keeps its whole history; it carries the Deceased badge and its row is dimmed in the list. Set it back to Alive to undo.
A game character
Section titled “A game character”With the game integration, each character becomes a citizen file, with the Game badge. Their first name, last name, date of birth (and phone, if it comes from the game) are read-only for everyone, owner included: a lock and “Synced from the game” recall it, and only the game changes them. Gender, status, notes, photo and custom fields stay editable.
While the game integration is on, the lock stays. If it is turned off, the file of a character that came from the game offers Detach from the game (press-and-hold button, releasing cancels), with the Citizens › Detach from the game permission (command by default; before, administrators only): the file becomes fully editable, shows the “Detached from the game” badge, and the game will never update it again, even if the integration is turned back on. Detaching is written to the audit log.
The Licenses and Player tabs
Section titled “The Licenses and Player tabs”Two tabs are added for game characters, each with its specific permissions (set under the Citizens row of the matrix, only visible when the game integration is on):
- Licenses: licenses read in game (driver’s license, weapon permit…), valid or revoked, with the latest changes. Revoke (press-and-hold button, Licenses › Revoke permission) and Give back (Licenses › Restore permission) require a Reason; the change is sent to the game, waits for the character to log in if needed, and is logged. The tab only exists if the “Character licenses” integration is on in Settings › Game (see Licenses).
- Player: the game account linked to the character (Open player sheet leads to its identifiers, masked without the permission to see them in full) and Their other characters. Link to a player, Change player and Unlink (press-and-hold button) change the link (see Accounts and characters).
These permissions are detailed in the Who can do what table below. Administrators always have them.
Deleting a file
Section titled “Deleting a file”Hold the Delete file button down (about a second, or Space / Enter from the keyboard; letting go cancels). There is no confirmation dialog. You’re taken back to the list.
Deletion is soft: the file disappears from the list and from searches, but isn’t erased. Operations that named the citizen keep the name, marked “Deleted record”. The action is written to the audit log, like creation and edits.
Who can do what
Section titled “Who can do what”Citizens are shared across the organization: your permissions on Citizens count in all your services where the module is enabled. Each action has its own specific permission, set rank by rank in Ranks and permissions. An action you’re not allowed to do stays visible but locked, with a padlock and a “Restricted: …” hint (see Permissions).
| Permission | What it allows | Default |
|---|---|---|
| Citizens › See citizens | open the module, search, read files | every rank |
| Citizens › Create a citizen | New citizen, and creating from a picker | members and up |
| Citizens › Edit a citizen | Edit: identity, custom fields, notes and photo | members and up |
| Citizens › Change status | record a citizen as Deceased or set them back to Alive | members and up |
| Citizens › Delete a citizen | Delete file | supervisors and up |
| Citizens › Detach from the game | Detach from the game a record that came from the game, when the integration is off | command |
| Licenses › See licenses (game) | the Licenses tab | every rank |
| Licenses › Revoke (game) | Revoke a license, with a reason | supervisors and up |
| Licenses › Restore (game) | Give back a revoked license, with a reason | supervisors and up |
| Players › See game accounts (game) | the Player tab, player pages and search (identifiers masked) | command |
| Players › See full identifiers (game) | unmasked license, Discord and FiveM IDs | command |
| Players › Link a character (game) | link, change or unlink the player | command |
| Properties › View properties (game) | the Properties tab | every rank, in police and justice departments |
Permissions marked (game) only show in the matrix when the game integration is on. “Default” is the first rank level that gets it when you create a service from a template.