borndotcom/react-native-godot
React Native Godot
react-native-godot is a communication layer and embedding system that integrates the Godot game engine into cross-platform mobile applications. It allows Godot game scenes and logic to be rendered as interactive visual components within a mobile user interface.
The project provides a threaded logic bridge that executes engine functions on dedicated background threads using worklets. This ensures that game engine operations do not block the main application user interface.
The system covers engine lifecycle management, including the ability to start, stop, and pause instances to load different projects. It enables cross-language engine control by mapping JavaScript or TypeScript calls to native engine methods and synchronizing object properties. Additionally, it features a signal-based event mapping system to connect internal engine events to script-level callbacks.
Features
- Native View Embedding - Wraps a game engine instance inside a native mobile container to integrate it as a visual UI component.
- Embedded Engine Components - Integrates a game engine into a mobile application to render games and scenes as embedded visual components.
- Worklet Threading - Executes engine logic on a dedicated background thread using worklets to maintain UI responsiveness.
- Engine Embedding Layers - Ships a system for rendering game windows and managing the lifecycle of a game engine instance inside a mobile UI.
- 3D Scene Renderers - Embeds a game engine instance within a mobile application to display interactive 3D scenes inside the UI.
- Game Engine Embedding - Embeds Godot engine scenes and game logic directly into mobile applications as interactive UI components.
- Godot Engine Integration - Provides a bridge for embedding Godot game scenes and logic as interactive components within a mobile application.
- Engine Control Interfaces - Manages Godot engine state and calls internal methods using TypeScript or JavaScript.
- Foreign Function Interfaces - Implements a communication layer that serializes data to connect JavaScript calls to engine-level methods.
- Logic Thread Isolation - Implements a bridge that isolates engine logic on dedicated background threads to ensure the mobile user interface remains responsive.
- Engine Method Bridges - Provides a bridge to execute engine methods and modify properties from JavaScript or TypeScript.
- Game Engine State Controls - Allows TypeScript or JavaScript to instantiate objects and modify properties within the running engine.
- Game Event Listeners - Binds internal game engine events to JavaScript callbacks via a listeners system.
- Engine Signal Bridges - Connects JavaScript functions to Godot engine signals to trigger logic on internal events.
- Game Engine UI Bridges - Provides a communication layer connecting JavaScript logic to a native game engine for real-time state control.
- Embedded Game Windows - Integrates a game engine instance to display game windows and sub-windows on various screens.
- Property Synchronizers - Updates engine object states by mapping script-level property changes to native engine memory.
- Engine Instance Controllers - Manages the initialization and termination of the engine instance to allow switching between game projects.
- Engine Instance Lifecycle Management - Controls the engine execution state by starting, stopping, pausing, or resuming the engine instance.
- Hybrid Engine Application Development - Combines traditional mobile app layouts with high-performance 2D or 3D game engine rendering.
- Engine Orchestration - Controls the Godot engine lifecycle and executes threaded logic to maintain smooth user interface performance.
