Issue Files

Information

CSSS uses JSON files for checking any "issues" with the computer. These issue files are stored in the Issues directory (and relevant subdirectories) in the CSSS root directory. If you do not want to perform an issue check category, the relevant file can be deleted from the Issues directory and the check will be skipped.

Once you have created an issue check file, run CSSS with the "-c" parameter to lint the files to make sure that they are formatted correctly, then run CSSS with the "-o" parameter to check things are working as expected.

Issue File Format

Full Example

The JSON files should all look like the following example to allow CSSS to parse them:

{
    "Category": "issues.system.version",
    "SupportedOS": "all",
    "Issues": [
        {
            "Description": "The Operating System has been updated to the latest version",
            "Points": 5,
            "Triggered": false,
            //_Relevant_issue_check_values_here
        },
        {
            "Description": "The Operating System has been updated to one against company policy",
            "Points": -10,
            "Triggered": false,
            //_Relevant_issue_check_values_here
        },
        {
            //_Additional_checks_for_this_issue_category
        }
    ]
}

Breakdown

The different name-value items that required for CSSS to understand the JSON files are listed here:

Category

This is the category that the issue file is part of. It should be the reverse of the name of the file, without the extension (e.g. the file name here is "Version.System.Issues.json")

"Category": "issues.system.version"

SupportedOS

This may be removed in a future version. The values here are the Operating Systems the checks run on, which is currently "all"

"SupportedOS": "all"

Issues

These are the list of issues that are to be checked for this issue category, in a JSON array

"Issues": [
    {
        //_Issue_check_sections
    }
]

Description

The description is shown to the competitor to let them know that issues they have solved

"Description": "The Operating System has been updated to the latest version"

Points

Either a positive or negative integer and the amount of points the competitor will receive. If it is positive it is an issue to be resolved, if it is a negative it is a penalty issue (e.g. deleting a file that shouldn't have been)

"Points": 5

Triggered

This is used internally by CSSS to see if the issue has already been triggered, to prevent constant notifications to the user, and to let them know a penalty has been resolved or they lost points for something already "fixed"

"Triggered": false

Relevant Issue Check Values Here

Please see the relevant issue check file wiki page for the name-value pairs to put here