Skip to content

Core Engine API ​

<NexusEngine> ​

The primary React component that acts as the runtime environment for your scene and systems.

Props ​

  • apiKey (string) - Required. Your Nexus Engine API key.
  • apiEndpoint (string) - The backend endpoint for license verification and plugin downloads. Defaults to http://localhost:4000.
  • config (object) - The configuration containing nodes and systems.

SystemRegistry ​

A global singleton responsible for holding the React component definitions for all plugins.

typescript
SystemRegistry.register('PlayerSystem', PlayerComponent);
const Component = SystemRegistry.get('PlayerSystem');

<SceneParser> ​

A recursive component that takes a Node object and maps it to the equivalent React Three Fiber <mesh>, <ambientLight>, <group>, etc.

engineEventBus ​

The decoupled communication bus. See Events for more details.