@funpixel/tools 0.0.0-stage → 0.1.1

package/plugins/cursor/hooks/vendor/firstlook/set.mjs

@@ -0,0 +1,219 @@
+// Generated from funpixel-mono/libs/funpixel-tools/src/firstlook/set.ts by the GDK build. Do not edit.
+import { readdirSync, readFileSync, existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { gameProfile, gddOf, ownRows, readGameBar, section, sectionsAll, words, worldVerdict } from '../owner/bar.mjs';
+export const SET_FILE = join('design', 'first-look', 'set.json');
+const T = 'npx @funpixel/tools';
+export const SET_GROUPS = [
+    { id: 'look', title: 'Look' },
+    { id: 'screens', title: 'Screens' },
+    { id: 'hud', title: 'HUD' },
+    { id: 'places', title: 'Places & story' },
+    { id: 'living', title: 'Living world' },
+    { id: 'animation', title: 'Animation' },
+    { id: 'juice', title: 'Juice' },
+    { id: 'sound', title: 'Sound' },
+    { id: 'fun', title: 'Fun' },
+];
+const PIC = /\.(png|jpe?g|webp|gif|mp4|webm)$/i;
+const DIRS = [join('design', 'first-look'), join('design', 'look', 'targets'), join('design', 'targets'), join('design', 'cast'), join('design', 'kit'), join('design', 'greenlight')];
+function things(root) {
+    const out = [];
+    for (const rel of DIRS) {
+        const walk = (dir, depth) => {
+            let names = [];
+            try {
+                names = readdirSync(join(root, dir));
+            }
+            catch {
+                return;
+            }
+            for (const n of names.sort()) {
+                if (n.startsWith('.'))
+                    continue;
+                const file = join(dir, n).split('\\').join('/');
+                if (!n.includes('.') && depth < 2) {
+                    walk(join(dir, n), depth + 1);
+                    continue;
+                }
+                const lower = file.toLowerCase();
+                if (PIC.test(n))
+                    out.push({ file, name: lower, kind: 'picture', sizes: [] });
+                else if (/\.html?$/i.test(n) && n !== 'index.html') {
+                    let text = '';
+                    try {
+                        text = readFileSync(join(root, file), 'utf8');
+                    }
+                    catch { }
+                    const named = [...text.matchAll(/data-mockup="([^"]+)"/g), ...text.matchAll(/<h[1-3][^>]*>([^<]+)</g)].map((m) => m[1].toLowerCase());
+                    const sizes = [...text.matchAll(/width:\s*(\d{3,4})px;\s*height:\s*(\d{3,4})px/g)].map((m) => [Number(m[1]), Number(m[2])]);
+                    out.push({ file, name: `${lower} ${named.join(' ')}`, kind: 'mockup', sizes });
+                }
+                else if (/\.md$/i.test(n))
+                    out.push({ file, name: lower, kind: 'page', sizes: [] });
+            }
+        };
+        walk(rel, 0);
+    }
+    return out;
+}
+const slug = (s) => s.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
+const SCREENS = {
+    title: { title: 'Title screen (the play world, its name as art)', re: /\b(screen-)?title|\bstart[- ]screen|main[- ]menu/ },
+    pause: { title: 'Pause', re: /pause/ },
+    settings: { title: 'Settings', re: /settings|options/ },
+    'level-select': { title: 'Level select', re: /level[- ]?select|levels|world[- ]?map|chapter[- ]?select|stage[- ]?select/ },
+    results: { title: 'Results / report', re: /results?|report|summary|score[- ]?screen/ },
+    end: { title: 'End (win / lose)', re: /\bend\b|end[- ]?(card|screen)|win|lose|game[- ]?over|credits/ },
+    'how-to-play': { title: 'How to play', re: /how[- ]?to[- ]?play|tutorial|help/ },
+};
+const canonical = (name) => {
+    const s = slug(name);
+    for (const [id, x] of Object.entries(SCREENS))
+        if (x.re.test(s) || x.re.test(name.toLowerCase()))
+            return id;
+    return s;
+};
+function gddScreens(gdd) {
+    const body = section(gdd, /^screens\b|^title and screens\b|^ui\b/i);
+    if (!body)
+        return [];
+    const out = [];
+    for (const line of body.split('\n')) {
+        const t = /^\s*\|(.+)\|\s*$/.exec(line);
+        const cell = t ? t[1].split('|')[0].trim() : /^\s*[-*]\s+\*{0,2}([^*:—–]{2,30})/.exec(line)?.[1]?.trim();
+        if (!cell || /^:?-+:?$/.test(cell) || /^screen$/i.test(cell) || /[<>]/.test(cell))
+            continue;
+        const id = canonical(cell);
+        if (id && id !== 'play' && !/^(play|hud|game|gameplay)$/.test(id) && !out.includes(id))
+            out.push(id);
+    }
+    return out;
+}
+function refsOwed(root) {
+    try {
+        const p = JSON.parse(readFileSync(join(root, 'design', 'pipeline.json'), 'utf8'));
+        return Array.isArray(p?.stages) && p.stages.some((s) => s?.status !== 'skipped' && Array.isArray(s?.gates) && s.gates.some((g) => g?.kind === 'refs'));
+    }
+    catch {
+        return false;
+    }
+}
+const owners = (root) => {
+    try {
+        return JSON.parse(readFileSync(join(root, SET_FILE), 'utf8'))?.skip ?? {};
+    }
+    catch {
+        return {};
+    }
+};
+export function firstLookSet(root, o = {}) {
+    const g = o.profile ?? gameProfile(root);
+    const gdd = gddOf(root);
+    const all = things(root);
+    const skips = owners(root);
+    const w = worldVerdict(root, readGameBar(root), g);
+    const items = [];
+    const skippedGroups = [];
+    const find = (re, kinds = ['picture', 'mockup']) => all.filter((t) => kinds.includes(t.kind) && re.test(t.name)).map((t) => t.file);
+    const add = (id, group, title, files, closes, ok = files.length > 0, says) => {
+        const s = skips[id];
+        if (s) {
+            items.push({ id, group, title, state: 'skipped', files, says: `skipped by the ${s.by}: "${s.words}"`, closes: '' });
+            return;
+        }
+        items.push({ id, group, title, state: ok ? 'have' : 'missing', files, says: says ?? (ok ? files.slice(0, 3).join(', ') : 'not made yet'), closes: ok ? '' : closes });
+    };
+    const fl = 'design/first-look/';
+    add('keyart', 'look', 'Key art', find(/keyart|key-art|key_art/), `${fl}keyart.png: the title moment, the palette at full strength, space for the name`);
+    if (refsOwed(root))
+        add('ref-hero', 'look', 'The hero\'s reference sheet (the identity lock)', all.filter((t) => t.kind === 'picture' && /^ref[-_]/.test(t.file.toLowerCase().split('/').pop() ?? '')).map((t) => t.file), `${fl}ref-<hero>.png: a turnaround of the hero (front, side, back, its states), drawn first; every later picture is drawn to it`);
+    const base = ['title', 'pause', 'end', ...(g.tier === 'small' ? [] : ['settings', 'results', ...(g.levels ? ['level-select'] : [])])];
+    const screens = [...base, ...gddScreens(gdd).filter((s) => !base.includes(s))];
+    for (const id of screens) {
+        const x = SCREENS[id] ?? { title: id.replace(/-/g, ' '), re: new RegExp(id.replace(/-/g, '[- ]?')) };
+        const files = all.filter((t) => (t.kind === 'picture' || t.kind === 'mockup') && !/keyart|key-art/.test(t.name) && (t.kind === 'mockup' ? x.re.test(t.name.replace(/^\S+\s/, '')) || x.re.test(t.file.toLowerCase().split('/').pop() ?? '') : x.re.test(t.file.toLowerCase().split('/').pop() ?? ''))).map((t) => t.file);
+        add(`screen-${id}`, 'screens', x.title, files, `${fl}screen-${id}.png (drawn in the world's kit, at the phone's framing), or a mockup named "${id}" (data-mockup="${id}" in a ${fl}*.html)`);
+    }
+    const huds = all.filter((t) => /hud/.test(t.name));
+    const sized = (pred) => huds.filter((t) => t.sizes.some(([a, b]) => pred(a, b))).map((t) => t.file);
+    for (const o2 of g.orientations) {
+        const named = huds.filter((t) => new RegExp(`(phone[- ]?)?${o2}`).test(t.name)).map((t) => t.file);
+        const bySize = sized(o2 === 'portrait' ? (a, b) => a < b && a <= 500 : (a, b) => a > b && b <= 500);
+        const legacy = !named.length && !bySize.length && o2 === g.orientations[0] ? huds.filter((t) => t.kind === 'mockup' && !t.sizes.length && !/desktop/.test(t.name)).map((t) => t.file) : [];
+        add(`hud-phone-${o2}`, 'hud', `HUD on the phone, ${o2}`, [...new Set([...named, ...bySize, ...legacy])], `${fl}hud.html with a ${o2 === 'portrait' ? '393 × 852' : '852 × 393'} phone over a target frame, every control numbered (or ${fl}hud-phone-${o2}.png)`);
+    }
+    add('hud-desktop', 'hud', 'HUD on the desktop', [...new Set([...huds.filter((t) => /desktop/.test(t.name)).map((t) => t.file), ...sized((a, b) => a >= 1024 && a > b)])], `${fl}hud-desktop.png, or a 1280 × 720 frame in hud.html (data-mockup="hud-desktop"): the same HUD where a mouse and keys play`);
+    const worldWhy = w.world === 'no' ? w.why : '';
+    if (w.world === 'no') {
+        skippedGroups.push({ group: 'places', why: `no places: ${worldWhy}` }, { group: 'living', why: `no living world: ${worldWhy}` });
+    }
+    else if (w.world === 'unsure') {
+        const why = `waiting on the owner${w.ask ? ` (${w.ask})` : ''}: is there a world to fill? ${w.why}`;
+        items.push({ id: 'places', group: 'places', title: 'A frame per place', state: 'waiting', files: [], says: why, closes: `the owner's answer${w.ask ? ` to ${w.ask}` : ''} (yes: a world with places and creatures; no: none)` });
+        items.push({ id: 'living-world', group: 'living', title: 'Living world sheet', state: 'waiting', files: [], says: why, closes: `the owner's answer${w.ask ? ` to ${w.ask}` : ''}` });
+    }
+    else {
+        const story = sectionsAll(gdd, /^story\b|^the story\b|^opening\b/i);
+        const min = g.tier === 'small' ? 1 : 2;
+        if (g.places.length < min) {
+            add('places', 'places', 'A frame per place', [], `name ${min === 1 ? 'the places' : 'at least two places'} in the GDD's ## Places (palette, hour, weather, landmark, the story beat each carries), then one target frame each: ${fl}place-<name>.png`, false, g.places.length ? `the plan names only ${g.places[0].name}` : 'the GDD names no places yet');
+        }
+        const seen = new Set();
+        for (const p of g.places) {
+            const s = slug(p.name);
+            const cited = [...p.row.matchAll(/(design\/[^\s|)]+\.(?:png|jpe?g|webp))/gi)].map((m) => m[1]).filter((f) => existsSync(join(root, f)));
+            const files = [...new Set([...find(new RegExp(s.length >= 4 ? `place[-_]?${s}|${s}` : `place[-_]?${s}\\b`)), ...cited])];
+            const tied = new RegExp(p.name.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), 'i').test(story) || /\b(beat|chapter|act|story)\b/i.test(p.row);
+            const distinct = words(p.row) >= 6 && !seen.has(p.row.replace(/^[^|]*\|[^|]*\|/, '').trim());
+            seen.add(p.row.replace(/^[^|]*\|[^|]*\|/, '').trim());
+            const lacks = [!files.length && 'its target frame', !tied && 'the story beat it carries (## Story names it)', !distinct && 'what makes it distinct (palette, hour, weather, landmark)'].filter(Boolean);
+            const fix = [!files.length && `${fl}place-${s}.png from the game camera`, !tied && `## Story names ${p.name} at its beat`, !distinct && `its ## Places row says its palette, hour, weather and landmark, unlike the others`].filter(Boolean).join('; ');
+            add(`place-${s}`, 'places', `Place: ${p.name}`, files, fix, !lacks.length, lacks.length ? `missing ${lacks.join(', ')}` : undefined);
+        }
+        const sheet = find(/living|life|creature|fauna|flora|critter|animal|people|folk|npc|crowd|townsfolk|villager|cast/);
+        const does = ownRows(sectionsAll(gdd, /^living world\b|^creatures\b|^the cast\b/i));
+        add('living-world', 'living', 'Living world sheet (creatures, people, ambient life)', sheet, `${fl}living-world.png (or the cast sheet): every creature, person and ambient life at one scale, and in the GDD's ## Living world what each does (where, its job, how it moves)`, sheet.length > 0 && does >= 2, sheet.length && does < 2 ? 'a sheet, but the GDD does not say what each one does (## Living world)' : undefined);
+    }
+    add('animation', 'animation', 'Animation board (hero, creatures, UI)', find(/anim|poses?\b|pose-|strip|cycle|keyframe|turnaround/), `${fl}animation.png (or animation.html): the hero's key poses or strips per state${w.world === 'no' ? '' : ', the creatures\' cycles'}, and the UI's motion (enter, press, reward)`);
+    const juice = sectionsAll(gdd, /^juice\b/i).split('\n').filter((l) => !/starter default/i.test(l)).join('\n');
+    const juiceTable = /\|/.test(juice) && /visual|sight|look/i.test(juice) && /sound|audio/i.test(juice) && /motion|move|camera/i.test(juice) && /haptic|vibrat|rumble/i.test(juice) && (juice.match(/^\s*\|/gm)?.length ?? 0) >= 5;
+    const juiceFiles = find(/juice/, ['picture', 'mockup', 'page']);
+    add('juice', 'juice', 'Juice board (each verb: sight, sound, motion, haptic)', [...juiceFiles, ...(juiceTable ? ['design/GDD.md#juice'] : [])], `${fl}juice.png, or the GDD's ## Juice table: one row per verb with its sight, sound, motion (camera, time) and haptic`);
+    const snd = sectionsAll(gdd, /^(sound|audio|music)\b|^audio plan\b|^sound sheet\b/i);
+    const rows = (snd.match(/^\s*(\||[-*]\s)/gm)?.length ?? 0);
+    const soundOk = /music/i.test(snd) && rows >= 4;
+    const folders = ['sfx', 'music'].filter((d) => { try {
+        return readdirSync(join(root, 'design', 'first-look', d)).some((n) => /\.(mp3|ogg|wav|m4a)$/i.test(n));
+    }
+    catch {
+        return false;
+    } });
+    add('sound', 'sound', 'Sound list (music states and cues)', [...(soundOk ? ['design/GDD.md#audio'] : []), ...folders.map((d) => `${fl}${d}/`)], 'the GDD\'s ## Audio: each music state (title, calm, tense, win) and every cue in the world\'s words, one per line (clips in design/first-look/sfx and music/ when made)', soundOk || folders.length === 2);
+    const own = sectionsAll(gdd, /^fun\b|^the fun\b|^fun factor/i);
+    const loopText = [sectionsAll(gdd, /^core loop\b/i), sectionsAll(gdd, /^experience\b/i)].join('\n').split('\n').filter((l) => !/starter default|<[^>]+>/i.test(l)).join('\n').trim();
+    const fun = own || (loopText ? `the loop\n${loopText}` : '');
+    const where = own ? '## Fun' : '## Core loop';
+    const funPage = find(/\bfun\b|fun\./, ['picture', 'mockup', 'page']);
+    const longArc = /\b15\s*[- ]?min|\barc\b|\bminute \d+|\bat \d+:\d\d\b/i;
+    const arc = g.tier === 'small' ? ['why a second run', new RegExp(`\\bsecond run\\b|\\banother (run|go|try)\\b|\\bretry\\b|\\bsession\\b|\\bbest\\b|${longArc.source}`, 'i')] : ['the 15-minute arc', longArc];
+    const need = [['the loop', /\bloop\b/i], ['goals', /\bgoals?\b/i], ['streaks', /\bstreaks?\b|\bcombo\w*|\bchain\w*/i], ['the 2–3-minute novelty cadence', /\b\d\s*[–-]\s*\d\s*min|\bevery \d+\s*min|\bnew every\b|\bnovelty\b/i], arc];
+    const lacks = fun ? need.filter(([, re]) => !re.test(fun)).map(([n]) => n) : need.map(([n]) => n);
+    add('fun', 'fun', `Fun (loop, goals, streaks, cadence, ${arc[0]})`, [...(fun ? [`design/GDD.md#${own ? 'fun' : 'core-loop'}`] : []), ...funPage], `the GDD's ## Core loop (or a ## Fun section of its own): ${lacks.join(', ')}`, (!!fun && !lacks.length) || funPage.length > 0, fun && lacks.length ? `${where} does not say ${lacks.join(', ')}` : undefined);
+    if (g.ad)
+        for (const it of items)
+            if (it.group === 'fun' && it.state === 'missing') {
+                it.state = 'skipped';
+                it.says = 'a playable ad: the fun is its 30 seconds, said in the brief';
+            }
+    const missing = items.filter((i) => i.state === 'missing' || i.state === 'waiting');
+    return { tier: g.tier, world: w, items, missing, skippedGroups };
+}
+export function setApplies(p) {
+    const st = p?.stages.find((s) => s.id === 'first-look');
+    return !!st && st.status !== 'skipped' && st.gates.some((g) => g.kind === 'set');
+}
+export function missingLines(s) {
+    return s.missing.map((i) => `first look · ${i.title}: ${i.state === 'waiting' ? i.says : `${i.says}; closes with ${i.closes}`}`);
+}
+export const SET_RUN = `${T} firstlook (the set, what each item needs), then make each missing piece (skill funpixel-gdd, references/first-look.md)`;