Skip to content

docs: Build the character creator on the headless Creator API - #29

Merged
Segfaultd merged 1 commit into
mainfrom
docs/headless-creator
Nov 8, 2026
Merged

Segfaultd merged 1 commit into
mainfrom
docs/headless-creator

Conversation

@Segfaultd

Copy link
Copy Markdown
Member

arcane-mp/mod 5bd71520 (UI: Drop the hosted HUD and creator pages) removed the client's built-in creator screen:

  • Creator.open, Creator.isOpen and Creator.close;
  • the creatorOpened, creatorConfirmed and creatorCancelled events.

Foundations builds its own creator on the headless API. The appearance guide's sample still called Creator.open(), so every mod PR's "Scripting type-check" fails on this repo's samples.

  • Players / Appearance: "The character creator" now builds the creator on the headless API:
    • begin (check its result), getSchema, applyPatch with creatorChanged, then commit or cancel;
    • CreatorPreview and exportLook;
    • a sample of a resource's own open, confirm and cancel. A committed look reaches the server as playerAppearanceChanged, as commit()'s own description says.
  • Core concepts / Events: the three removed events leave the client events table. creatorChanged stays.
  • World / Time and weather: the local-override sample sets the sky from a resource's own creator session instead of the removed events.

Checked locally: arcane-mp/mod's check_docs_samples.mjs type-checks all 294 samples in 63 guides against current main's contract. The site build and link check run here in CI. Locally, docs.mjs can't start pnpm on Windows.

The client dropped Creator.open, isOpen and close and the creatorOpened, creatorConfirmed and creatorCancelled events (arcane-mp/mod 5bd71520). The appearance guide now builds the creator on begin, applyPatch and commit, the events table loses the three events, and the time-and-weather sample sets its sky from a resource's own creator.
@Segfaultd
Segfaultd merged commit 8d02bac into main Nov 8, 2026
1 check passed
@Segfaultd
Segfaultd deleted the docs/headless-creator branch November 8, 2026 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant