docs(readme): correct API drift against the current engine surface - #423
Merged
Conversation
The scene bullet still advertised setScene, which no longer exists; the navigation surface is change/restore/preload/unload plus pause/resume, with fade, slide and cross-fade transitions shipping as built-ins. The Quickstart did not run: Scene.init receives the activation data, not a Loader, and Application.start takes a registered scene constructor, so the snippet needed a scenes option and start(HelloScene) instead of an instance. The corrected snippet was typechecked as an example file against the real package types. Further corrections: - assets bullet named defineAssetManifest/loadBundle, both removed by the descriptor redesign; the catalog API is Assets.from/Asset.type/defineAsset - FocusManager does keyboard traversal only, no gamepad navigation - BiquadEffect ships in core audio, not in exojs-audio-fx - the ESM-only claim contradicted the published IIFE CDN bundle Drops five roadmap entries that already shipped (physics joints/sleeping/ CCD, W3C blend modes, slide and cross-fade transitions, the Aseprite and LDtk adapters listed as packages in the same file, the IIFE bundle), narrows the tween entry to the coroutine helpers that are still missing, and adds the platform adapter work as the next directional item.
Exoridus
enabled auto-merge (squash)
July 27, 2026 07:01
|
To use Codex here, create an environment for this repo. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README advertised an API that no longer exists. Every claim below was verified against the current source, not assumed.
Fixed
setScenedoes not exist. Navigation ischange/restore/preload/unloadpluspause/resume, and fade, slide and cross-fade transitions all ship as built-ins (FadeSceneTransition,SlideSceneTransition,CrossFadeSceneTransition).Scene.initreceives the activation data, not aLoader, andApplication.starttakes a registered scene constructor —app.start(new HelloScene())would have thrownUnregisteredSceneError. The corrected snippet was typechecked as a real example file against the package types.defineAssetManifest/loadBundle; both were removed by the descriptor redesign (feat(resources): redesign asset descriptors and type resolution #420). The catalog API isAssets.from/Asset.type/defineAsset.FocusManagerdoes keyboard traversal only — the claimed gamepad navigation does not exist.BiquadEffectships in core audio, not in@codexo/exojs-audio-fx.dist/exo.iife.js, globalExo, listed infiles).Roadmap section
Dropped five entries that already shipped: physics joints/sleeping/CCD, the W3C blend mode suite, slide and cross-fade transitions, the Aseprite and LDtk adapters (listed as shipped packages 130 lines above in the same file), and the IIFE bundle. Narrowed "tween sequencer and coroutine helpers" to just the coroutine helpers —
TweenSequencerships, coroutines do not. Added platform adapters (DOM/Worker/headless) as the next directional item.Verified still-accurate and left alone: screen-level post-processing, spline path following, and the localization primitive are genuinely unimplemented.
Verification
pnpm typecheck:examples(Quickstart snippet, as a real example file) andpnpm format:check— both clean.