ESEngine
Cross-platform 2D Game Engine
English | 中文
Documentation · API Reference · Download Editor · Examples
--- ## Overview ESEngine is a cross-platform 2D game engine built from the ground up with modern web technologies. It provides a comprehensive toolset that enables developers to focus on creating games rather than building infrastructure. Export your games to multiple platforms including web browsers, WeChat Mini Games, and other mini-game platforms from a single codebase. ## Key Features | Feature | Description | |---------|-------------| | **ECS Architecture** | Data-driven Entity-Component-System pattern for flexible and cache-friendly game logic | | **High-Performance Rendering** | Rust/WebAssembly 2D renderer with automatic sprite batching and WebGL 2.0 backend | | **Visual Editor** | Cross-platform desktop editor built with Tauri for scene management and asset workflows | | **Modular Design** | Import only what you need - each feature is a standalone package | | **Multi-Platform Export** | Deploy to Web, WeChat Mini Games, and more from one codebase | | **Physics Integration** | 2D physics powered by Rapier with editor visualization | | **Visual Scripting** | Behavior trees and blueprint system for designers | ## Tech Stack - **Runtime**: TypeScript, Rust, WebAssembly - **Renderer**: WebGL 2.0, WGPU (planned) - **Editor**: Tauri, React, Zustand - **Physics**: Rapier2D - **Build**: pnpm, Turborepo, Rollup ## License ESEngine is **free and open source** under the [MIT License](LICENSE). No royalties, no strings attached. ## Installation ### npm ```bash npm install @esengine/ecs-framework ``` ### Editor Download pre-built binaries from the [Releases](https://github.com/esengine/esengine/releases) page (Windows, macOS). ## Quick Start ```typescript import { Core, Scene, Entity, Component, EntitySystem, Matcher, Time, ECSComponent, ECSSystem } from '@esengine/ecs-framework'; @ECSComponent('Position') class Position extends Component { x = 0; y = 0; } @ECSComponent('Velocity') class Velocity extends Component { dx = 0; dy = 0; } @ECSSystem('Movement') class MovementSystem extends EntitySystem { constructor() { super(Matcher.all(Position, Velocity)); } protected process(entities: readonly Entity[]): void { for (const entity of entities) { const pos = entity.getComponent(Position); const vel = entity.getComponent(Velocity); pos.x += vel.dx * Time.deltaTime; pos.y += vel.dy * Time.deltaTime; } } } // Initialize Core.create(); const scene = new Scene(); scene.addSystem(new MovementSystem()); const player = scene.createEntity('Player'); player.addComponent(new Position()); player.addComponent(new Velocity()); Core.setScene(scene); // Game loop function gameLoop(currentTime: number) { Core.update(currentTime / 1000); requestAnimationFrame(gameLoop); } requestAnimationFrame(gameLoop); ``` ## Packages ESEngine is organized as a monorepo with modular packages. ### Core | Package | Description | |---------|-------------| | `@esengine/ecs-framework` | Core ECS framework with entity management, component system, and queries | | `@esengine/math` | Vector, matrix, and mathematical utilities | | `@esengine/engine` | Rust/WASM 2D renderer | | `@esengine/engine-core` | Engine module system and lifecycle management | ### Runtime | Package | Description | |---------|-------------| | `@esengine/sprite` | 2D sprite rendering and animation | | `@esengine/tilemap` | Tile-based map rendering | | `@esengine/physics-rapier2d` | 2D physics simulation (Rapier) | | `@esengine/behavior-tree` | Behavior tree AI system | | `@esengine/blueprint` | Visual scripting runtime | | `@esengine/camera` | Camera control and management | | `@esengine/audio` | Audio playback | | `@esengine/ui` | UI components | | `@esengine/material-system` | Material and shader system | | `@esengine/asset-system` | Asset loading and management | ### Editor Extensions | Package | Description | |---------|-------------| | `@esengine/sprite-editor` | Sprite inspector and tools | | `@esengine/tilemap-editor` | Visual tilemap editor | | `@esengine/physics-rapier2d-editor` | Physics collider visualization | | `@esengine/behavior-tree-editor` | Visual behavior tree editor | | `@esengine/blueprint-editor` | Visual scripting editor | | `@esengine/material-editor` | Material editor | ### Platform | Package | Description | |---------|-------------| | `@esengine/platform-common` | Platform abstraction interfaces | | `@esengine/platform-web` | Web browser runtime | | `@esengine/platform-wechat` | WeChat Mini Game runtime | ## Editor The ESEngine Editor is a cross-platform desktop application built with Tauri and React. ### Features - Scene hierarchy and entity management - Component inspector with custom property editors - Asset browser with drag-and-drop - Tilemap editor with paint and fill tools - Behavior tree visual editor - Blueprint visual scripting - Material and shader editing - Built-in performance profiler - Localization (English, Chinese) ### Screenshot  ## Platform Support | Platform | Runtime | Editor | |----------|:-------:|:------:| | Web Browser | ✓ | - | | Windows | - | ✓ | | macOS | - | ✓ | | WeChat Mini Game | In Progress | - | | Playable Ads | Planned | - | | Android | Planned | - | | iOS | Planned | - | ## Building from Source ### Prerequisites - Node.js 18+ - pnpm 10+ - Rust toolchain (for WASM renderer) - wasm-pack ### Setup ```bash git clone https://github.com/esengine/esengine.git cd esengine pnpm install pnpm build # Optional: Build WASM renderer pnpm build:wasm ``` ### Run Editor ```bash cd packages/editor-app pnpm tauri:dev ``` ### Project Structure ``` esengine/ ├── packages/ # Engine packages (runtime, editor, platform) ├── docs/ # Documentation source ├── examples/ # Example projects ├── scripts/ # Build utilities └── thirdparty/ # Third-party dependencies ``` ## Documentation - [Getting Started](https://esengine.cn/guide/getting-started.html) - [Architecture Guide](https://esengine.cn/guide/) - [API Reference](https://esengine.cn/api/README) ## Community - [GitHub Issues](https://github.com/esengine/esengine/issues) - Bug reports and feature requests - [GitHub Discussions](https://github.com/esengine/esengine/discussions) - Questions and ideas ## Contributing Contributions are welcome. Please read the contributing guidelines before submitting a pull request. 1. Fork the repository 2. Create a feature branch (`git checkout -b feature/amazing-feature`) 3. Commit your changes (`git commit -m 'Add amazing feature'`) 4. Push to the branch (`git push origin feature/amazing-feature`) 5. Open a Pull Request ## License ESEngine is licensed under the [MIT License](LICENSE). ---Made with ❤️ by the ESEngine team