exile.watch docs
  • Introduction
  • The Maven - exile.watch context
  • Projects
    • hideout
    • crucible
      • Contributing
    • writ
      • Contributing
    • splinters
      • Contributing
      • @exile-watch/vite-config
      • @exile-watch/biome-config
      • @exile-watch/typescript-config
      • @exile-watch/unit-testing-config
      • @exile-watch/lefthook-config
    • nucleus
      • Contributing (data)
        • Encounter token breakdown
      • Contributing (scripts)
        • Scripts definition
      • @exile-watch/encounter-data
      • @exile-watch/seo
    • malachai
      • Contributing
      • snap gyazo thumbnail
    • doryani
      • Contributing
      • Actions
        • Authenticate to GitHub Package Registry
        • Install npm dependencies
        • Code quality assurance
        • Deploy webapp
        • Publish package
        • Preview publish package
        • Preview deploy webapp
  • voidstone
    • Contributing
  • Development
    • Commit message guidelines
    • Prerequisites
    • Generating GitHub PAT
    • .npmrc file
  • Architecture
    • Dependencies
    • Tech stack
    • Adoption chart
    • GHA workflows web
  • Legal
    • License - FSL, Apache 2.0
    • Non-Affiliation Notice
    • Code of Conduct
    • Privacy Policy
Powered by GitBook
On this page
  • API
  • YAML example
  • Common tokens

Was this helpful?

  1. Projects
  2. nucleus
  3. Contributing (data)

Encounter token breakdown

PreviousContributing (data)NextContributing (scripts)

Last updated 1 year ago

Was this helpful?

API

key
necessity
type
description
Example

map

optional

string

Map name. In case there is no map for the boss (see: conquerors or elder guardians) then this field is ommited

Coves

bosses

required

string

Boss name.

Can be multiple

Telvar, the Inebriated

type

optional

string[]

List of ability damage types.

physical, fire

abilities

required

string[]

List of boss abilities

Spawn Barrel, Tar

tip

required

string[]

List of Player Interactions to given Ability. yml brackets have the same role as dashes.

dodge, kill new spawns

gif

required

string

Video source. Currently all of the sources are hosted from http://gyazo.com/

about

required

string[]

About ability list. Wrap each sentence with double quotation marks (""). In future we may enhance those strings.

Every couple seconds Telvar throws Barrel at player's position

isChallenge

optional

boolean

Marks ability as League Challenge

true, false

aboutChallenge

optional

string[]

About League Challenge

Defeat Lycius, Midnight's Howl in Lair Map while he is channeling Wolf Barrage

YAML example

map: Coves
bosses:
  - Telvar, the Inebriated:
      abilities:
        - Spawn Barrel:
            tip: [ destroy ]
            gif: https://i.gyazo.com/20b4ddbade91f264d18ba8c304d9a19a.mp4
            about:
              - "Every couple seconds Telvar spawns a Barrel at random position"
              - "Once destroyed leaves a pool of Tar"
        - Tar:
            tip: [ move out ]
            gif: https://i.gyazo.com/22602b30cc9cf622a91f1a0c371477d6.mp4
            about:
              - "Being in Tar slows your movement"
        - Throw Barrel:
            type: [ physical ]
            tip: [ dodge ]
            gif: https://i.gyazo.com/279f86d6f8652e9708cde4a80276223c.mp4
            about:
              - "Every couple seconds Telvar throws Barrel at player's position"
        - Alchemy Orb:
            type: [ fire ]
            gif: https://i.gyazo.com/22602b30cc9cf622a91f1a0c371477d6.mp4
            about:
              - "Alchemy Orb leaves a pool of flames"

  - Pirate Treasure:
      abilities:
        - Slam:
            type: [ physical ]
            tip: [ destroy ]
            gif: https://i.gyazo.com/20b4ddbade91f264d18ba8c304d9a19a.mp4
            about:
              - "Performs a deadly slam"
              - "This ability can explode Telvar's Barrel"
        - Whirling Blades:
            tip: [ dodge ]
            gif: https://i.gyazo.com/de274bac97aeea2ad5e7726b7c1250ab.mp4
            about:
              - "Rolls towards player linearly"
              - "This ability can explode Telvar's Barrel"

Common tokens

In common cases you may notice we don't use "normal" strings but tokens. Pay attention to about key in example below:

# coves.yml
map: Coves
bosses:
  - Telvar, the Inebriated:
      abilities:
        - Spawn Barrel:
            tip: [ destroy ]
            gif: https://i.gyazo.com/20b4ddbade91f264d18ba8c304d9a19a.mp4
            about:
              - /SPAWN_BARREL/
              - "Once destroyed leaves a pool of Tar"

Skill token has 3 rules:

  1. Must start with forward slash (/)

  2. Must be upper-cased with underline in case ability name has more than 2 words

  3. Must end with forward slash (/)

example: /SPAWN_BARREL/, /FIREBALL/

In example above /SPAWN_BARREL/ is a skill token which value is located in

Since standard yaml files by definition are independent of each other we can't import in any shape or form values form other yaml file values nor make a use of .

To make our lives easier and not duplicate definitions of common skills, in we are replacing token(s) value for our files.

tokens/skills.yml
yaml anchors/aliases
scripts/encounters/extract-tokens.js
.json auto-generated
https://i.gyazo.com/279f86d6f8652e9708cde4a80276223c.mp4
exile.watch logo