MyAnythingList Canonical English Docs

Freshness: 2026-03-17 v1 • Standard navigation header/footer • This document is the canonical place to see what can be scripted.

Docs Index Requirements Developer System Commands & Functions

English Docs Index Developer System Requirements Thumbnail System

Commands and Functions

This document is the canonical scripting surface for MyAnythingList. Developers, automation tools, and future ChatGPT sessions must use this file to understand what can be scripted, which commands exist, what arguments they accept, what each command must do, and what behaviors are forbidden.

Canonical rule: if a command, argument, mode, option, or output contract is intended to be scriptable, it belongs in this document. Hidden behavior, undocumented arguments, UI-only side effects, and implementation-only flags are not allowed as part of the stable scripting interface.

This file complements developer_en.html and system_en.html. It does not replace those documents. It is the practical entry point for contributors who need to know what can be automated.

1. Core scripting principles

Deterministic: the same input state and the same command sequence must produce the same output.
No hidden state: commands must not depend on manual UI timing, viewport size, monitor resolution, or undocumented internal defaults.
Native-resolution output: any render or export command must operate at the explicitly requested output resolution, not screen resolution.
Unified pipeline: commands must use the same canonical composition model used by live rendering; export reconstruction is not an allowed separate logic path.
Documentation preservation: future updates may extend command behavior, but may not remove detail from this document unless the removed information is explicitly superseded and replaced with a more complete rule.

2. Command groups

Group	Purpose	Examples
State input	Provide URLs, media, text, playlist data, and layout state.	`setProjectState`, `setURL`, `setThumbnail`
Composition control	Control QR, URL art, overlays, labels, and layer visibility.	`setQR`, `setTextArt`, `setOverlayVisibility`
Rendering	Render the canonical tile or page composition at a target resolution.	`renderTile`, `renderPage`
Export	Write PNG/JPEG or other supported outputs without degrading the master path.	`exportImage`, `exportBatch`
Validation	Check readiness, layer completeness, and acceptance-test conditions.	`validateState`, `assertQRReady`
Localization	Control language, locale, direction, and string-key resolution.	`setLocale`, `getString`

3. Canonical command definitions

`setProjectState(state)`

Loads or replaces the full project state used by live rendering and export rendering.

Must accept: URL data, thumbnail data, text-art data, QR settings, overlay flags, export preferences, localization keys, and any relevant playlist/page state.
Must not: silently discard unsupported fields. Unsupported fields must be reported.
Must be idempotent: applying the same state twice must not change output.

setProjectState({
  url: "https://example.org",
  thumbnail: { mode: "url-art" },
  qr: { enabled: true, content: "https://example.org" },
  export: { resolution: "8k", format: "png", qualityMode: "master" }
})

`setURL(url, options)`

Defines the primary URL and any derived textual display values.

Must support: full URL, display URL, optional short URL, and visibility rules.
Must preserve: enough data to generate URL art, small footer URL, and QR content where required.

`setThumbnail(config)`

Sets the primary thumbnail source or fallback mode.

Field	Type	Required	Meaning
`mode`	string	yes	`image` or `url-art`
`source`	string/object	when `mode=image`	highest available source asset
`fit`	string	no	fit/contain/crop behavior as defined elsewhere in docs
`preserveSourceQuality`	boolean	no	controls source-quality handling without changing export resolution

Rule: source images may be source-limited; overlays, QR, and text must not inherit that limitation.

`setTextArt(config)`

Configures URL-text-art rendering when no image thumbnail is used or when text art is explicitly selected.

Must support: URL source text, fit strategy, scale strategy, clipping policy, line-break policy, and language-aware shaping.
Must render sharply at 4K and 8K with no DOM-upscale shortcut.
Must work across scripts, including non-Latin and RTL languages.

`setQR(config)`

Controls QR creation, content, visibility, and placement.

Required fields: enabled, content when enabled.
Optional fields: placement preset, explicit offsets, scale, quiet zone, error-correction mode, visibility rules.
Must guarantee: if QR is visible in live state, the QR must also appear in export in the same canonical layer order.

setQR({
  enabled: true,
  content: "https://example.org",
  position: "bottom-right",
  scaleMode: "layout-aware"
})

`setOverlayVisibility(config)`

Toggles optional overlays such as type pills, small URL text, footer text, and other documented overlay elements.

Must use stable keys, not hardcoded UI labels.
Must not silently change layer order.

`setLocale(locale, options)`

Changes the active localization context for all user-facing labels and script-generated visible text.

Must support: locale code, fallback locale, and direction handling.
Must not: cause control labels to become hardcoded English.

`validateState()`

Validates readiness before render/export.

Should report missing thumbnail source, invalid URL state, missing QR content when QR is enabled, unsupported locale, and unresolved string keys.
Must not allow a false success when required state is missing.

`assertQRReady()`

Confirms QR generation is complete before render/export proceeds.

Failure rule: if export proceeds before QR readiness and the output omits a visible QR, that build fails acceptance.

`renderTile(options)`

Renders the canonical tile composition at the requested target resolution.

Field	Meaning
`resolution`	Final output dimensions or named preset such as 4K/8K.
`backgroundMode`	Selected background behavior.
`includeOverlays`	Whether documented overlays are present.
`outputSurface`	Canvas, bitmap, or internal render target.

Must use: the same composition model as live rendering.
Must not use: screenshot capture, viewport raster reuse, or a lower-resolution pre-render scaled upward.

`exportImage(options)`

Encodes a previously rendered result or a render-on-demand result to an output image.

Supported master path: PNG by default.
Optional path: JPEG only when explicitly requested.
Must not: silently step quality downward on the master-fidelity path.

exportImage({
  format: "png",
  resolution: "8k",
  qualityMode: "master"
})

`exportBatch(options)`

Exports multiple tiles/pages using the same deterministic rules.

Must process each item as a canonical render, not as a lower-quality batch shortcut.
Must preserve acceptance-test guarantees for every item in the batch.

4. Argument and naming rules

Stable names: commands and argument keys must remain stable once published.
No UI-label coupling: scripts must use machine-stable keys, never visible button text.
No ambiguous flags: avoid undefined terms like auto unless the exact meaning is fully documented.
Serializable state: arguments must be representable in plain data so they can be saved, replayed, versioned, and shared.
Explicit defaults: any omitted option that has a default must have that default documented here.

5. Example scripting flows

Text-art + QR master export

setProjectState({
  url: "https://define.com/_MyAnythingList.txt",
  thumbnail: { mode: "url-art" },
  qr: { enabled: true, content: "https://define.com/_MyAnythingList.txt" },
  locale: "en",
  export: { resolution: "8k", format: "png", qualityMode: "master" }
})
validateState()
assertQRReady()
renderTile({ resolution: "8k", includeOverlays: true })
exportImage({ format: "png", resolution: "8k", qualityMode: "master" })

Image thumbnail export with crisp overlays

setThumbnail({
  mode: "image",
  source: "/path/to/highest-available-source.jpg",
  fit: "contain"
})
setQR({ enabled: true, content: "https://example.org" })
setOverlayVisibility({ typePill: true, smallURL: true, footer: true })
renderTile({ resolution: "7680x4320" })
exportImage({ format: "png", qualityMode: "master" })

6. Fail conditions tied to scripting

Any scriptable export that omits a visible QR is a fail.
Any command path that produces softer text because it reused screen pixels is a fail.
Any scripting path that bypasses the canonical live/export composition model is a fail.
Any command that depends on English control text rather than stable keys is a fail.
Any undocumented command or argument used by a release build is a fail until documented here.

7. Maintenance rule for future sessions

This document is a standard part of the package. Future sessions, contributors, and automation agents must update it whenever a new scriptable capability, command, argument, mode, preset, or execution guarantee is discussed or implemented. No scriptable feature is considered complete until this file reflects it.

Package rule: people should be able to open commands-and-functions_en.html and immediately understand what can be scripted without searching the rest of the package first.