docs/raidboss: add coverage comments (#568)

Update raidboss docs and add coverage comments.

---------

Co-authored-by: valarnin <[email protected]>

Author: xiashtra

docs/RaidbossGuide.md

@@ -115,6 +115,9 @@ export default {
   zoneLabel: {
     en: 'The Weapon\'s Refrain (Ultimate)',
   },
+  comments: {
+    en: 'This is a comment that will show on the Coverage Report',
+  },
   loadConfigs: ['TheUnendingCoilOfBahamutUltimate'],
   config: [
     {
@@ -177,6 +180,10 @@ A trigger set must have one of zoneId or zoneRegex to specify the zone
 An optional name to use for this trigger set in the configuration interface.
 Overrides the zone name from [zone_info.ts](../resources/zone_info.ts).
 
+**comments**
+An optional comment for this trigger set that will appear on the [Cactbot Content Coverage report](https://overlayplugin.github.io/cactbot/util/coverage/coverage.html).
+Supports HTML, but be aware that the font used on the coverage report does not support bold/italics.
+
 **initData**
 A function that can be used to initialize the data this trigger set uses.
 It should return an object that sets values for any fields in `data` that need to be initialized.

ui/raidboss/data/00-misc/general.ts

@@ -12,6 +12,9 @@ const caresAboutTankStuff = (data: RaidbossData) => {
 const triggerSet: TriggerSet<Data> = {
   id: 'CactbotGeneral',
   zoneId: ZoneId.MatchAll,
+  comments: {
+    en: 'General triggers for all occasions and zones',
+  },
   triggers: [
     {
       id: 'General Provoke',

ui/raidboss/data/00-misc/test.ts

@@ -27,6 +27,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'CactbotTest',
   zoneId: ZoneId.MiddleLaNoscea,
+  comments: {
+    en: 'Cactbot test triggers',
+  },
   config: [
     {
       id: 'testTriggerOutput',

ui/raidboss/data/00-misc/the_masked_carnivale.ts

@@ -27,6 +27,9 @@ const triggerSet: TriggerSet<Data> = {
     cn: '假面狂欢',
     ko: '가면 무투회',
   },
+  comments: {
+    en: 'BLU Masked Carnivale Stages 1-32',
+  },
   triggers: [
     // ================ Stage 01 Act 1 ================
     // intentionally blank

ui/raidboss/data/02-arr/alliance/the_world_of_darkness.ts

@@ -23,6 +23,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'TheWorldOfDarkness',
   zoneId: ZoneId.TheWorldOfDarkness,
+  comments: {
+    en: 'Mostly incomplete',
+  },
   triggers: [
     {
       id: 'Angra Mainyu Gain Sullen',

ui/raidboss/data/02-arr/dungeon/brayfloxs_longstop.ts

@@ -10,6 +10,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'BrayfloxsLongstop',
   zoneId: ZoneId.BrayfloxsLongstop,
+  comments: {
+    en: 'pre-6.1 rework',
+  },
   initData: () => {
     return {
       pelicanPoisons: [],

ui/raidboss/data/02-arr/dungeon/snowcloak.ts

@@ -7,6 +7,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Snowcloak',
   zoneId: ZoneId.Snowcloak,
+  comments: {
+    en: 'pre-6.2 rework',
+  },
   triggers: [
     {
       id: 'Snowcloak Lunar Cry',

ui/raidboss/data/03-hw/dungeon/aetherochemical_research_facility.ts

@@ -9,6 +9,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheAetherochemicalResearchFacility',
   zoneId: ZoneId.TheAetherochemicalResearchFacility,
+  comments: {
+    en: 'pre-6.3 rework',
+  },
   timelineFile: 'aetherochemical_research_facility.txt',
   timelineTriggers: [
     {

ui/raidboss/data/03-hw/dungeon/baelsars_wall.ts

@@ -9,6 +9,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'BaelsarsWall',
   zoneId: ZoneId.BaelsarsWall,
+  comments: {
+    en: 'pre-6.3 rework',
+  },
   timelineFile: 'baelsars_wall.txt',
   timelineTriggers: [
     {

ui/raidboss/data/03-hw/dungeon/sohm_al.ts

@@ -10,6 +10,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'SohmAl',
   zoneId: ZoneId.SohmAl,
+  comments: {
+    en: 'pre-6.2 rework',
+  },
   timelineFile: 'sohm_al.txt',
   timelineTriggers: [
     {

ui/raidboss/data/03-hw/dungeon/xelphatol.ts

@@ -10,6 +10,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Xelphatol',
   zoneId: ZoneId.Xelphatol,
+  comments: {
+    en: 'pre-6.3 rework',
+  },
   timelineFile: 'xelphatol.txt',
   timelineTriggers: [
     {

ui/raidboss/data/03-hw/pvp/shatter.ts

@@ -19,6 +19,9 @@ const bNpcNameIds = Object.keys(bNpcNameIdToLocation);
 const triggerSet: TriggerSet<Data> = {
   id: 'TheFieldsOfGloryShatter',
   zoneId: ZoneId.TheFieldsOfGloryShatter,
+  comments: {
+    en: 'pre-6.4 rework',
+  },
   triggers: [
     // https://xivapi.com/LogMessage/2652
     // en: <Clickable(<SheetEn(BNpcName,2,IntegerParameter(1),1,1)/>)/> activates and begins to emit heat.

ui/raidboss/data/03-hw/trial/bismarck-ex.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheLimitlessBlueExtreme',
   zoneId: ZoneId.TheLimitlessBlueExtreme,
+  comments: {
+    en: 'Mostly incomplete',
+  },
   triggers: [
     {
       id: 'Bismarck Sharp Gust',

ui/raidboss/data/03-hw/trial/ravana-ex.ts

@@ -7,6 +7,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'ThokAstThokExtreme',
   zoneId: ZoneId.ThokAstThokExtreme,
+  comments: {
+    en: 'Timeline only, no triggers',
+  },
   timelineFile: 'ravana-ex.txt',
   triggers: [],
   timelineReplace: [

ui/raidboss/data/04-sb/dungeon/drowned_city_of_skalla.ts

@@ -9,6 +9,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheDrownedCityOfSkalla',
   zoneId: ZoneId.TheDrownedCityOfSkalla,
+  comments: {
+    en: 'pre-6.5 rework',
+  },
   timelineFile: 'drowned_city_of_skalla.txt',
   timelineTriggers: [
     {

ui/raidboss/data/04-sb/dungeon/ghimlyt_dark.ts

@@ -9,6 +9,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheGhimlytDark',
   zoneId: ZoneId.TheGhimlytDark,
+  comments: {
+    en: 'pre-6.5 rework',
+  },
   timelineFile: 'ghimlyt_dark.txt',
   timelineTriggers: [
     {

ui/raidboss/data/04-sb/dungeon/the_burn.ts

@@ -11,6 +11,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'TheBurn',
   zoneId: ZoneId.TheBurn,
+  comments: {
+    en: 'pre-6.5 rework',
+  },
   timelineFile: 'the_burn.txt',
   triggers: [
     {

ui/raidboss/data/04-sb/eureka/eureka_hydatos.ts

@@ -17,6 +17,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'TheForbiddenLandEurekaHydatos',
   zoneId: ZoneId.TheForbiddenLandEurekaHydatos,
+  comments: {
+    en: 'Baldesion Arsenal triggers/timelines only',
+  },
   timelineFile: 'eureka_hydatos.txt',
   resetWhenOutOfCombat: false,
   timelineTriggers: [

ui/raidboss/data/04-sb/eureka/eureka_pagos.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheForbiddenLandEurekaPagos',
   zoneId: ZoneId.TheForbiddenLandEurekaPagos,
+  comments: {
+    en: 'Inactivity warning only',
+  },
   resetWhenOutOfCombat: false,
   triggers: [
     // https://xivapi.com/LogMessage/916

ui/raidboss/data/04-sb/eureka/eureka_pyros.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheForbiddenLandEurekaPyros',
   zoneId: ZoneId.TheForbiddenLandEurekaPyros,
+  comments: {
+    en: 'Mostly incomplete',
+  },
   resetWhenOutOfCombat: false,
   triggers: [
     {

ui/raidboss/data/04-sb/hunts/yanxia.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Yanxia',
   zoneId: ZoneId.Yanxia,
+  comments: {
+    en: 'Hunts: Angada only',
+  },
   triggers: [
     {
       id: 'Angada Scythe Tail',

ui/raidboss/data/05-shb/etc/the_diadem.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheDiadem',
   zoneId: ZoneId.TheDiadem,
+  comments: {
+    en: 'Inactivity warning and timed node spawn alert',
+  },
   resetWhenOutOfCombat: false,
   triggers: [
     // https://xivapi.com/LogMessage/916

ui/raidboss/data/05-shb/eureka/bozjan_southern_front.ts

@@ -143,6 +143,9 @@ const tankBusterOnParty = (ceName?: string) => (data: Data, matches: NetMatches[
 const triggerSet: TriggerSet<Data> = {
   id: 'TheBozjanSouthernFront',
   zoneId: ZoneId.TheBozjanSouthernFront,
+  comments: {
+    en: 'Castrum Lacus Litore triggers/timeline.  Missing almost all Critical Engagements.',
+  },
   timelineFile: 'bozjan_southern_front.txt',
   timeline: [
     (data) => {

ui/raidboss/data/05-shb/eureka/zadnor.ts

@@ -103,6 +103,9 @@ const tankBusterOnParty = (ceName?: string) => (data: Data, matches: NetMatches[
 const triggerSet: TriggerSet<Data> = {
   id: 'Zadnor',
   zoneId: ZoneId.Zadnor,
+  comments: {
+    en: 'Dalriada triggers/timeline.  Some Critical Engagements.',
+  },
   timelineFile: 'zadnor.txt',
   resetWhenOutOfCombat: false,
   triggers: [

ui/raidboss/data/05-shb/hunts/amh_araeng.ts

@@ -10,6 +10,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'AmhAraeng',
   zoneId: ZoneId.AmhAraeng,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Mailktender Sabotendance',

ui/raidboss/data/05-shb/hunts/il_mheg.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'IlMheg',
   zoneId: ZoneId.IlMheg,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Pauldia Rusting Claw',

ui/raidboss/data/05-shb/hunts/kholusia.ts

@@ -11,6 +11,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'Kholusia',
   zoneId: ZoneId.Kholusia,
+  comments: {
+    en: 'Hunts, missing Formidable boss FATE',
+  },
   triggers: [
     {
       id: 'Hunt Lil Murderer Goblin Punch',

ui/raidboss/data/05-shb/hunts/lakeland.ts

@@ -11,6 +11,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'Lakeland',
   zoneId: ZoneId.Lakeland,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Nariphon Piercing Resistance Down II Gain',

ui/raidboss/data/05-shb/hunts/the_raktika_greatwood.ts

@@ -11,6 +11,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'TheRaktikaGreatwood',
   zoneId: ZoneId.TheRaktikaGreatwood,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Grassman Chest Thump',

ui/raidboss/data/05-shb/hunts/the_tempest.ts

@@ -13,6 +13,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'TheTempest',
   zoneId: ZoneId.TheTempest,
+  comments: {
+    en: 'Hunts, missing Archaeotania boss FATE',
+  },
   triggers: [
     {
       id: 'Hunt Baal Sewer Water Front',

ui/raidboss/data/06-ew/hunts/elpis.ts

@@ -11,6 +11,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Elpis',
   zoneId: ZoneId.Elpis,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Gurangatch Left Hammer Slammer',

ui/raidboss/data/06-ew/hunts/garlemald.ts

@@ -10,6 +10,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Garlemald',
   zoneId: ZoneId.Garlemald,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Aegeiros Leafstorm',

ui/raidboss/data/06-ew/hunts/labyrinthos.ts

@@ -8,6 +8,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'Labyrinthos',
   zoneId: ZoneId.Labyrinthos,
+  comments: {
+    en: 'Hunts',
+  },
   triggers: [
     {
       id: 'Hunt Hulder Lay of Mislaid Memory',

ui/raidboss/data/06-ew/hunts/mare_lamentorum.ts

@@ -13,6 +13,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'MareLamentorum',
   zoneId: ZoneId.MareLamentorum,
+  comments: {
+    en: 'Hunts',
+  },
   resetWhenOutOfCombat: false,
   initData: () => {
     return {

ui/raidboss/data/06-ew/hunts/thavnair.ts

@@ -26,6 +26,9 @@ const tankBusterOnParty = (data: Data, matches: NetMatches['StartsUsing']) => {
 const triggerSet: TriggerSet<Data> = {
   id: 'Thavnair',
   zoneId: ZoneId.Thavnair,
+  comments: {
+    en: 'Hunts and Daivadipa boss FATE',
+  },
   resetWhenOutOfCombat: false,
   initData: () => {
     return {

ui/raidboss/data/06-ew/hunts/ultima_thule.ts

@@ -17,6 +17,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'UltimaThule',
   zoneId: ZoneId.UltimaThule,
+  comments: {
+    en: 'Hunts and Chi boss FATE',
+  },
   triggers: [
     {
       id: 'Hunt Arch-Eta Energy Wave',

ui/raidboss/data/06-ew/map/the_shifting_gymnasion_agonon.ts

@@ -46,6 +46,9 @@ export type Data = RaidbossData;
 const triggerSet: TriggerSet<Data> = {
   id: 'TheShiftingGymnasionAgonon',
   zoneId: ZoneId.TheShiftingGymnasionAgonon,
+  comments: {
+    en: 'Missing several summons',
+  },
 
   triggers: [
     // ---------------- random treasure mobs ----------------

ui/raidboss/data/07-dt/hunts/heritage_found.ts

@@ -51,6 +51,9 @@ export interface Data extends RaidbossData {
 const triggerSet: TriggerSet<Data> = {
   id: 'HeritageFound',
   zoneId: ZoneId.HeritageFound,
+  comments: {
+    en: 'Hunts',
+  },
   initData: () => ({
     atticusCleaves: [],
   }),