Sitreps - massif-press/lancer-data GitHub Wiki

Overview

Adds additional preset SITREPs in the Encounter Builder. These must be stored under a file named sitreps.json that contains a single array of sitrep data objects:

Definition

sitreps.json

[
  {
    "id": string,
    "name": string,
    "description": string,
    "deployment"?: string,
    "objective"?: string,
    "extraction"?: string,
    "conditions"?: { title: string, condition: string }[]
  },
  ...
]

Required Fields

id

Internal identifier. This must be globally unique. See Item ID Guidelines for more information.

name

The display name of the item

description

Detail and rules text. HTML syntax is allowed.

Optional Fields

deployment

Optional deployment rules or details. HTML syntax allowed.

objective

Optional objective rules or details. HTML syntax allowed.

extraction

Optional extraction rules or details. HTML syntax allowed.

conditions

Optional additional rules, details, clarifications, etc. Conditions are in the following format:

{
  "title": string,
  "condition": string
}

title

The title of the condition.

condition

Condition detail or rules text.

Example

from lancer-data/lib/sitreps.json

  {
    "id": "sitrep_escort",
    "name": "Escort",
    "description": "ESCORT missions require the PCs to bring an OBJECTIVE safely to the Extraction Zone and get the hell out of there.",
    "pcVictory": "The Objective is safely extracted.",
    "enemyVictory": "The Objective hasn’t been extracted at the end of the eighth round. If there are any PCs remaining on the field when this takes place, they are captured or overrun.",
    "noVictory": "The Objective is destroyed.",
    "deployment": "The PCs deploy first, choosing positions for their characters and the Objective in the Allied Deployment Zone; then, the GM deploys enemy forces in the EDZ.",
    "extraction": "While in the Extraction Zone, PCs can extract as a free action at the end of their turn. Extracted PCs are removed from the battlefield. If the Objective is adjacent to a PC when they extract and isn’t contested by any characters from the opposing side, it is safely extracted."
  },