CocosPlugin/esengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: 恢复 @esengine/ecs-framework 包名

Browse Source 
上一个提交错误地将 npm 包名也改了，这里恢复正确的包名。
只更新 GitHub 仓库 URL，不改变 npm 包名。
This commit is contained in:
yhh
2025-12-08 21:26:35 +08:00
parent 240b165970
commit ad96edfad0
334 changed files with 558 additions and 558 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/en/guide/getting-started.md
View File

@@ -8,7 +8,7 @@ This guide will help you get started with ECS Framework, from installation to cr
```bash
# Using npm
npm install @esengine/esengine
npm install @esengine/ecs-framework
```
## Initialize Core
@@ -18,7 +18,7 @@ npm install @esengine/esengine
The core of ECS Framework is the `Core` class, a singleton that manages the entire framework lifecycle.
```typescript
import { Core } from '@esengine/esengine'
import { Core } from '@esengine/ecs-framework'
// Method 1: Using config object (recommended)
const core = Core.create({
@@ -102,7 +102,7 @@ See engine integration examples: [Game Engine Integration](#game-engine-integrat
Components are pure data containers that store entity state:
```typescript
import { Component, ECSComponent } from '@esengine/esengine'
import { Component, ECSComponent } from '@esengine/ecs-framework'
// Position component
@ECSComponent('Position')
@@ -151,7 +151,7 @@ class Sprite extends Component {
Systems contain game logic and process entities with specific components. ECS Framework provides Matcher-based entity filtering:
```typescript
import { EntitySystem, Matcher, Time, ECSSystem } from '@esengine/esengine'
import { EntitySystem, Matcher, Time, ECSSystem } from '@esengine/ecs-framework'
// Movement system - handles position and velocity
@ECSSystem('MovementSystem')
@@ -219,7 +219,7 @@ class RenderSystem extends EntitySystem {
Recommended to extend Scene class for custom scenes:
```typescript
import { Scene } from '@esengine/esengine'
import { Scene } from '@esengine/ecs-framework'
// Recommended: Extend Scene for custom scene
class GameScene extends Scene {
@@ -264,7 +264,7 @@ player.addComponent(new Sprite("player.png", 64, 64));
Core has built-in scene management, very simple to use:
```typescript
import { Core, Scene } from '@esengine/esengine';
import { Core, Scene } from '@esengine/ecs-framework';
// Initialize Core
Core.create({ debug: true });
@@ -304,7 +304,7 @@ const player = Core.ecsAPI?.createEntity('Player')
Only for complex server-side applications (MMO game servers, game room systems, etc.):
```typescript
import { Core, WorldManager } from '@esengine/esengine';
import { Core, WorldManager } from '@esengine/ecs-framework';
// Initialize Core
Core.create({ debug: true });
@@ -338,7 +338,7 @@ function gameLoop(deltaTime: number) {
```typescript
import { Stage } from "laya/display/Stage";
import { Laya } from "Laya";
import { Core } from '@esengine/esengine';
import { Core } from '@esengine/ecs-framework';
// Initialize Laya
Laya.init(800, 600).then(() => {
@@ -358,7 +358,7 @@ Laya.init(800, 600).then(() => {
```typescript
import { Component, _decorator } from 'cc';
import { Core } from '@esengine/esengine';
import { Core } from '@esengine/ecs-framework';
const { ccclass } = _decorator;