nixie-fx-runtime
Integrate compiled NixieFX particle effects into PixiJS or Three.js applications using the public nixie-fx package. Use when an agent needs to install the runtime, load an out/vfx export bundle, implement texture or material providers, mount a renderer, drive effects from a game loop, inspect runtime diagnostics, or clean up NixieFX resources.
How do I install this agent skill?
npx skills add https://github.com/azakhary/nixie-fx --skill nixie-fx-runtimeIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill provides instructions for integrating NixieFX particle effects into PixiJS and Three.js applications. It includes standard procedures for package installation and asset loading. No security risks were identified.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
NixieFX Runtime
Integrate the generated out/vfx artifact. Do not load authoring project files directly in a game.
Workflow
-
Identify the host renderer, its render loop, asset pipeline, camera or projection, and cleanup lifecycle.
-
Install only the selected optional peer:
npm install nixie-fx three # or npm install nixie-fx pixi.js -
Read export-bundles.md and load the complete compiled bundle through
nixie-fx/export(loadVfxExportBundle). -
Read exactly one backend guide unless the task requires both:
-
Resolve textures, material graphs, meshes, and sub-effects through injected providers owned by the host application.
-
Create the renderer and effect instance, then update the renderer exactly once per host frame.
-
Surface manifest support reports and runtime missing-resource statistics. Do not silently treat partial or missing behavior as complete.
-
Destroy instances, renderer-owned objects, and provider resources when their host scope ends.
Package boundaries
Use only public entrypoints:
nixie-fxfor backend-neutral contracts and support data.nixie-fx/pixifor PixiJS integration.nixie-fx/threefor Three.js integration.nixie-fx/materialsfor material graph contracts.nixie-fx/exportfor browser-safe export schemas and loading.nixie-fx/export/nodeonly for Node filesystem export tooling.
Never deep-import nixie-fx/src/**, copy runtime source into the consumer, or import the unused renderer backend.
Other engines
The export format is engine-neutral JSON with official runtimes for Three.js and PixiJS. When a project targets another engine, do not force one of these adapters in: the shared simulation (src/engine/particles.ts in the repository) is renderer-agnostic, and the Three adapter source is compact enough to serve as a reference implementation for a port.
Runtime rules
- Let the game own its application, scene, camera, clock, URLs, caches, and error reporting.
- Preload asynchronous assets before spawning an effect; provider getters used during rendering must be synchronous.
- Call
renderer.update(deltaSeconds)once. Do not also callinstance.update(deltaSeconds)in the same frame. - Treat authored paths as bundle-relative lookup keys. Map them to URLs or atlas frames in the host provider.
- Use stable seeds when deterministic playback matters.
- Pause or destroy inactive runtimes; hidden scenes must not keep ticking.
- For Three.js performance work, inspect per-emitter draw counts and integrate the public
ThreeVfxBatcherwith the host's final transparent ordering. Read the batching section in three.md. Sharing a material alone does not merge draws; supplying a custom material currently disables the stock instanced fast path. - Do not claim editor parity until the real exported effect has been observed in the target renderer.
Completion checks
- Importing the selected backend succeeds without installing the other peer.
- The loader accepts the manifest, required effect IDs, and selected backend.
- No manifest entry is blocked for the selected backend.
- Textures, material graphs, meshes, and sub-effects resolve without missing-reference statistics.
- Simulation advances once per frame and stops after teardown.
- The effect is visually checked in the real host application.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/azakhary/nixie-fx/nixie-fx-runtime">View nixie-fx-runtime on skillZs</a>