Reference

Event patterns

Content type: eventPatterns
Files: data/events/patterns.json, data/events/patterns/
Shape: A list of records, each with its own id
Patch target: eventPattern:<id>, for example eventPattern:core.pattern.regional-open
In the base game: 2 records
Guide: Nations

Fields#

Indented fields belong to the field above them. [] marks the items of a list. A field that is not required may be left out; the default is used.

Field	Type	Required	Default	Notes
`id`	id	Yes		Namespaced id, e.g. "core.player.rory-calder"
`level`	one of the options	Yes		Options: `local`, `circuit`.
`names`	list, 1 to 40 items	Yes
`shortNames`	list, 1 to 40 items
`venueNames`	list, 1 to 40 items	Yes
`venueKind`	text, up to 30 characters		`"hall"`
`venueHostility`	number, 0 to 1		`0.3`
`venueConditions`	number, 0.5 to 1.5		`1`
`months`	list, 1 to 12 items	Yes
`weeks`	list, 1 to 5 items		`[1, 2, 3, 4]`
`days`	whole number, 1 to 7		`1`
`fieldSize`	whole number, 2 to 512	Yes
`rounds`	list, at least 1 item	Yes
`rounds[]`	one of several shapes	Yes
Shape 1 (with `bestOfLegs`)
`rounds[].bestOfLegs`	whole number, 1 to 41	Yes
`rounds[].tieBreak`	object
`rounds[].tieBreak.winBy`	whole number, 2 to 3	Yes
`rounds[].tieBreak.suddenDeathAt`	whole number, 1 to 30
Shape 2 (with `bestOfSets`)
`rounds[].bestOfSets`	whole number, 1 to 13	Yes
`rounds[].legsPerSet`	whole number, 3 to 9		`5`
`rounds[].decidingSet`	object
`rounds[].decidingSet.winBy`	whole number, 2 to 3	Yes
`rounds[].decidingSet.suddenDeathAt`	whole number, 1 to 30
`minAge`	whole number, 10 to 99
`tags`	list		`[]`
`tourCard`	true or false
`residents`	true or false
`ranked`	true or false		`false`
`tv`	true or false		`false`
`bands`	list, 1 to 9 items	Yes
`bands[].cap`	whole number, 0 to 20	Yes
`bands[].prizes`	list, at least 1 item
`bands[].crowd`	number, 0 to 1
`bands[].fieldSize`	whole number, 2 to 512
`bands[].entryFee`	whole number, at least 0
`bands[].maxLevel`	number, 0 to 100
`bands[].capacity`	whole number, 10 to 50,000

Example#

A record from the base game’s data/events/patterns.json, shortened.

{
  "id": "core.pattern.regional-open",
  "level": "local",
  "names": [
    "{city} Open",
    "{city} Classic",
    "{city} Weekend Open",
    /* … 5 more */
  ],
  "shortNames": [
    "{city} Open",
    "{city} Classic",
    "{city} Weekend",
    /* … 5 more */
  ],
  "venueNames": [
    "{city} Leisure Centre",
    "{city} Sports Hall",
    "{city} Social Club",
    /* … 2 more */
  ],
  "venueKind": "hall",
  "venueHostility": 0.25,
  "venueConditions": 1,
  "months": [
    2,
    3,
    4,
    /* … 5 more */
  ],
  "weeks": [
    1,
    2,
    3,
    /* … 1 more */
  ],
  "days": 1,
  "fieldSize": 32,
  "rounds": [
    {
      "bestOfLegs": 5
    },
    {
      "bestOfLegs": 5
    },
    {
      "bestOfLegs": 5
    },
    /* … 2 more */
  ],
  "minAge": 16,
  "tags": [
    "local"
  ],
  "tourCard": false,
  "residents": true,
  "ranked": false,
  "tv": false,
  "bands": [
    {
      "cap": 0
    },
    {
      "cap": 1,
      "prizes": [
        150,
        75,
        /* … 4 more */
      ],
      "crowd": 0.12,
      "entryFee": 10,
      "maxLevel": 56,
      "capacity": 120
    },
    {
      "cap": 2,
      "prizes": [
        250,
        120,
        /* … 4 more */
      ],
      "crowd": 0.16,
      "entryFee": 10,
      "maxLevel": 58,
      "capacity": 150
    },
    /* … 2 more */
  ]
}

In your pack the record’s id starts with your pack’s id instead of core, unless you mean to replace this one.

Written for Darts Player Simulator 0.50.32. Built from the game's own schemas and its base pack.