Configuring the Jobs System

  • [config]

To configure the Jobs plugin:

  1. Select Admin -> Setup.
  2. Edit jobs.yml


Job categories are created with in-game commands. You can set up in-game category colors and access roles using the game commands. See help manage jobs for details.

To customize the web portal category colors, you’ll need to use a custom CSS style. For example:

.job-category-REQ {
    background-color: purple;
    color: white;


You can set the category used for player requests. By default it’s the REQ category.


You can also configure which job category is used when the system creates a job for a suspect or boot alert. By default it’s the ALERT category.


You can set the job category used for various system jobs, like XP notices. By default it’s the SYS category.


The status values define your workflow. The default workflow is:

NEW -> OPEN -> HOLD (if necessary to pause a job) -> DONE -> ARCHIVED

You can add more status steps to your workflow.

Status Color

You can also set a color for each job. This can be changed at will. For example, NEW jobs are green by default:

        color: "\%xg"

This color config is only used in-game. To customize the web portal status colors, you’ll need to use a custom CSS style. For example:

.job-status-NEW {
    background-color: yellow;
    color: black;

Special Status Values

The jobs system has two special status values:

  • default_status - This is the status that all brand new jobs are first assigned. “NEW” by default.
  • open_status - This is the status that jobs go to when they are opened. “OPEN” by default.
  • archive_status - This is the status that jobs go to when archived. “ARCHIVED” by default.
  • active_statuses - This is a list. Jobs with these status values show up in the ‘Active’ jobs filter.
  • closed_statuses - This is a list. Jobs with these status values are assumed to be closed and do not show up on the current jobs list. You need to use the jobs/all command to see them. Includes “DONE” and “ARCHIVED” by default.

Status Filters

There are several built-in status filters, like “ACTIVE”, “UNREAD” and “ALL”. You may wish to define others depending on your status configuration. Status filters consist of a name and a list of statuses included in that filter.

For example, we might want a ‘TODO’ filter for jobs that are new or on hold:

  - NEW
  - HOLD


You can set up canned responses or response templates for your jobs. Each is given a name (shown on the list to choose from) and the template text (which may contain ansi and other format codes - just be sure to properly escape any special characters to avoid a YAML processing error).

- name: Received
  text: Your job has been received. We'll get to it soon.
- name: Plot Approved
  text: "Your plot is wonderful. Go for it."

archive_job_days and archive_cron

Jobs are automatically archived a certain number of days after they’re closed. Archived jobs are not included in the basic jobs list, but can still be searched. The delay between closing and archiving gives other staffers a chance to read the final job comment.

You can configure how long to wait before closing the job, and also configure the cron job for when the job archiving happens (by default weekly). See the Cron Job Tutorial for help if you want to change this.