← Files ModRetro Chromatic PluginARCHIVED FILE
dist/tool-domains/schemas.js
18.2 KB · Oct 5, 2026 · 18:37 UTC
import { z } from "zod";
import { nativeTitleAtlasSchema } from "../native-title-atlas.js";
import { MAX_EMULATOR_FRAMES, MAX_EMULATOR_INSPECTION_BYTES, MAX_EMULATOR_OAM_OBJECTS, MAX_EMULATOR_STEP_SAMPLES, } from "../emulator.js";
export const identifier = z.string().trim().min(1).max(256);
// Express the compiler's canonical decimal/safe-integer limit in JSON Schema as well as the service.
const variableId = z.string().trim().regex(/^(?:0|[1-9]\d{0,14}|[1-8]\d{15}|900[0-6]\d{12}|90070\d{11}|90071[0-8]\d{10}|900719[0-8]\d{9}|9007199[0-1]\d{8}|90071992[0-4]\d{7}|900719925[0-3]\d{6}|9007199254[0-6]\d{5}|90071992547[0-3]\d{4}|9007199254740[0-8]\d{2}|90071992547409[0-8]\d|900719925474099[01])$/u)
.describe("Canonical nonnegative decimal string, e.g. 0 or 12: no leading zeros; maximum 9007199254740991. This is an authored ID, not an emulator memory address.");
const variableSymbol = z.string().trim().max(256).regex(/^var_[A-Za-z][A-Za-z0-9_]*$/u)
.describe("Optional compiler symbol, e.g. var_audit_counter. Must begin with var_ followed by an ASCII letter, then letters, digits or underscores. Omit to retain the existing symbol or generate one from a new variable's name.");
export const boundedPath = z.string().trim().min(1).max(4_096).refine((value) => !value.includes("\0"), "Paths must not contain NUL characters.");
export const boundedName = z.string().trim().min(1).max(200);
export const direction = z.enum(["up", "down", "left", "right"]);
export const coordinate = z.number().int().min(0).max(65_535);
export const tileCoordinate = z.number().int().min(0).max(255);
export const dimension = z.number().int().min(1).max(4_096);
export const customProperties = z.record(z.string(), z.unknown());
export const revision = z.string().trim().min(1).max(256);
export const paletteColor = z.string().regex(/^#?[\da-fA-F]{6}$/u);
export const emulatorButton = z.enum(["a", "b", "up", "down", "left", "right", "start", "select"]);
export const frameCount = z.number().int().min(1).max(MAX_EMULATOR_FRAMES);
export const imageLayoutSchema = z.enum(["individual", "contact-sheet"]);
export const scriptTarget = z.object({
sceneId: identifier,
actorId: identifier.optional(),
triggerId: identifier.optional(),
scriptKey: z.string().trim().min(1).max(100).optional(),
branchPath: z.array(z.object({ eventId: identifier, branch: identifier }).strict()).max(64).optional(),
}).strict();
const collisionEdit = z.object({
shape: z.enum(["tile", "rectangle"]),
x: tileCoordinate,
y: tileCoordinate,
width: z.number().int().min(1).max(255).optional(),
height: z.number().int().min(1).max(255).optional(),
value: z.number().int().min(0).max(255),
operation: z.enum(["replace", "or", "andNot"]).optional(),
}).strict();
const sceneBatchOperation = z.object({
type: z.enum([
"actor.create", "actor.update", "actor.delete", "actor_create", "actor_update", "actor_delete",
"trigger.create", "trigger.update", "trigger.delete", "trigger_create", "trigger_update", "trigger_delete",
"event.edit", "script.edit", "script_edit", "event_edit",
"scene.transition", "scene_transition", "scene.update", "scene_update",
"collision.edit", "collision_edit",
"variable.upsert", "variable.delete", "variable.update", "variable_update",
]),
clientId: identifier.optional(),
input: customProperties.optional(),
id: identifier.optional(),
sceneId: identifier.optional(),
actorId: identifier.optional(),
triggerId: identifier.optional(),
variableId: identifier.optional(),
name: boundedName.optional(),
x: coordinate.optional(),
y: coordinate.optional(),
width: dimension.optional(),
height: dimension.optional(),
direction: direction.optional(),
spriteSheetId: identifier.optional(),
properties: customProperties.optional(),
action: z.enum(["insert", "update", "delete", "move", "upsert"]).optional(),
target: scriptTarget.optional(),
eventId: identifier.optional(),
event: customProperties.optional(),
patch: customProperties.optional(),
index: z.number().int().min(0).max(10_000).optional(),
beforeEventId: identifier.optional(),
afterEventId: identifier.optional(),
destinationSceneId: identifier.optional(),
fadeSpeed: z.union([z.string().max(32), z.number().int().min(0).max(255)]).optional(),
edits: z.array(collisionEdit).max(1_024).optional(),
resetInvalid: z.boolean().optional(),
symbol: identifier.optional(),
expectedRevision: revision.optional(),
}).strict();
const assetLookup = {
assetId: identifier.optional(),
assetPath: boundedPath.optional(),
};
const spriteLookup = {
...assetLookup,
spriteId: identifier.optional(),
includeFrames: z.boolean().optional(),
};
const dialogueBase = {
sceneId: identifier.optional(),
actorId: identifier.optional(),
triggerId: identifier.optional(),
eventId: identifier.optional(),
scriptKey: z.string().trim().min(1).max(100).optional(),
text: z.union([z.string().max(20_000), z.array(z.string().max(20_000)).min(1).max(100)]).optional(),
eventCommand: z.literal("EVENT_TEXT").optional(),
fontId: identifier.optional(),
avatarId: identifier.optional(),
profile: z.enum(["auto", "conservative"]).optional(),
maxWidthPx: z.number().int().min(1).max(160).optional(),
maxVisibleLines: z.number().int().min(1).max(16).optional(),
};
export const domainSchemas = {
nativeTitleAtlas: nativeTitleAtlasSchema,
actorInspect: z.object({ sceneId: identifier, actorId: identifier }).strict(),
actorUpdate: z.object({
sceneId: identifier, actorId: identifier, name: boundedName.optional(),
x: tileCoordinate.optional(), y: tileCoordinate.optional(), direction: direction.optional(),
spriteSheetId: identifier.optional(), properties: customProperties.optional(), expectedRevision: revision.optional(),
}).strict(),
actorDelete: z.object({ sceneId: identifier, actorId: identifier, expectedRevision: revision.optional() }).strict(),
triggerInspect: z.object({ sceneId: identifier, triggerId: identifier }).strict(),
triggerCreate: z.object({
sceneId: identifier, name: boundedName, id: identifier.optional(), x: tileCoordinate, y: tileCoordinate,
width: z.number().int().min(1).max(255).optional(), height: z.number().int().min(1).max(255).optional(),
properties: customProperties.optional(), expectedRevision: revision.optional().describe("Exact scene resource revision: use scene_inspect.sceneRevision, not its whole-project revision."),
}).strict(),
triggerUpdate: z.object({
sceneId: identifier, triggerId: identifier, name: boundedName.optional(), x: tileCoordinate.optional(), y: tileCoordinate.optional(),
width: z.number().int().min(1).max(255).optional(), height: z.number().int().min(1).max(255).optional(),
properties: customProperties.optional(), expectedRevision: revision.optional(),
}).strict(),
triggerDelete: z.object({ sceneId: identifier, triggerId: identifier, expectedRevision: revision.optional() }).strict(),
sceneInspect: z.object({
sceneId: identifier, includeScripts: z.boolean().optional(), maxActors: z.number().int().min(1).max(100).optional(),
maxTriggers: z.number().int().min(1).max(100).optional(), maxEvents: z.number().int().min(1).max(250).optional(),
}).strict(),
sceneDelete: z.object({ sceneId: identifier, expectedRevision: revision.optional().describe("Whole-project revision from scene_inspect.revision or project_inspect.revision."), dryRun: z.boolean().optional() }).strict(),
sceneApply: z.object({
sceneId: identifier, operations: z.array(sceneBatchOperation).min(1).max(100),
dryRun: z.boolean().optional(), expectedRevision: revision.optional().describe("Whole-project revision from scene_inspect.revision or project_inspect.revision; resource revisions are not interchangeable."),
}).strict(),
assetImport: z.object({
assetPath: boundedPath, kind: z.enum(["background", "sprite"]), sourcePath: boundedPath.optional(),
name: boundedName.optional(), id: identifier.optional(),
background: z.object({ autoColor: z.boolean().optional() }).strict().optional(),
sprite: z.discriminatedUnion("profile", [
z.object({
profile: z.enum(["static", "static16x16", "directional", "directional48x16", "directional_animated", "directional_animated96x16", "template"]),
templateAssetId: identifier.optional(),
}).strict(),
z.object({ profile: z.literal("native_metadata"), metadataPath: boundedPath,
sourceSha256: z.string().regex(/^[a-f0-9]{64}$/i), metadataSha256: z.string().regex(/^[a-f0-9]{64}$/i),
}).strict(),
]).optional(),
expectedRevision: revision.optional().describe("Required whole-project revision for native_metadata only."),
dryRun: z.boolean().optional().describe("Validate the complete native_metadata import without publishing; defaults false."),
// Keep a ZodObject: the MCP SDK cannot publish a top-level ZodEffects schema.
// importAsset enforces the cross-field requirements before preparing any writes.
}).strict(),
assetInspect: z.object(assetLookup).strict(),
assetUpdate: z.object({
...assetLookup, name: boundedName.optional(), autoColor: z.boolean().optional(),
copyTileColorsFrom: identifier.optional(), expectedRevision: revision.optional(), dryRun: z.boolean().optional(),
}).strict(),
assetDelete: z.object(assetLookup).strict(),
spriteInspect: z.object(spriteLookup).strict(),
spriteUpdate: z.object({
...spriteLookup, name: boundedName.optional(), animSpeed: z.number().int().min(0).max(255).optional(),
boundsX: z.number().int().min(-128).max(127).optional(), boundsY: z.number().int().min(-128).max(127).optional(),
boundsWidth: z.number().int().min(1).max(255).optional(), boundsHeight: z.number().int().min(1).max(255).optional(),
stateIndex: z.number().int().min(0).max(31).optional().describe("Existing state to update when setting flipLeft or animationType; defaults to 0."), flipLeft: z.boolean().optional(),
animationType: z.enum(["fixed", "multi", "multi_movement"]).optional(),
}).strict(),
spritePreview: z.object({
...spriteLookup, stateIndex: z.number().int().min(0).max(31).optional(),
animationIndex: z.number().int().min(0).max(7).optional(), frameIndex: z.number().int().min(0).max(31).optional(),
outputPath: boundedPath.optional(), scale: z.number().int().min(1).max(8).optional(),
}).strict(),
spriteContactSheet: z.object({
...spriteLookup, outputPath: boundedPath, columns: z.number().int().min(1).max(8).optional(),
scale: z.number().int().min(1).max(8).optional(), stateIndex: z.number().int().min(0).max(31).optional(),
}).strict(),
paletteCreate: z.object({ name: boundedName, colors: z.array(paletteColor).length(4), id: identifier.optional() }).strict(),
paletteUpdate: z.object({
paletteId: identifier, name: boundedName.optional(), colors: z.array(paletteColor).length(4).optional(),
updateDefaultColors: z.boolean().optional(),
}).strict(),
scenePaletteAssign: z.object({
sceneId: identifier, target: z.enum(["background", "sprite"]), slot: z.number().int().min(0).max(7),
paletteId: identifier, allowUiSlot: z.boolean().optional(),
}).strict(),
backgroundPalettePaint: z.object({
backgroundId: identifier, sceneId: identifier.optional(),
edits: z.array(z.object({
x: tileCoordinate, y: tileCoordinate,
width: z.number().int().min(1).max(255).optional(), height: z.number().int().min(1).max(255).optional(),
slot: z.number().int().min(0).max(7),
}).strict()).min(1).max(1_024),
}).strict(),
sceneGraphicsAnalyze: z.object({
sceneId: identifier, detail: z.enum(["summary", "tiles"]).optional(),
tileOffset: z.number().int().min(0).max(65_535).optional(), tileLimit: z.number().int().min(1).max(512).optional(),
includeStaticOam: z.boolean().optional(),
}).strict(),
sceneGraphicsPreview: z.object({
sceneId: identifier.optional(), sceneIds: z.array(identifier).min(1).max(16).optional(),
outputPath: boundedPath, displayMode: z.enum(["color", "mono"]).optional(),
columns: z.number().int().min(1).max(8).optional(), magnification: z.number().int().min(1).max(4).optional(),
}).strict(),
scriptInspect: z.object({ target: scriptTarget, eventId: identifier.optional() }).strict(),
scriptEdit: z.object({
action: z.enum(["insert", "update", "delete", "move"]), target: scriptTarget,
eventId: identifier.optional(), event: customProperties.optional(), patch: customProperties.optional(),
index: z.number().int().min(0).max(10_000).optional(), beforeEventId: identifier.optional(), afterEventId: identifier.optional(),
expectedRevision: revision.optional().describe("Owner-resource revision returned by script_inspect for the same target, or the preceding successful script edit."),
}).strict(),
scriptTransition: z.object({
target: scriptTarget, destinationSceneId: identifier, x: tileCoordinate, y: tileCoordinate,
direction: direction.optional(), fadeSpeed: z.union([z.string().max(32), z.number().int().min(0).max(255)]).optional(),
index: z.number().int().min(0).max(10_000).optional(), expectedRevision: revision.optional().describe("Owner-resource revision from script_inspect for the same source target."),
}).strict(),
variableInspect: z.object({ variableId: variableId.optional() }).strict(),
variableSet: z.object({ variableId: variableId.optional(), name: boundedName.optional().describe("Required when creating a new variable; omit only to retain an existing name."), symbol: variableSymbol.optional(), expectedRevision: revision.optional().describe("Variable-resource revision returned by variable_inspect or the preceding successful variable edit.") }).strict(),
variableDelete: z.object({ variableId, expectedRevision: revision.optional().describe("Variable-resource revision returned by variable_inspect or the preceding successful variable edit.") }).strict(),
engineFieldInspect: z.object({
fieldIds: z.array(identifier).max(250).optional(),
limit: z.number().int().min(1).max(250).optional(),
}).strict(),
engineFieldUpdate: z.object({
updates: z.array(z.object({
id: identifier,
value: z.union([z.string().max(1_024), z.number().int().safe().finite()]),
}).strict()).min(1).max(100),
expectedRevision: revision.optional(),
}).strict(),
collisionInspect: z.object({
sceneId: identifier, x: tileCoordinate.optional(), y: tileCoordinate.optional(),
width: z.number().int().min(1).max(255).optional(), height: z.number().int().min(1).max(255).optional(),
maxCells: z.number().int().min(1).max(4_096).optional(),
}).strict(),
collisionEdit: z.object({ sceneId: identifier, edits: z.array(collisionEdit).min(1).max(1_024), resetInvalid: z.boolean().optional(), expectedRevision: revision.optional() }).strict(),
dialogueAnalyze: z.object({
...dialogueBase, wrap: z.enum(["none", "word"]).optional(), paginate: z.boolean().optional(), includeSuggestion: z.boolean().optional(),
eventLimit: z.number().int().min(1).max(2_048).optional(),
pageLimit: z.number().int().min(1).max(4_096).optional(),
}).strict(),
dialoguePreview: z.object({
...dialogueBase, outputPath: boundedPath, pageIndex: z.number().int().min(0).max(4_095).optional(),
pageIndices: z.array(z.number().int().min(0).max(4_095)).min(1).max(64).optional(),
columns: z.number().int().min(1).max(8).optional(), magnification: z.number().int().min(1).max(4).optional(),
}).strict(),
worldDependencies: z.object({
node: z.object({
type: z.enum(["scene", "actor", "trigger", "asset", "palette", "variable", "script", "actorPrefab", "triggerPrefab", "settings"]),
id: identifier,
}).strict(),
direction: z.enum(["incoming", "outgoing", "both"]).optional(),
relations: z.array(z.string().trim().min(1).max(64)).max(32).optional(),
sceneId: identifier.optional(),
depth: z.union([z.literal(1), z.literal(2), z.literal(3)]).optional(),
limit: z.number().int().min(1).max(250).optional(),
cursor: z.string().min(1).max(2_048).optional(),
coverageCursor: z.string().min(1).max(2_048).optional(),
}).strict(),
emulatorStep: z.object({
buttons: z.array(emulatorButton).max(8).refine((buttons) => new Set(buttons).size === buttons.length, "Buttons must be unique."),
frames: frameCount,
sampleCount: z.number().int().min(1).max(MAX_EMULATOR_STEP_SAMPLES).optional(),
includeImages: z.boolean().optional(),
imageLayout: imageLayoutSchema.optional(),
}).strict(),
emulatorObserve: z.object({ includeImages: z.boolean().optional(), imageLayout: imageLayoutSchema.optional() }).strict(),
emulatorInspect: z.object({
view: z.enum(["oam", "memory", "vram"]).describe("oam reads hardware sprite objects; memory and vram read a bounded byte range."),
visibleOnly: z.boolean().optional().describe("oam only: filter out objects not visible on screen."),
limit: z.number().int().min(1).max(MAX_EMULATOR_OAM_OBJECTS).optional().describe("oam only: maximum objects to return."),
includeScanlineSummary: z.boolean().optional().describe("oam only: include peak sprite count, peak scanlines, and the count of scanlines over the hardware limit."),
region: z.enum(["vram", "wram", "oam", "hram"]).optional().describe("Required for memory and vram; the vram view requires region vram."),
offset: z.number().int().min(0).max(65_535).optional().describe("Required for memory and vram: zero-based byte offset within the region, not an absolute CPU address."),
length: z.number().int().min(1).max(MAX_EMULATOR_INSPECTION_BYTES).optional().describe("Required for memory and vram: byte count; the full range must fit within the region."),
bank: z.number().int().min(0).max(7).optional().describe("memory/vram only: optional for VRAM (0–1) or WRAM (0–7). A banked WRAM range must fit within 4 KiB."),
}).strict(),
};
//# sourceMappingURL=schemas.js.mapSHA-256: dc3062fdf6e356a8ffaae59c57933bd3fcec1ba0c2fb3e73e1c5cd5da36e4632