@scrthq/runlog 0.0.43 → 0.0.45

package/dist/runlog.js

@@ -26448,13 +26448,15 @@ var Action = external_exports.lazy(
       do: external_exports.literal("modCounter").describe("Adjust a counter."),
       counter: Id.describe("Id of the counter to change."),
       by: external_exports.number().int().optional().describe("Amount to add; negative subtracts."),
-      set: external_exports.number().int().optional().describe("Absolute value to set, overriding `by`.")
+      set: external_exports.number().int().optional().describe("Absolute value to set, overriding `by`."),
+      setFrom: external_exports.string().min(1).optional().describe("Set it to a value bound earlier \u2014 a roll's total or a prompt's answer \u2014 by name. Overrides `by` and `set`.")
     }).strict().describe("Adjust a counter."),
     external_exports.object({
       do: external_exports.literal("modResource").describe("Adjust a resource."),
       resource: Id.describe("Id of the resource to change."),
       by: external_exports.number().int().optional().describe("Amount to add; negative spends."),
-      set: external_exports.number().int().optional().describe("Absolute value to set, overriding `by`.")
+      set: external_exports.number().int().optional().describe("Absolute value to set, overriding `by`."),
+      setFrom: external_exports.string().min(1).optional().describe("Set it to a value bound earlier \u2014 a roll's total or a prompt's answer \u2014 by name. Overrides `by` and `set`.")
     }).strict().describe("Adjust a resource, clamped to its declared min and max."),
     external_exports.object({
       do: external_exports.literal("grantCard").describe("Draw cards into the player's hand."),
@@ -26523,6 +26525,9 @@ var EntryBase = {
   tags: external_exports.array(external_exports.string()).optional().describe("Free tags, for cross-referencing and for filtering results out in some modes."),
   points: external_exports.number().int().min(0).optional().describe(
     "What a contestant earns for completing this result in a moderated mode. A result with points is a challenge the moderator can award; one without is an effect that lands on everyone."
+  ),
+  needs: external_exports.array(Id).optional().describe(
+    "Requirements this result depends on, by id from the pack's `requires`. A run that said it lacks one of them draws again instead of landing here \u2014 a barbell movement for someone without a barbell, an oven dish in a kitchen without one."
   )
 };
 var LookupEntry = external_exports.object({
@@ -26669,7 +26674,10 @@ var StateDef = external_exports.object({
   short: external_exports.string().max(8).optional().describe(
     "Compact form for embedding in the name of the thing itself \u2014 a file, a layer, a DAW track. Keep it very short, e.g. VF."
   ),
-  scope: external_exports.enum(["subject", "run"]).default("subject").describe("Whether this attaches to one subject or to the whole run."),
+  scope: external_exports.enum(["subject", "run", "contestant"]).default("subject").describe(
+    "Whether this attaches to one subject, to the whole run, or \u2014 in moderated play \u2014 to one contestant on the roster, marked by the moderator: spared from a curse, disqualified, and so on."
+  ),
+  until: external_exports.enum(["unitEnd"]).optional().describe("When the state lifts by itself. `unitEnd`: it is taken off everything it is on when the unit closes \u2014 a curse for this region, a cure for this region."),
   semantics: external_exports.array(
     external_exports.enum(["blocksEdit", "makesUntargetable", "excludesFromResult", "locksValue", "removesFromPlay"])
   ).optional().describe(
@@ -26710,6 +26718,14 @@ var ResourceDef = external_exports.object({
 }).strict().describe(
   "A numeric track the player fills or spends: a progress clock, a word count, training volume, stock on hand."
 );
+var Requirement = external_exports.object({
+  id: Id.describe("Unique among requirements. Table entries name it in `needs`."),
+  label: external_exports.string().min(1).describe("What it is, in the words a person would use: Rocket League, a potter's wheel, an oven."),
+  kind: external_exports.enum(["game", "platform", "software", "equipment", "supplies", "space", "other"]).default("other").describe("What sort of thing it is, so a catalog can say 'needs a game' or 'needs equipment' at a glance."),
+  optional: external_exports.boolean().default(false).describe("Nice to have rather than needed. A player says at the start whether they have it, and results that `need` it are drawn again when they do not."),
+  note: external_exports.string().optional().describe("A line on where to get it, which version, or what will do instead."),
+  url: external_exports.string().url().optional().describe("Where to find it.")
+}).strict().describe("A physical or software requirement: the game and the system to play it on, a mod or training pack, a wheel, a kitchen, supplies.");
 var ChecklistItem = external_exports.union([
   external_exports.string().min(1),
   external_exports.object({
@@ -26939,6 +26955,11 @@ var Pack = external_exports.object({
   author: external_exports.string().optional().describe("Who wrote the game."),
   description: external_exports.string().optional().describe("One or two sentences on what the game is."),
   homepage: external_exports.string().url().optional().describe("Where to find out more."),
+  category: external_exports.string().min(1).max(40).optional().describe("What kind of thing this is, in a word or two, for a catalog to group by: everyday, games, craft, fitness, cooking, writing\u2026"),
+  tags: external_exports.array(external_exports.string().min(1).max(40)).max(12).optional().describe("Free tags for a catalog to filter by: the game it is for, the hobby, the shape of play. Short, and in the words a person would search for."),
+  requires: external_exports.array(Requirement).max(20).optional().describe(
+    "What a person needs before playing, shown in the catalog and the rulebook: the game and a system that runs it, mods or training packs, a wheel, a kitchen, supplies. Mark the ones that are nice to have `optional`; results can `need` those and be drawn again for a player who lacks them."
+  ),
   license: License,
   capabilities: external_exports.array(Capability).default([]).describe(
     "Engine features this pack needs. Declaring them lets an older app refuse the pack with a clear message instead of misplaying it."
@@ -27259,6 +27280,7 @@ function lintPack(pack) {
   let usesResources = resourceIds.size > 0;
   let usesTimers = false;
   let usesResolveTarget = false;
+  const movedCounters = /* @__PURE__ */ new Set();
   for (const site of collectActionSites(pack)) {
     walkActions(site.actions, (a) => {
       switch (a.do) {
@@ -27277,6 +27299,7 @@ function lintPack(pack) {
           if (!counterIds.has(a.counter)) {
             d.push(err("ref/unknown-counter", site.path, `references unknown counter ${a.counter}`));
           }
+          movedCounters.add(a.counter);
           break;
         case "modResource":
           if (!resourceIds.has(a.resource)) {
@@ -27313,6 +27336,18 @@ function lintPack(pack) {
       }
     });
   }
+  const requirements = new Map((pack.requires ?? []).map((r) => [r.id, r]));
+  for (const [tableId, table] of Object.entries(pack.tables)) {
+    table.entries.forEach((e, i) => {
+      for (const need of e.needs ?? []) {
+        const r = requirements.get(need);
+        if (!r) d.push(err("ref/unknown-requirement", `tables.${tableId}.entries[${i}].needs`, `needs unknown requirement ${need}`));
+        else if (!r.optional) {
+          d.push(warn("requirement/never-lacked", `tables.${tableId}.entries[${i}].needs`, `needs ${need}, which is not optional, so no run can lack it; the entry will never be skipped`));
+        }
+      }
+    });
+  }
   const predicateSites = [];
   for (const [tableId, table] of Object.entries(pack.tables)) {
     table.entries.forEach(
@@ -27385,6 +27420,7 @@ function lintPack(pack) {
         if (typeof item !== "string" && item.tally && !counterIds.has(item.tally)) {
           d.push(err("ref/unknown-counter", `${path}.${field}[${ii}]`, `tallies unknown counter ${item.tally}`));
         }
+        if (typeof item !== "string" && item.tally) movedCounters.add(item.tally);
         if (typeof item !== "string" && item.shows && !tableIds.has(item.shows.table)) {
           d.push(err("ref/unknown-table", `${path}.${field}[${ii}]`, `shows unknown table ${item.shows.table}`));
         }
@@ -27493,8 +27529,8 @@ function lintPack(pack) {
         d.push(err("ref/unknown-state", path, `hooks unknown state ${sel.state}`));
       }
     }
-    if (!counter.incrementOn?.length && !counter.triggers?.length) {
-      d.push(warn("counter/inert", path, "counter has no incrementOn and no triggers; nothing will ever change it"));
+    if (!counter.incrementOn?.length && !counter.triggers?.length && !movedCounters.has(counterId)) {
+      d.push(warn("counter/inert", path, "counter has no incrementOn, no triggers, and nothing moves it; it will never change"));
     }
   }
   if (pack.targeting?.strategy === "anchoredOffset") {
@@ -28264,6 +28300,9 @@ function stepDetail(pack, step) {
 function whatYouNeed(pack) {
   const n = nouns(pack);
   const items = [];
+  for (const r of pack.requires ?? []) {
+    items.push(`${cap(r.label)}${r.optional ? " (optional; results that need it are drawn again without it)" : ""}${r.note ? ` \u2014 ${r.note}` : ""}${r.url ? ` (${r.url})` : ""}.`);
+  }
   const dice = diceInWords(diceNeeded(pack));
   if (dice) items.push(cap(dice) + ".");
   for (const deck of Object.values(pack.decks ?? {})) {
@@ -28341,6 +28380,7 @@ function summaryDoc(pack) {
   const n = nouns(pack);
   const b = new Builder();
   b.p(pack.description);
+  b.p([pack.category ? `Category: ${pack.category}` : "", pack.tags?.length ? `Tags: ${pack.tags.join(", ")}` : ""].filter(Boolean).join(" \xB7 "), "muted");
   b.p(license(pack), "muted");
   b.h(2, "How it plays");
   const unitRange = `${pack.unit.min === pack.unit.max ? pack.unit.min : `${pack.unit.min}\u2013${pack.unit.max}`}`;
@@ -28422,8 +28462,8 @@ function rulebookDoc(pack) {
       ["State", "On", "Means"],
       states.map(([, s]) => [
         s.short ? `${s.label} (${s.short})` : s.label,
-        s.scope === "run" ? `the ${n.run}` : `a ${n.subject}`,
-        [s.description ?? "", ...(s.semantics ?? []).map(semanticInWords), s.group ? `Replaces any other \u201C${s.group}\u201D state.` : ""].filter(Boolean).join(" ")
+        s.scope === "run" ? `the ${n.run}` : s.scope === "contestant" ? "a contestant" : `a ${n.subject}`,
+        [s.description ?? "", ...(s.semantics ?? []).map(semanticInWords), s.group ? `Replaces any other \u201C${s.group}\u201D state.` : "", s.until === "unitEnd" ? `Lifts when the ${n.unit} closes.` : ""].filter(Boolean).join(" ")
       ])
     );
   }
@@ -28809,6 +28849,7 @@ function initialState(pack, e) {
     outcomes: [],
     obligations: [],
     firedOnce: [],
+    lacks: e.lacks ?? [],
     contestants: [],
     awards: [],
     ending: null
@@ -28985,6 +29026,10 @@ function reduce(pack, log) {
         for (const subject of state.subjects) {
           if (subject.unit === state.unit) subject.finalized = true;
         }
+        const lifts = (id) => pack.states?.[id]?.until === "unitEnd";
+        state.runStates = state.runStates.filter((id) => !lifts(id));
+        for (const subject of state.subjects) subject.states = subject.states.filter((id) => !lifts(id));
+        for (const who of state.contestants) who.states = who.states.filter((id) => !lifts(id));
         break;
       }
       case "JournalWritten":
@@ -29020,12 +29065,25 @@ function reduce(pack, log) {
         break;
       case "ContestantAdded":
         if (!state.contestants.some((c) => c.id === event.contestant)) {
-          state.contestants.push({ id: event.contestant, name: event.name });
+          state.contestants.push({ id: event.contestant, name: event.name, states: [] });
         }
         break;
       case "ContestantRemoved":
         state.contestants = state.contestants.filter((c) => c.id !== event.contestant);
         break;
+      case "ContestantStateApplied": {
+        const who = state.contestants.find((c) => c.id === event.contestant);
+        if (!who) break;
+        const group = pack.states?.[event.state]?.group;
+        if (group) who.states = who.states.filter((s) => s === event.state || pack.states?.[s]?.group !== group);
+        if (!who.states.includes(event.state)) who.states.push(event.state);
+        break;
+      }
+      case "ContestantStateRemoved": {
+        const who = state.contestants.find((c) => c.id === event.contestant);
+        if (who) who.states = who.states.filter((s) => s !== event.state);
+        break;
+      }
       case "Awarded":
         if (!state.awards.some((a) => a.contestant === event.contestant && a.outcome === event.outcome)) {
           state.awards.push({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrthq/runlog",
-  "version": "0.0.43",
+  "version": "0.0.45",
   "description": "Validate, lint, bundle and test Runlog rule packs.",
   "type": "module",
   "license": "MIT",