@scrthq/runlog 0.0.44 → 0.0.45

package/dist/runlog.js

@@ -26525,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({
@@ -26715,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({
@@ -26944,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."
@@ -27320,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(
@@ -28272,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 ?? {})) {
@@ -28349,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}`}`;
@@ -28817,6 +28849,7 @@ function initialState(pack, e) {
     outcomes: [],
     obligations: [],
     firedOnce: [],
+    lacks: e.lacks ?? [],
     contestants: [],
     awards: [],
     ending: null

package/package.json

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