feat(docs): 添加中英文国际化支持
This commit is contained in:
yhh
11
README.md
11
README.md
@@ -81,6 +81,17 @@ player.addComponent(new Position());
|
|||||||
player.addComponent(new Velocity());
|
player.addComponent(new Velocity());
|
||||||
|
|
||||||
Core.setScene(scene);
|
Core.setScene(scene);
|
||||||
|
|
||||||
|
// Game loop
|
||||||
|
let lastTime = 0;
|
||||||
|
function gameLoop(currentTime: number) {
|
||||||
|
const deltaTime = (currentTime - lastTime) / 1000;
|
||||||
|
lastTime = currentTime;
|
||||||
|
|
||||||
|
Core.update(deltaTime);
|
||||||
|
requestAnimationFrame(gameLoop);
|
||||||
|
}
|
||||||
|
requestAnimationFrame(gameLoop);
|
||||||
```
|
```
|
||||||
|
|
||||||
## Modules
|
## Modules
|
||||||
|
|||||||
11
README_CN.md
11
README_CN.md
@@ -81,6 +81,17 @@ player.addComponent(new Position());
|
|||||||
player.addComponent(new Velocity());
|
player.addComponent(new Velocity());
|
||||||
|
|
||||||
Core.setScene(scene);
|
Core.setScene(scene);
|
||||||
|
|
||||||
|
// 游戏循环
|
||||||
|
let lastTime = 0;
|
||||||
|
function gameLoop(currentTime: number) {
|
||||||
|
const deltaTime = (currentTime - lastTime) / 1000;
|
||||||
|
lastTime = currentTime;
|
||||||
|
|
||||||
|
Core.update(deltaTime);
|
||||||
|
requestAnimationFrame(gameLoop);
|
||||||
|
}
|
||||||
|
requestAnimationFrame(gameLoop);
|
||||||
```
|
```
|
||||||
|
|
||||||
## 模块
|
## 模块
|
||||||
|
|||||||
@@ -9,6 +9,184 @@ const corePackageJson = JSON.parse(
|
|||||||
readFileSync(join(__dirname, '../../packages/core/package.json'), 'utf-8')
|
readFileSync(join(__dirname, '../../packages/core/package.json'), 'utf-8')
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Import i18n messages
|
||||||
|
import en from './i18n/en.json' with { type: 'json' }
|
||||||
|
import zh from './i18n/zh.json' with { type: 'json' }
|
||||||
|
|
||||||
|
// 创建侧边栏配置 | Create sidebar config
|
||||||
|
// prefix: 路径前缀，如 '' 或 '/en' | Path prefix like '' or '/en'
|
||||||
|
function createSidebar(t, prefix = '') {
|
||||||
|
return {
|
||||||
|
[`${prefix}/guide/`]: [
|
||||||
|
{
|
||||||
|
text: t.sidebar.gettingStarted,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.quickStart, link: `${prefix}/guide/getting-started` },
|
||||||
|
{ text: t.sidebar.guideOverview, link: `${prefix}/guide/` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.coreConcepts,
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.entity, link: `${prefix}/guide/entity` },
|
||||||
|
{ text: t.sidebar.hierarchy, link: `${prefix}/guide/hierarchy` },
|
||||||
|
{ text: t.sidebar.component, link: `${prefix}/guide/component` },
|
||||||
|
{ text: t.sidebar.entityQuery, link: `${prefix}/guide/entity-query` },
|
||||||
|
{
|
||||||
|
text: t.sidebar.system,
|
||||||
|
link: `${prefix}/guide/system`,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.workerSystem, link: `${prefix}/guide/worker-system` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.scene,
|
||||||
|
link: `${prefix}/guide/scene`,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.sceneManager, link: `${prefix}/guide/scene-manager` },
|
||||||
|
{ text: t.sidebar.worldManager, link: `${prefix}/guide/world-manager` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.behaviorTree,
|
||||||
|
link: `${prefix}/guide/behavior-tree/`,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.btGettingStarted, link: `${prefix}/guide/behavior-tree/getting-started` },
|
||||||
|
{ text: t.sidebar.btCoreConcepts, link: `${prefix}/guide/behavior-tree/core-concepts` },
|
||||||
|
{ text: t.sidebar.btEditorGuide, link: `${prefix}/guide/behavior-tree/editor-guide` },
|
||||||
|
{ text: t.sidebar.btEditorWorkflow, link: `${prefix}/guide/behavior-tree/editor-workflow` },
|
||||||
|
{ text: t.sidebar.btCustomActions, link: `${prefix}/guide/behavior-tree/custom-actions` },
|
||||||
|
{ text: t.sidebar.btCocosIntegration, link: `${prefix}/guide/behavior-tree/cocos-integration` },
|
||||||
|
{ text: t.sidebar.btLayaIntegration, link: `${prefix}/guide/behavior-tree/laya-integration` },
|
||||||
|
{ text: t.sidebar.btAdvancedUsage, link: `${prefix}/guide/behavior-tree/advanced-usage` },
|
||||||
|
{ text: t.sidebar.btBestPractices, link: `${prefix}/guide/behavior-tree/best-practices` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{ text: t.sidebar.serialization, link: `${prefix}/guide/serialization` },
|
||||||
|
{ text: t.sidebar.eventSystem, link: `${prefix}/guide/event-system` },
|
||||||
|
{ text: t.sidebar.timeAndTimers, link: `${prefix}/guide/time-and-timers` },
|
||||||
|
{ text: t.sidebar.logging, link: `${prefix}/guide/logging` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.advancedFeatures,
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.serviceContainer, link: `${prefix}/guide/service-container` },
|
||||||
|
{ text: t.sidebar.pluginSystem, link: `${prefix}/guide/plugin-system` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.platformAdapters,
|
||||||
|
link: `${prefix}/guide/platform-adapter`,
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.browserAdapter, link: `${prefix}/guide/platform-adapter/browser` },
|
||||||
|
{ text: t.sidebar.wechatAdapter, link: `${prefix}/guide/platform-adapter/wechat-minigame` },
|
||||||
|
{ text: t.sidebar.nodejsAdapter, link: `${prefix}/guide/platform-adapter/nodejs` }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
[`${prefix}/examples/`]: [
|
||||||
|
{
|
||||||
|
text: t.sidebar.examples,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.examplesOverview, link: `${prefix}/examples/` },
|
||||||
|
{ text: t.nav.workerDemo, link: `${prefix}/examples/worker-system-demo` }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
[`${prefix}/api/`]: [
|
||||||
|
{
|
||||||
|
text: t.sidebar.apiReference,
|
||||||
|
items: [
|
||||||
|
{ text: t.sidebar.overview, link: `${prefix}/api/README` },
|
||||||
|
{
|
||||||
|
text: t.sidebar.coreClasses,
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: 'Core', link: `${prefix}/api/classes/Core` },
|
||||||
|
{ text: 'Scene', link: `${prefix}/api/classes/Scene` },
|
||||||
|
{ text: 'World', link: `${prefix}/api/classes/World` },
|
||||||
|
{ text: 'Entity', link: `${prefix}/api/classes/Entity` },
|
||||||
|
{ text: 'Component', link: `${prefix}/api/classes/Component` },
|
||||||
|
{ text: 'EntitySystem', link: `${prefix}/api/classes/EntitySystem` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.systemClasses,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: 'PassiveSystem', link: `${prefix}/api/classes/PassiveSystem` },
|
||||||
|
{ text: 'ProcessingSystem', link: `${prefix}/api/classes/ProcessingSystem` },
|
||||||
|
{ text: 'IntervalSystem', link: `${prefix}/api/classes/IntervalSystem` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.utilities,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: 'Matcher', link: `${prefix}/api/classes/Matcher` },
|
||||||
|
{ text: 'Time', link: `${prefix}/api/classes/Time` },
|
||||||
|
{ text: 'PerformanceMonitor', link: `${prefix}/api/classes/PerformanceMonitor` },
|
||||||
|
{ text: 'DebugManager', link: `${prefix}/api/classes/DebugManager` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.interfaces,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: 'IScene', link: `${prefix}/api/interfaces/IScene` },
|
||||||
|
{ text: 'IComponent', link: `${prefix}/api/interfaces/IComponent` },
|
||||||
|
{ text: 'ISystemBase', link: `${prefix}/api/interfaces/ISystemBase` },
|
||||||
|
{ text: 'ICoreConfig', link: `${prefix}/api/interfaces/ICoreConfig` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.decorators,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: '@ECSComponent', link: `${prefix}/api/functions/ECSComponent` },
|
||||||
|
{ text: '@ECSSystem', link: `${prefix}/api/functions/ECSSystem` }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: t.sidebar.enums,
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: 'ECSEventType', link: `${prefix}/api/enumerations/ECSEventType` },
|
||||||
|
{ text: 'LogLevel', link: `${prefix}/api/enumerations/LogLevel` }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 创建导航配置 | Create nav config
|
||||||
|
// prefix: 路径前缀，如 '' 或 '/en' | Path prefix like '' or '/en'
|
||||||
|
function createNav(t, prefix = '') {
|
||||||
|
return [
|
||||||
|
{ text: t.nav.home, link: `${prefix}/` },
|
||||||
|
{ text: t.nav.quickStart, link: `${prefix}/guide/getting-started` },
|
||||||
|
{ text: t.nav.guide, link: `${prefix}/guide/` },
|
||||||
|
{ text: t.nav.api, link: `${prefix}/api/README` },
|
||||||
|
{
|
||||||
|
text: t.nav.examples,
|
||||||
|
items: [
|
||||||
|
{ text: t.nav.workerDemo, link: `${prefix}/examples/worker-system-demo` },
|
||||||
|
{ text: t.nav.lawnMowerDemo, link: 'https://github.com/esengine/lawn-mower-demo' }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: `v${corePackageJson.version}`,
|
||||||
|
link: 'https://github.com/esengine/ecs-framework/releases'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
vite: {
|
vite: {
|
||||||
plugins: [
|
plugins: [
|
||||||
@@ -29,180 +207,49 @@ export default defineConfig({
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
title: 'ESEngine',
|
title: 'ESEngine',
|
||||||
description: '高性能 TypeScript ECS 框架 - 为游戏开发而生',
|
|
||||||
lang: 'zh-CN',
|
|
||||||
|
|
||||||
appearance: 'force-dark',
|
appearance: 'force-dark',
|
||||||
|
|
||||||
|
locales: {
|
||||||
|
root: {
|
||||||
|
label: '简体中文',
|
||||||
|
lang: 'zh-CN',
|
||||||
|
description: '高性能 TypeScript ECS 框架 - 为游戏开发而生',
|
||||||
|
themeConfig: {
|
||||||
|
nav: createNav(zh, ''),
|
||||||
|
sidebar: createSidebar(zh, ''),
|
||||||
|
editLink: {
|
||||||
|
pattern: 'https://github.com/esengine/ecs-framework/edit/master/docs/:path',
|
||||||
|
text: zh.common.editOnGithub
|
||||||
|
},
|
||||||
|
outline: {
|
||||||
|
level: [2, 3],
|
||||||
|
label: zh.common.onThisPage
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
en: {
|
||||||
|
label: 'English',
|
||||||
|
lang: 'en',
|
||||||
|
link: '/en/',
|
||||||
|
description: 'High-performance TypeScript ECS Framework for Game Development',
|
||||||
|
themeConfig: {
|
||||||
|
nav: createNav(en, '/en'),
|
||||||
|
sidebar: createSidebar(en, '/en'),
|
||||||
|
editLink: {
|
||||||
|
pattern: 'https://github.com/esengine/ecs-framework/edit/master/docs/:path',
|
||||||
|
text: en.common.editOnGithub
|
||||||
|
},
|
||||||
|
outline: {
|
||||||
|
level: [2, 3],
|
||||||
|
label: en.common.onThisPage
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
themeConfig: {
|
themeConfig: {
|
||||||
siteTitle: 'ESEngine',
|
siteTitle: 'ESEngine',
|
||||||
|
|
||||||
nav: [
|
|
||||||
{ text: '首页', link: '/' },
|
|
||||||
{ text: '快速开始', link: '/guide/getting-started' },
|
|
||||||
{ text: '指南', link: '/guide/' },
|
|
||||||
{ text: 'API', link: '/api/README' },
|
|
||||||
{
|
|
||||||
text: '示例',
|
|
||||||
items: [
|
|
||||||
{ text: 'Worker系统演示', link: '/examples/worker-system-demo' },
|
|
||||||
{ text: '割草机演示', link: 'https://github.com/esengine/lawn-mower-demo' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: `v${corePackageJson.version}`,
|
|
||||||
link: 'https://github.com/esengine/ecs-framework/releases'
|
|
||||||
}
|
|
||||||
],
|
|
||||||
|
|
||||||
sidebar: {
|
|
||||||
'/guide/': [
|
|
||||||
{
|
|
||||||
text: '开始使用',
|
|
||||||
items: [
|
|
||||||
{ text: '快速开始', link: '/guide/getting-started' },
|
|
||||||
{ text: '指南概览', link: '/guide/' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '核心概念',
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{ text: '实体类 (Entity)', link: '/guide/entity' },
|
|
||||||
{ text: '层级系统 (Hierarchy)', link: '/guide/hierarchy' },
|
|
||||||
{ text: '组件系统 (Component)', link: '/guide/component' },
|
|
||||||
{ text: '实体查询系统', link: '/guide/entity-query' },
|
|
||||||
{
|
|
||||||
text: '系统架构 (System)',
|
|
||||||
link: '/guide/system',
|
|
||||||
items: [
|
|
||||||
{ text: 'Worker系统 (多线程)', link: '/guide/worker-system' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '场景管理 (Scene)',
|
|
||||||
link: '/guide/scene',
|
|
||||||
items: [
|
|
||||||
{ text: 'SceneManager', link: '/guide/scene-manager' },
|
|
||||||
{ text: 'WorldManager', link: '/guide/world-manager' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '行为树系统 (Behavior Tree)',
|
|
||||||
link: '/guide/behavior-tree/',
|
|
||||||
items: [
|
|
||||||
{ text: '快速开始', link: '/guide/behavior-tree/getting-started' },
|
|
||||||
{ text: '核心概念', link: '/guide/behavior-tree/core-concepts' },
|
|
||||||
{ text: '编辑器指南', link: '/guide/behavior-tree/editor-guide' },
|
|
||||||
{ text: '编辑器工作流', link: '/guide/behavior-tree/editor-workflow' },
|
|
||||||
{ text: '自定义动作组件', link: '/guide/behavior-tree/custom-actions' },
|
|
||||||
{ text: 'Cocos Creator集成', link: '/guide/behavior-tree/cocos-integration' },
|
|
||||||
{ text: 'Laya引擎集成', link: '/guide/behavior-tree/laya-integration' },
|
|
||||||
{ text: '高级用法', link: '/guide/behavior-tree/advanced-usage' },
|
|
||||||
{ text: '最佳实践', link: '/guide/behavior-tree/best-practices' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{ text: '序列化系统 (Serialization)', link: '/guide/serialization' },
|
|
||||||
{ text: '事件系统 (Event)', link: '/guide/event-system' },
|
|
||||||
{ text: '时间和定时器 (Time)', link: '/guide/time-and-timers' },
|
|
||||||
{ text: '日志系统 (Logger)', link: '/guide/logging' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '高级特性',
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{ text: '服务容器 (Service Container)', link: '/guide/service-container' },
|
|
||||||
{ text: '插件系统 (Plugin System)', link: '/guide/plugin-system' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '平台适配器',
|
|
||||||
link: '/guide/platform-adapter',
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{ text: '浏览器适配器', link: '/guide/platform-adapter/browser' },
|
|
||||||
{ text: '微信小游戏适配器', link: '/guide/platform-adapter/wechat-minigame' },
|
|
||||||
{ text: 'Node.js适配器', link: '/guide/platform-adapter/nodejs' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
'/examples/': [
|
|
||||||
{
|
|
||||||
text: '示例',
|
|
||||||
items: [
|
|
||||||
{ text: '示例概览', link: '/examples/' },
|
|
||||||
{ text: 'Worker系统演示', link: '/examples/worker-system-demo' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
],
|
|
||||||
'/api/': [
|
|
||||||
{
|
|
||||||
text: 'API 参考',
|
|
||||||
items: [
|
|
||||||
{ text: '概述', link: '/api/README' },
|
|
||||||
{
|
|
||||||
text: '核心类',
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{ text: 'Core', link: '/api/classes/Core' },
|
|
||||||
{ text: 'Scene', link: '/api/classes/Scene' },
|
|
||||||
{ text: 'World', link: '/api/classes/World' },
|
|
||||||
{ text: 'Entity', link: '/api/classes/Entity' },
|
|
||||||
{ text: 'Component', link: '/api/classes/Component' },
|
|
||||||
{ text: 'EntitySystem', link: '/api/classes/EntitySystem' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '系统类',
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: 'PassiveSystem', link: '/api/classes/PassiveSystem' },
|
|
||||||
{ text: 'ProcessingSystem', link: '/api/classes/ProcessingSystem' },
|
|
||||||
{ text: 'IntervalSystem', link: '/api/classes/IntervalSystem' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '工具类',
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: 'Matcher', link: '/api/classes/Matcher' },
|
|
||||||
{ text: 'Time', link: '/api/classes/Time' },
|
|
||||||
{ text: 'PerformanceMonitor', link: '/api/classes/PerformanceMonitor' },
|
|
||||||
{ text: 'DebugManager', link: '/api/classes/DebugManager' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '接口',
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: 'IScene', link: '/api/interfaces/IScene' },
|
|
||||||
{ text: 'IComponent', link: '/api/interfaces/IComponent' },
|
|
||||||
{ text: 'ISystemBase', link: '/api/interfaces/ISystemBase' },
|
|
||||||
{ text: 'ICoreConfig', link: '/api/interfaces/ICoreConfig' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '装饰器',
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: '@ECSComponent', link: '/api/functions/ECSComponent' },
|
|
||||||
{ text: '@ECSSystem', link: '/api/functions/ECSSystem' }
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: '枚举',
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: 'ECSEventType', link: '/api/enumerations/ECSEventType' },
|
|
||||||
{ text: 'LogLevel', link: '/api/enumerations/LogLevel' }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
|
|
||||||
socialLinks: [
|
socialLinks: [
|
||||||
{ icon: 'github', link: 'https://github.com/esengine/ecs-framework' }
|
{ icon: 'github', link: 'https://github.com/esengine/ecs-framework' }
|
||||||
],
|
],
|
||||||
@@ -212,18 +259,8 @@ export default defineConfig({
|
|||||||
copyright: 'Copyright © 2025 ECS Framework'
|
copyright: 'Copyright © 2025 ECS Framework'
|
||||||
},
|
},
|
||||||
|
|
||||||
editLink: {
|
|
||||||
pattern: 'https://github.com/esengine/ecs-framework/edit/master/docs/:path',
|
|
||||||
text: '在 GitHub 上编辑此页'
|
|
||||||
},
|
|
||||||
|
|
||||||
search: {
|
search: {
|
||||||
provider: 'local'
|
provider: 'local'
|
||||||
},
|
|
||||||
|
|
||||||
outline: {
|
|
||||||
level: [2, 3],
|
|
||||||
label: '在这个页面上'
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -232,8 +269,6 @@ export default defineConfig({
|
|||||||
['link', { rel: 'icon', href: '/favicon.ico' }]
|
['link', { rel: 'icon', href: '/favicon.ico' }]
|
||||||
],
|
],
|
||||||
|
|
||||||
// 使用自定义域名 esengine.cn 时，base 设置为 '/'
|
|
||||||
// 如果部署到 GitHub Pages 子路径，改为 '/ecs-framework/'
|
|
||||||
base: '/',
|
base: '/',
|
||||||
cleanUrls: true,
|
cleanUrls: true,
|
||||||
|
|
||||||
|
|||||||
85
docs/.vitepress/i18n/en.json
Normal file
85
docs/.vitepress/i18n/en.json
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
{
|
||||||
|
"nav": {
|
||||||
|
"home": "Home",
|
||||||
|
"quickStart": "Quick Start",
|
||||||
|
"guide": "Guide",
|
||||||
|
"api": "API",
|
||||||
|
"examples": "Examples",
|
||||||
|
"workerDemo": "Worker System Demo",
|
||||||
|
"lawnMowerDemo": "Lawn Mower Demo"
|
||||||
|
},
|
||||||
|
"sidebar": {
|
||||||
|
"gettingStarted": "Getting Started",
|
||||||
|
"quickStart": "Quick Start",
|
||||||
|
"guideOverview": "Guide Overview",
|
||||||
|
"coreConcepts": "Core Concepts",
|
||||||
|
"entity": "Entity",
|
||||||
|
"hierarchy": "Hierarchy",
|
||||||
|
"component": "Component",
|
||||||
|
"entityQuery": "Entity Query",
|
||||||
|
"system": "System",
|
||||||
|
"workerSystem": "Worker System (Multithreading)",
|
||||||
|
"scene": "Scene",
|
||||||
|
"sceneManager": "SceneManager",
|
||||||
|
"worldManager": "WorldManager",
|
||||||
|
"behaviorTree": "Behavior Tree",
|
||||||
|
"btGettingStarted": "Getting Started",
|
||||||
|
"btCoreConcepts": "Core Concepts",
|
||||||
|
"btEditorGuide": "Editor Guide",
|
||||||
|
"btEditorWorkflow": "Editor Workflow",
|
||||||
|
"btCustomActions": "Custom Actions",
|
||||||
|
"btCocosIntegration": "Cocos Creator Integration",
|
||||||
|
"btLayaIntegration": "Laya Engine Integration",
|
||||||
|
"btAdvancedUsage": "Advanced Usage",
|
||||||
|
"btBestPractices": "Best Practices",
|
||||||
|
"serialization": "Serialization",
|
||||||
|
"eventSystem": "Event System",
|
||||||
|
"timeAndTimers": "Time and Timers",
|
||||||
|
"logging": "Logging",
|
||||||
|
"advancedFeatures": "Advanced Features",
|
||||||
|
"serviceContainer": "Service Container",
|
||||||
|
"pluginSystem": "Plugin System",
|
||||||
|
"platformAdapters": "Platform Adapters",
|
||||||
|
"browserAdapter": "Browser Adapter",
|
||||||
|
"wechatAdapter": "WeChat Mini Game Adapter",
|
||||||
|
"nodejsAdapter": "Node.js Adapter",
|
||||||
|
"examples": "Examples",
|
||||||
|
"examplesOverview": "Examples Overview",
|
||||||
|
"apiReference": "API Reference",
|
||||||
|
"overview": "Overview",
|
||||||
|
"coreClasses": "Core Classes",
|
||||||
|
"systemClasses": "System Classes",
|
||||||
|
"utilities": "Utilities",
|
||||||
|
"interfaces": "Interfaces",
|
||||||
|
"decorators": "Decorators",
|
||||||
|
"enums": "Enums"
|
||||||
|
},
|
||||||
|
"home": {
|
||||||
|
"title": "ESEngine - High-performance TypeScript ECS Framework",
|
||||||
|
"quickLinks": "Quick Links",
|
||||||
|
"viewDocs": "View Docs",
|
||||||
|
"getStarted": "Get Started",
|
||||||
|
"getStartedDesc": "From installation to your first ECS app, learn the core concepts in 5 minutes.",
|
||||||
|
"aiSystem": "AI System",
|
||||||
|
"behaviorTreeEditor": "Visual Behavior Tree Editor",
|
||||||
|
"behaviorTreeDesc": "Built-in AI behavior tree system with visual editing and real-time debugging.",
|
||||||
|
"coreFeatures": "Core Features",
|
||||||
|
"ecsArchitecture": "High-performance ECS Architecture",
|
||||||
|
"ecsArchitectureDesc": "Data-driven entity component system for large-scale entity processing with cache-friendly memory layout.",
|
||||||
|
"typeSupport": "Full Type Support",
|
||||||
|
"typeSupportDesc": "100% TypeScript with complete type definitions and compile-time checking for the best development experience.",
|
||||||
|
"visualBehaviorTree": "Visual Behavior Tree",
|
||||||
|
"visualBehaviorTreeDesc": "Built-in AI behavior tree system with visual editor, custom nodes, and real-time debugging.",
|
||||||
|
"multiPlatform": "Multi-Platform Support",
|
||||||
|
"multiPlatformDesc": "Support for browsers, Node.js, WeChat Mini Games, and seamless integration with major game engines.",
|
||||||
|
"modularDesign": "Modular Design",
|
||||||
|
"modularDesignDesc": "Core features packaged independently, import only what you need. Support for custom plugin extensions.",
|
||||||
|
"devTools": "Developer Tools",
|
||||||
|
"devToolsDesc": "Built-in performance monitoring, debugging tools, serialization system, and complete development toolchain.",
|
||||||
|
"learnMore": "Learn more →"
|
||||||
|
},
|
||||||
|
"common": {
|
||||||
|
"editOnGithub": "Edit this page on GitHub",
|
||||||
|
"onThisPage": "On this page"
|
||||||
|
}
|
||||||
|
}
|
||||||
21
docs/.vitepress/i18n/index.ts
Normal file
21
docs/.vitepress/i18n/index.ts
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
import en from './en.json'
|
||||||
|
import zh from './zh.json'
|
||||||
|
|
||||||
|
export const messages = { en, zh }
|
||||||
|
|
||||||
|
export type Locale = 'en' | 'zh'
|
||||||
|
|
||||||
|
export function getLocaleMessages(locale: Locale) {
|
||||||
|
return messages[locale] || messages.en
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper to get nested key value
|
||||||
|
export function t(messages: typeof en, key: string): string {
|
||||||
|
const keys = key.split('.')
|
||||||
|
let result: any = messages
|
||||||
|
for (const k of keys) {
|
||||||
|
result = result?.[k]
|
||||||
|
if (result === undefined) return key
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
85
docs/.vitepress/i18n/zh.json
Normal file
85
docs/.vitepress/i18n/zh.json
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
{
|
||||||
|
"nav": {
|
||||||
|
"home": "首页",
|
||||||
|
"quickStart": "快速开始",
|
||||||
|
"guide": "指南",
|
||||||
|
"api": "API",
|
||||||
|
"examples": "示例",
|
||||||
|
"workerDemo": "Worker系统演示",
|
||||||
|
"lawnMowerDemo": "割草机演示"
|
||||||
|
},
|
||||||
|
"sidebar": {
|
||||||
|
"gettingStarted": "开始使用",
|
||||||
|
"quickStart": "快速开始",
|
||||||
|
"guideOverview": "指南概览",
|
||||||
|
"coreConcepts": "核心概念",
|
||||||
|
"entity": "实体类 (Entity)",
|
||||||
|
"hierarchy": "层级系统 (Hierarchy)",
|
||||||
|
"component": "组件系统 (Component)",
|
||||||
|
"entityQuery": "实体查询系统",
|
||||||
|
"system": "系统架构 (System)",
|
||||||
|
"workerSystem": "Worker系统 (多线程)",
|
||||||
|
"scene": "场景管理 (Scene)",
|
||||||
|
"sceneManager": "SceneManager",
|
||||||
|
"worldManager": "WorldManager",
|
||||||
|
"behaviorTree": "行为树系统 (Behavior Tree)",
|
||||||
|
"btGettingStarted": "快速开始",
|
||||||
|
"btCoreConcepts": "核心概念",
|
||||||
|
"btEditorGuide": "编辑器指南",
|
||||||
|
"btEditorWorkflow": "编辑器工作流",
|
||||||
|
"btCustomActions": "自定义动作组件",
|
||||||
|
"btCocosIntegration": "Cocos Creator集成",
|
||||||
|
"btLayaIntegration": "Laya引擎集成",
|
||||||
|
"btAdvancedUsage": "高级用法",
|
||||||
|
"btBestPractices": "最佳实践",
|
||||||
|
"serialization": "序列化系统 (Serialization)",
|
||||||
|
"eventSystem": "事件系统 (Event)",
|
||||||
|
"timeAndTimers": "时间和定时器 (Time)",
|
||||||
|
"logging": "日志系统 (Logger)",
|
||||||
|
"advancedFeatures": "高级特性",
|
||||||
|
"serviceContainer": "服务容器 (Service Container)",
|
||||||
|
"pluginSystem": "插件系统 (Plugin System)",
|
||||||
|
"platformAdapters": "平台适配器",
|
||||||
|
"browserAdapter": "浏览器适配器",
|
||||||
|
"wechatAdapter": "微信小游戏适配器",
|
||||||
|
"nodejsAdapter": "Node.js适配器",
|
||||||
|
"examples": "示例",
|
||||||
|
"examplesOverview": "示例概览",
|
||||||
|
"apiReference": "API 参考",
|
||||||
|
"overview": "概述",
|
||||||
|
"coreClasses": "核心类",
|
||||||
|
"systemClasses": "系统类",
|
||||||
|
"utilities": "工具类",
|
||||||
|
"interfaces": "接口",
|
||||||
|
"decorators": "装饰器",
|
||||||
|
"enums": "枚举"
|
||||||
|
},
|
||||||
|
"home": {
|
||||||
|
"title": "ESEngine - 高性能 TypeScript ECS 框架",
|
||||||
|
"quickLinks": "快速入口",
|
||||||
|
"viewDocs": "查看文档",
|
||||||
|
"getStarted": "快速开始",
|
||||||
|
"getStartedDesc": "从安装到创建第一个 ECS 应用，快速了解核心概念。",
|
||||||
|
"aiSystem": "AI 系统",
|
||||||
|
"behaviorTreeEditor": "行为树可视化编辑器",
|
||||||
|
"behaviorTreeDesc": "内置 AI 行为树系统，支持可视化编辑和实时调试。",
|
||||||
|
"coreFeatures": "核心特性",
|
||||||
|
"ecsArchitecture": "高性能 ECS 架构",
|
||||||
|
"ecsArchitectureDesc": "基于数据驱动的实体组件系统，支持大规模实体处理，缓存友好的内存布局。",
|
||||||
|
"typeSupport": "完整类型支持",
|
||||||
|
"typeSupportDesc": "100% TypeScript 编写，完整的类型定义和编译时检查，提供最佳的开发体验。",
|
||||||
|
"visualBehaviorTree": "可视化行为树",
|
||||||
|
"visualBehaviorTreeDesc": "内置 AI 行为树系统，提供可视化编辑器，支持自定义节点和实时调试。",
|
||||||
|
"multiPlatform": "多平台支持",
|
||||||
|
"multiPlatformDesc": "支持浏览器、Node.js、微信小游戏等多平台，可与主流游戏引擎无缝集成。",
|
||||||
|
"modularDesign": "模块化设计",
|
||||||
|
"modularDesignDesc": "核心功能独立打包，按需引入。支持自定义插件扩展，灵活适配不同项目。",
|
||||||
|
"devTools": "开发者工具",
|
||||||
|
"devToolsDesc": "内置性能监控、调试工具、序列化系统等，提供完整的开发工具链。",
|
||||||
|
"learnMore": "了解更多 →"
|
||||||
|
},
|
||||||
|
"common": {
|
||||||
|
"editOnGithub": "在 GitHub 上编辑此页",
|
||||||
|
"onThisPage": "在这个页面上"
|
||||||
|
}
|
||||||
|
}
|
||||||
422
docs/.vitepress/theme/components/ParticleHeroEn.vue
Normal file
422
docs/.vitepress/theme/components/ParticleHeroEn.vue
Normal file
@@ -0,0 +1,422 @@
|
|||||||
|
<script setup>
|
||||||
|
import { onMounted, onUnmounted, ref } from 'vue'
|
||||||
|
|
||||||
|
const canvasRef = ref(null)
|
||||||
|
let animationId = null
|
||||||
|
let particles = []
|
||||||
|
let animationStartTime = null
|
||||||
|
let glowStartTime = null
|
||||||
|
|
||||||
|
// ESEngine particle colors - VS Code style colors (unified with editor)
|
||||||
|
const colors = ['#569CD6', '#4EC9B0', '#9CDCFE', '#C586C0', '#DCDCAA']
|
||||||
|
|
||||||
|
class Particle {
|
||||||
|
constructor(x, y, targetX, targetY) {
|
||||||
|
this.x = x
|
||||||
|
this.y = y
|
||||||
|
this.targetX = targetX
|
||||||
|
this.targetY = targetY
|
||||||
|
this.size = Math.random() * 2 + 1.5
|
||||||
|
this.alpha = Math.random() * 0.5 + 0.5
|
||||||
|
this.color = colors[Math.floor(Math.random() * colors.length)]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function createParticles(canvas, text, fontSize) {
|
||||||
|
const tempCanvas = document.createElement('canvas')
|
||||||
|
const tempCtx = tempCanvas.getContext('2d')
|
||||||
|
if (!tempCtx) return []
|
||||||
|
|
||||||
|
tempCtx.font = `bold ${fontSize}px "Segoe UI", Arial, sans-serif`
|
||||||
|
const textMetrics = tempCtx.measureText(text)
|
||||||
|
const textWidth = textMetrics.width
|
||||||
|
const textHeight = fontSize
|
||||||
|
|
||||||
|
tempCanvas.width = textWidth + 40
|
||||||
|
tempCanvas.height = textHeight + 40
|
||||||
|
tempCtx.font = `bold ${fontSize}px "Segoe UI", Arial, sans-serif`
|
||||||
|
tempCtx.textAlign = 'center'
|
||||||
|
tempCtx.textBaseline = 'middle'
|
||||||
|
tempCtx.fillStyle = '#ffffff'
|
||||||
|
tempCtx.fillText(text, tempCanvas.width / 2, tempCanvas.height / 2)
|
||||||
|
|
||||||
|
const imageData = tempCtx.getImageData(0, 0, tempCanvas.width, tempCanvas.height)
|
||||||
|
const pixels = imageData.data
|
||||||
|
const newParticles = []
|
||||||
|
const gap = 3
|
||||||
|
|
||||||
|
const width = canvas.width / (window.devicePixelRatio || 1)
|
||||||
|
const height = canvas.height / (window.devicePixelRatio || 1)
|
||||||
|
const offsetX = (width - tempCanvas.width) / 2
|
||||||
|
const offsetY = (height - tempCanvas.height) / 2
|
||||||
|
|
||||||
|
for (let y = 0; y < tempCanvas.height; y += gap) {
|
||||||
|
for (let x = 0; x < tempCanvas.width; x += gap) {
|
||||||
|
const index = (y * tempCanvas.width + x) * 4
|
||||||
|
const alpha = pixels[index + 3] || 0
|
||||||
|
|
||||||
|
if (alpha > 128) {
|
||||||
|
const angle = Math.random() * Math.PI * 2
|
||||||
|
const distance = Math.random() * Math.max(width, height)
|
||||||
|
|
||||||
|
newParticles.push(new Particle(
|
||||||
|
width / 2 + Math.cos(angle) * distance,
|
||||||
|
height / 2 + Math.sin(angle) * distance,
|
||||||
|
offsetX + x,
|
||||||
|
offsetY + y
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return newParticles
|
||||||
|
}
|
||||||
|
|
||||||
|
function easeOutQuart(t) {
|
||||||
|
return 1 - Math.pow(1 - t, 4)
|
||||||
|
}
|
||||||
|
|
||||||
|
function easeOutCubic(t) {
|
||||||
|
return 1 - Math.pow(1 - t, 3)
|
||||||
|
}
|
||||||
|
|
||||||
|
function animate(canvas, ctx) {
|
||||||
|
const dpr = window.devicePixelRatio || 1
|
||||||
|
const width = canvas.width / dpr
|
||||||
|
const height = canvas.height / dpr
|
||||||
|
|
||||||
|
const currentTime = performance.now()
|
||||||
|
const duration = 2500
|
||||||
|
const glowDuration = 600
|
||||||
|
|
||||||
|
const elapsed = currentTime - animationStartTime
|
||||||
|
const progress = Math.min(elapsed / duration, 1)
|
||||||
|
const easedProgress = easeOutQuart(progress)
|
||||||
|
|
||||||
|
// Transparent background
|
||||||
|
ctx.clearRect(0, 0, width, height)
|
||||||
|
|
||||||
|
// Calculate glow progress
|
||||||
|
let glowProgress = 0
|
||||||
|
if (progress >= 1) {
|
||||||
|
if (glowStartTime === null) {
|
||||||
|
glowStartTime = currentTime
|
||||||
|
}
|
||||||
|
glowProgress = Math.min((currentTime - glowStartTime) / glowDuration, 1)
|
||||||
|
glowProgress = easeOutCubic(glowProgress)
|
||||||
|
}
|
||||||
|
|
||||||
|
const text = 'ESEngine'
|
||||||
|
const fontSize = Math.min(width / 4, height / 3, 80)
|
||||||
|
const textY = height / 2
|
||||||
|
|
||||||
|
for (const particle of particles) {
|
||||||
|
const moveProgress = Math.min(easedProgress * 1.2, 1)
|
||||||
|
const currentX = particle.x + (particle.targetX - particle.x) * moveProgress
|
||||||
|
const currentY = particle.y + (particle.targetY - particle.y) * moveProgress
|
||||||
|
|
||||||
|
ctx.beginPath()
|
||||||
|
ctx.arc(currentX, currentY, particle.size, 0, Math.PI * 2)
|
||||||
|
ctx.fillStyle = particle.color
|
||||||
|
ctx.globalAlpha = particle.alpha * (1 - glowProgress * 0.3)
|
||||||
|
ctx.fill()
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx.globalAlpha = 1
|
||||||
|
|
||||||
|
if (glowProgress > 0) {
|
||||||
|
ctx.save()
|
||||||
|
ctx.shadowColor = '#3b9eff'
|
||||||
|
ctx.shadowBlur = 30 * glowProgress
|
||||||
|
ctx.fillStyle = `rgba(255, 255, 255, ${glowProgress})`
|
||||||
|
ctx.font = `bold ${fontSize}px "Segoe UI", Arial, sans-serif`
|
||||||
|
ctx.textAlign = 'center'
|
||||||
|
ctx.textBaseline = 'middle'
|
||||||
|
ctx.fillText(text, width / 2, textY)
|
||||||
|
ctx.restore()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (glowProgress >= 1) {
|
||||||
|
const breathe = 0.8 + Math.sin(currentTime / 1000) * 0.2
|
||||||
|
ctx.save()
|
||||||
|
ctx.shadowColor = '#3b9eff'
|
||||||
|
ctx.shadowBlur = 20 * breathe
|
||||||
|
ctx.fillStyle = '#ffffff'
|
||||||
|
ctx.font = `bold ${fontSize}px "Segoe UI", Arial, sans-serif`
|
||||||
|
ctx.textAlign = 'center'
|
||||||
|
ctx.textBaseline = 'middle'
|
||||||
|
ctx.fillText(text, width / 2, textY)
|
||||||
|
ctx.restore()
|
||||||
|
}
|
||||||
|
|
||||||
|
animationId = requestAnimationFrame(() => animate(canvas, ctx))
|
||||||
|
}
|
||||||
|
|
||||||
|
function initCanvas() {
|
||||||
|
const canvas = canvasRef.value
|
||||||
|
if (!canvas) return
|
||||||
|
|
||||||
|
const ctx = canvas.getContext('2d')
|
||||||
|
if (!ctx) return
|
||||||
|
|
||||||
|
const dpr = window.devicePixelRatio || 1
|
||||||
|
const container = canvas.parentElement
|
||||||
|
const width = container.offsetWidth
|
||||||
|
const height = container.offsetHeight
|
||||||
|
|
||||||
|
canvas.width = width * dpr
|
||||||
|
canvas.height = height * dpr
|
||||||
|
canvas.style.width = `${width}px`
|
||||||
|
canvas.style.height = `${height}px`
|
||||||
|
ctx.scale(dpr, dpr)
|
||||||
|
|
||||||
|
const text = 'ESEngine'
|
||||||
|
const fontSize = Math.min(width / 4, height / 3, 80)
|
||||||
|
|
||||||
|
particles = createParticles(canvas, text, fontSize)
|
||||||
|
animationStartTime = performance.now()
|
||||||
|
glowStartTime = null
|
||||||
|
|
||||||
|
if (animationId) {
|
||||||
|
cancelAnimationFrame(animationId)
|
||||||
|
}
|
||||||
|
|
||||||
|
animate(canvas, ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
initCanvas()
|
||||||
|
window.addEventListener('resize', initCanvas)
|
||||||
|
})
|
||||||
|
|
||||||
|
onUnmounted(() => {
|
||||||
|
if (animationId) {
|
||||||
|
cancelAnimationFrame(animationId)
|
||||||
|
}
|
||||||
|
window.removeEventListener('resize', initCanvas)
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<section class="hero-section">
|
||||||
|
<div class="hero-container">
|
||||||
|
<!-- Left text area -->
|
||||||
|
<div class="hero-text">
|
||||||
|
<div class="hero-logo">
|
||||||
|
<svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<circle cx="16" cy="16" r="14" stroke="#9147ff" stroke-width="2"/>
|
||||||
|
<path d="M10 10h8v2h-6v3h5v2h-5v3h6v2h-8v-12z" fill="#9147ff"/>
|
||||||
|
</svg>
|
||||||
|
<span>ESENGINE</span>
|
||||||
|
</div>
|
||||||
|
<h1 class="hero-title">
|
||||||
|
We build the framework.<br/>
|
||||||
|
You create the game.
|
||||||
|
</h1>
|
||||||
|
<p class="hero-description">
|
||||||
|
ESEngine is a high-performance TypeScript ECS framework for game developers.
|
||||||
|
Whether 2D or 3D games, it helps you build scalable game architecture quickly.
|
||||||
|
</p>
|
||||||
|
<div class="hero-actions">
|
||||||
|
<a href="/en/guide/getting-started" class="btn-primary">Get Started</a>
|
||||||
|
<a href="https://github.com/esengine/ecs-framework" class="btn-secondary" target="_blank">Learn More</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Right particle animation area -->
|
||||||
|
<div class="hero-visual">
|
||||||
|
<div class="visual-container">
|
||||||
|
<canvas ref="canvasRef" class="particle-canvas"></canvas>
|
||||||
|
<div class="visual-label">
|
||||||
|
<span class="label-title">Entity Component System</span>
|
||||||
|
<span class="label-subtitle">High Performance Framework</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.hero-section {
|
||||||
|
background: #0d0d0d;
|
||||||
|
padding: 80px 0;
|
||||||
|
min-height: calc(100vh - 64px);
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-container {
|
||||||
|
max-width: 1400px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 0 48px;
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 1fr 1.2fr;
|
||||||
|
gap: 64px;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Left text */
|
||||||
|
.hero-text {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-logo {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 12px;
|
||||||
|
color: #ffffff;
|
||||||
|
font-size: 1rem;
|
||||||
|
font-weight: 700;
|
||||||
|
letter-spacing: 0.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-title {
|
||||||
|
font-size: 3rem;
|
||||||
|
font-weight: 700;
|
||||||
|
color: #ffffff;
|
||||||
|
line-height: 1.2;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-description {
|
||||||
|
font-size: 1.125rem;
|
||||||
|
color: #707070;
|
||||||
|
line-height: 1.7;
|
||||||
|
margin: 0;
|
||||||
|
max-width: 480px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-actions {
|
||||||
|
display: flex;
|
||||||
|
gap: 16px;
|
||||||
|
margin-top: 8px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary,
|
||||||
|
.btn-secondary {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
padding: 14px 28px;
|
||||||
|
border-radius: 4px;
|
||||||
|
font-weight: 600;
|
||||||
|
font-size: 0.9375rem;
|
||||||
|
text-decoration: none;
|
||||||
|
transition: all 0.2s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary {
|
||||||
|
background: #3b9eff;
|
||||||
|
color: #ffffff;
|
||||||
|
border: 1px solid #3b9eff;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary:hover {
|
||||||
|
background: #5aadff;
|
||||||
|
border-color: #5aadff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-secondary {
|
||||||
|
background: #1a1a1a;
|
||||||
|
color: #a0a0a0;
|
||||||
|
border: 1px solid #2a2a2a;
|
||||||
|
border-radius: 6px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-secondary:hover {
|
||||||
|
background: #252525;
|
||||||
|
color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-visual {
|
||||||
|
display: flex;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.visual-container {
|
||||||
|
position: relative;
|
||||||
|
width: 100%;
|
||||||
|
max-width: 600px;
|
||||||
|
aspect-ratio: 4 / 3;
|
||||||
|
background: linear-gradient(135deg, #1a2a3a 0%, #1a1a1a 50%, #0d0d0d 100%);
|
||||||
|
border-radius: 12px;
|
||||||
|
border: 1px solid #2a2a2a;
|
||||||
|
overflow: hidden;
|
||||||
|
box-shadow: 0 20px 60px rgba(59, 158, 255, 0.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
.particle-canvas {
|
||||||
|
position: absolute;
|
||||||
|
top: 0;
|
||||||
|
left: 0;
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.visual-label {
|
||||||
|
position: absolute;
|
||||||
|
bottom: 24px;
|
||||||
|
left: 24px;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 4px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.label-title {
|
||||||
|
font-size: 1.125rem;
|
||||||
|
font-weight: 600;
|
||||||
|
color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.label-subtitle {
|
||||||
|
font-size: 0.875rem;
|
||||||
|
color: #737373;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Responsive */
|
||||||
|
@media (max-width: 1024px) {
|
||||||
|
.hero-container {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
gap: 48px;
|
||||||
|
padding: 0 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-section {
|
||||||
|
padding: 48px 0;
|
||||||
|
min-height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-title {
|
||||||
|
font-size: 2.25rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-description {
|
||||||
|
font-size: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.visual-container {
|
||||||
|
max-width: 100%;
|
||||||
|
aspect-ratio: 16 / 9;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 640px) {
|
||||||
|
.hero-title {
|
||||||
|
font-size: 1.75rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hero-actions {
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.btn-primary,
|
||||||
|
.btn-secondary {
|
||||||
|
width: 100%;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -183,12 +183,22 @@ html:not(.dark) {
|
|||||||
|
|
||||||
.VPContent {
|
.VPContent {
|
||||||
background: var(--es-bg-card) !important;
|
background: var(--es-bg-card) !important;
|
||||||
|
padding-top: 0 !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
.VPContent.has-sidebar {
|
.VPContent.has-sidebar {
|
||||||
background: var(--es-bg-card) !important;
|
background: var(--es-bg-card) !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* 首页布局修复 | Home page layout fix */
|
||||||
|
.VPPage {
|
||||||
|
padding-top: 0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.Layout > .VPContent {
|
||||||
|
padding-top: var(--vp-nav-height) !important;
|
||||||
|
}
|
||||||
|
|
||||||
.VPDoc {
|
.VPDoc {
|
||||||
background: transparent !important;
|
background: transparent !important;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
import DefaultTheme from 'vitepress/theme'
|
import DefaultTheme from 'vitepress/theme'
|
||||||
import ParticleHero from './components/ParticleHero.vue'
|
import ParticleHero from './components/ParticleHero.vue'
|
||||||
|
import ParticleHeroEn from './components/ParticleHeroEn.vue'
|
||||||
import FeatureCard from './components/FeatureCard.vue'
|
import FeatureCard from './components/FeatureCard.vue'
|
||||||
import './custom.css'
|
import './custom.css'
|
||||||
|
|
||||||
@@ -7,6 +8,7 @@ export default {
|
|||||||
extends: DefaultTheme,
|
extends: DefaultTheme,
|
||||||
enhanceApp({ app }) {
|
enhanceApp({ app }) {
|
||||||
app.component('ParticleHero', ParticleHero)
|
app.component('ParticleHero', ParticleHero)
|
||||||
|
app.component('ParticleHeroEn', ParticleHeroEn)
|
||||||
app.component('FeatureCard', FeatureCard)
|
app.component('FeatureCard', FeatureCard)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
412
docs/en/guide/getting-started.md
Normal file
412
docs/en/guide/getting-started.md
Normal file
@@ -0,0 +1,412 @@
|
|||||||
|
# Quick Start
|
||||||
|
|
||||||
|
This guide will help you get started with ECS Framework, from installation to creating your first ECS application.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### NPM Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Using npm
|
||||||
|
npm install @esengine/ecs-framework
|
||||||
|
```
|
||||||
|
|
||||||
|
## Initialize Core
|
||||||
|
|
||||||
|
### Basic Initialization
|
||||||
|
|
||||||
|
The core of ECS Framework is the `Core` class, a singleton that manages the entire framework lifecycle.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core } from '@esengine/ecs-framework'
|
||||||
|
|
||||||
|
// Method 1: Using config object (recommended)
|
||||||
|
const core = Core.create({
|
||||||
|
debug: true, // Enable debug mode for detailed logs and performance monitoring
|
||||||
|
debugConfig: { // Optional: Advanced debug configuration
|
||||||
|
enabled: false, // Whether to enable WebSocket debug server
|
||||||
|
websocketUrl: 'ws://localhost:8080',
|
||||||
|
debugFrameRate: 30, // Debug data send frame rate
|
||||||
|
channels: {
|
||||||
|
entities: true,
|
||||||
|
systems: true,
|
||||||
|
performance: true,
|
||||||
|
components: true,
|
||||||
|
scenes: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Method 2: Simplified creation (backward compatible)
|
||||||
|
const core = Core.create(true); // Equivalent to { debug: true }
|
||||||
|
|
||||||
|
// Method 3: Production environment configuration
|
||||||
|
const core = Core.create({
|
||||||
|
debug: false // Disable debug in production
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Core Configuration Details
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface ICoreConfig {
|
||||||
|
/** Enable debug mode - affects log level and performance monitoring */
|
||||||
|
debug?: boolean;
|
||||||
|
|
||||||
|
/** Advanced debug configuration - for dev tools integration */
|
||||||
|
debugConfig?: {
|
||||||
|
enabled: boolean; // Enable debug server
|
||||||
|
websocketUrl: string; // WebSocket server URL
|
||||||
|
autoReconnect?: boolean; // Auto reconnect
|
||||||
|
debugFrameRate?: 60 | 30 | 15; // Debug data send frame rate
|
||||||
|
channels: { // Data channel configuration
|
||||||
|
entities: boolean; // Entity data
|
||||||
|
systems: boolean; // System data
|
||||||
|
performance: boolean; // Performance data
|
||||||
|
components: boolean; // Component data
|
||||||
|
scenes: boolean; // Scene data
|
||||||
|
};
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Core Instance Management
|
||||||
|
|
||||||
|
Core uses singleton pattern, accessible via static property after creation:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Create instance
|
||||||
|
const core = Core.create(true);
|
||||||
|
|
||||||
|
// Get created instance
|
||||||
|
const instance = Core.Instance; // Returns current instance, null if not created
|
||||||
|
```
|
||||||
|
|
||||||
|
### Game Loop Integration
|
||||||
|
|
||||||
|
**Important**: Before creating entities and systems, you need to understand how to integrate ECS Framework into your game engine.
|
||||||
|
|
||||||
|
`Core.update(deltaTime)` is the framework heartbeat, must be called every frame. It handles:
|
||||||
|
- Updating the built-in Time class
|
||||||
|
- Updating all global managers (timers, object pools, etc.)
|
||||||
|
- Updating all entity systems in all scenes
|
||||||
|
- Processing entity creation and destruction
|
||||||
|
- Collecting performance data (in debug mode)
|
||||||
|
|
||||||
|
See engine integration examples: [Game Engine Integration](#game-engine-integration)
|
||||||
|
|
||||||
|
## Create Your First ECS Application
|
||||||
|
|
||||||
|
### 1. Define Components
|
||||||
|
|
||||||
|
Components are pure data containers that store entity state:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Component, ECSComponent } from '@esengine/ecs-framework'
|
||||||
|
|
||||||
|
// Position component
|
||||||
|
@ECSComponent('Position')
|
||||||
|
class Position extends Component {
|
||||||
|
x: number = 0
|
||||||
|
y: number = 0
|
||||||
|
|
||||||
|
constructor(x: number = 0, y: number = 0) {
|
||||||
|
super()
|
||||||
|
this.x = x
|
||||||
|
this.y = y
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Velocity component
|
||||||
|
@ECSComponent('Velocity')
|
||||||
|
class Velocity extends Component {
|
||||||
|
dx: number = 0
|
||||||
|
dy: number = 0
|
||||||
|
|
||||||
|
constructor(dx: number = 0, dy: number = 0) {
|
||||||
|
super()
|
||||||
|
this.dx = dx
|
||||||
|
this.dy = dy
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sprite component
|
||||||
|
@ECSComponent('Sprite')
|
||||||
|
class Sprite extends Component {
|
||||||
|
texture: string = ''
|
||||||
|
width: number = 32
|
||||||
|
height: number = 32
|
||||||
|
|
||||||
|
constructor(texture: string, width: number = 32, height: number = 32) {
|
||||||
|
super()
|
||||||
|
this.texture = texture
|
||||||
|
this.width = width
|
||||||
|
this.height = height
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Create Entity Systems
|
||||||
|
|
||||||
|
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/ecs-framework'
|
||||||
|
|
||||||
|
// Movement system - handles position and velocity
|
||||||
|
@ECSSystem('MovementSystem')
|
||||||
|
class MovementSystem extends EntitySystem {
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
// Use Matcher to define target entities: must have both Position and Velocity
|
||||||
|
super(Matcher.empty().all(Position, Velocity))
|
||||||
|
}
|
||||||
|
|
||||||
|
protected process(entities: readonly Entity[]): void {
|
||||||
|
// process method receives all matching entities
|
||||||
|
for (const entity of entities) {
|
||||||
|
const position = entity.getComponent(Position)!
|
||||||
|
const velocity = entity.getComponent(Velocity)!
|
||||||
|
|
||||||
|
// Update position (using framework's Time class)
|
||||||
|
position.x += velocity.dx * Time.deltaTime
|
||||||
|
position.y += velocity.dy * Time.deltaTime
|
||||||
|
|
||||||
|
// Boundary check example
|
||||||
|
if (position.x < 0) position.x = 0
|
||||||
|
if (position.y < 0) position.y = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render system - handles visible objects
|
||||||
|
@ECSSystem('RenderSystem')
|
||||||
|
class RenderSystem extends EntitySystem {
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
// Must have Position and Sprite, optional Velocity (for direction)
|
||||||
|
super(Matcher.empty().all(Position, Sprite).any(Velocity))
|
||||||
|
}
|
||||||
|
|
||||||
|
protected process(entities: readonly Entity[]): void {
|
||||||
|
for (const entity of entities) {
|
||||||
|
const position = entity.getComponent(Position)!
|
||||||
|
const sprite = entity.getComponent(Sprite)!
|
||||||
|
const velocity = entity.getComponent(Velocity) // May be null
|
||||||
|
|
||||||
|
// Flip sprite based on velocity direction (optional logic)
|
||||||
|
let flipX = false
|
||||||
|
if (velocity && velocity.dx < 0) {
|
||||||
|
flipX = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Render logic (pseudocode here)
|
||||||
|
this.drawSprite(sprite.texture, position.x, position.y, sprite.width, sprite.height, flipX)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private drawSprite(texture: string, x: number, y: number, width: number, height: number, flipX: boolean = false) {
|
||||||
|
// Actual render implementation depends on your game engine
|
||||||
|
const direction = flipX ? '<-' : '->'
|
||||||
|
console.log(`Render ${texture} at (${x.toFixed(1)}, ${y.toFixed(1)}) direction: ${direction}`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### 3. Create Scene
|
||||||
|
|
||||||
|
Recommended to extend Scene class for custom scenes:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Scene } from '@esengine/ecs-framework'
|
||||||
|
|
||||||
|
// Recommended: Extend Scene for custom scene
|
||||||
|
class GameScene extends Scene {
|
||||||
|
|
||||||
|
initialize(): void {
|
||||||
|
// Scene initialization logic
|
||||||
|
this.name = "MainScene";
|
||||||
|
|
||||||
|
// Add systems to scene
|
||||||
|
this.addSystem(new MovementSystem());
|
||||||
|
this.addSystem(new RenderSystem());
|
||||||
|
}
|
||||||
|
|
||||||
|
onStart(): void {
|
||||||
|
// Logic when scene starts running
|
||||||
|
console.log("Game scene started");
|
||||||
|
}
|
||||||
|
|
||||||
|
unload(): void {
|
||||||
|
// Cleanup logic when scene unloads
|
||||||
|
console.log("Game scene unloaded");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create and set scene
|
||||||
|
const gameScene = new GameScene();
|
||||||
|
Core.setScene(gameScene);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Create Entities
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Create player entity
|
||||||
|
const player = gameScene.createEntity("Player");
|
||||||
|
player.addComponent(new Position(100, 100));
|
||||||
|
player.addComponent(new Velocity(50, 30)); // Move 50px/sec (x), 30px/sec (y)
|
||||||
|
player.addComponent(new Sprite("player.png", 64, 64));
|
||||||
|
```
|
||||||
|
|
||||||
|
## Scene Management
|
||||||
|
|
||||||
|
Core has built-in scene management, very simple to use:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core, Scene } from '@esengine/ecs-framework';
|
||||||
|
|
||||||
|
// Initialize Core
|
||||||
|
Core.create({ debug: true });
|
||||||
|
|
||||||
|
// Create and set scene
|
||||||
|
class GameScene extends Scene {
|
||||||
|
initialize(): void {
|
||||||
|
this.name = "GamePlay";
|
||||||
|
this.addSystem(new MovementSystem());
|
||||||
|
this.addSystem(new RenderSystem());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const gameScene = new GameScene();
|
||||||
|
Core.setScene(gameScene);
|
||||||
|
|
||||||
|
// Game loop (auto-updates scene)
|
||||||
|
function gameLoop(deltaTime: number) {
|
||||||
|
Core.update(deltaTime); // Auto-updates global services and scene
|
||||||
|
}
|
||||||
|
|
||||||
|
// Switch scenes
|
||||||
|
Core.loadScene(new MenuScene()); // Delayed switch (next frame)
|
||||||
|
Core.setScene(new GameScene()); // Immediate switch
|
||||||
|
|
||||||
|
// Access current scene
|
||||||
|
const currentScene = Core.scene;
|
||||||
|
|
||||||
|
// Using fluent API
|
||||||
|
const player = Core.ecsAPI?.createEntity('Player')
|
||||||
|
.addComponent(Position, 100, 100)
|
||||||
|
.addComponent(Velocity, 50, 0);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Advanced: Using WorldManager for Multi-World
|
||||||
|
|
||||||
|
Only for complex server-side applications (MMO game servers, game room systems, etc.):
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core, WorldManager } from '@esengine/ecs-framework';
|
||||||
|
|
||||||
|
// Initialize Core
|
||||||
|
Core.create({ debug: true });
|
||||||
|
|
||||||
|
// Get WorldManager from service container (Core auto-creates and registers it)
|
||||||
|
const worldManager = Core.services.resolve(WorldManager);
|
||||||
|
|
||||||
|
// Create multiple independent game worlds
|
||||||
|
const room1 = worldManager.createWorld('room_001');
|
||||||
|
const room2 = worldManager.createWorld('room_002');
|
||||||
|
|
||||||
|
// Create scenes in each world
|
||||||
|
const gameScene1 = room1.createScene('game', new GameScene());
|
||||||
|
const gameScene2 = room2.createScene('game', new GameScene());
|
||||||
|
|
||||||
|
// Activate scenes
|
||||||
|
room1.setSceneActive('game', true);
|
||||||
|
room2.setSceneActive('game', true);
|
||||||
|
|
||||||
|
// Game loop (need to manually update worlds)
|
||||||
|
function gameLoop(deltaTime: number) {
|
||||||
|
Core.update(deltaTime); // Update global services
|
||||||
|
worldManager.updateAll(); // Manually update all worlds
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Game Engine Integration
|
||||||
|
|
||||||
|
### Laya Engine Integration
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Stage } from "laya/display/Stage";
|
||||||
|
import { Laya } from "Laya";
|
||||||
|
import { Core } from '@esengine/ecs-framework';
|
||||||
|
|
||||||
|
// Initialize Laya
|
||||||
|
Laya.init(800, 600).then(() => {
|
||||||
|
// Initialize ECS
|
||||||
|
Core.create(true);
|
||||||
|
Core.setScene(new GameScene());
|
||||||
|
|
||||||
|
// Start game loop
|
||||||
|
Laya.timer.frameLoop(1, this, () => {
|
||||||
|
const deltaTime = Laya.timer.delta / 1000;
|
||||||
|
Core.update(deltaTime); // Auto-updates global services and scene
|
||||||
|
});
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Cocos Creator Integration
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Component, _decorator } from 'cc';
|
||||||
|
import { Core } from '@esengine/ecs-framework';
|
||||||
|
|
||||||
|
const { ccclass } = _decorator;
|
||||||
|
|
||||||
|
@ccclass('ECSGameManager')
|
||||||
|
export class ECSGameManager extends Component {
|
||||||
|
onLoad() {
|
||||||
|
// Initialize ECS
|
||||||
|
Core.create(true);
|
||||||
|
Core.setScene(new GameScene());
|
||||||
|
}
|
||||||
|
|
||||||
|
update(deltaTime: number) {
|
||||||
|
// Auto-updates global services and scene
|
||||||
|
Core.update(deltaTime);
|
||||||
|
}
|
||||||
|
|
||||||
|
onDestroy() {
|
||||||
|
// Cleanup resources
|
||||||
|
Core.destroy();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
You've successfully created your first ECS application! Next you can:
|
||||||
|
|
||||||
|
- Check the complete [API Documentation](/en/api/README)
|
||||||
|
- Explore more [practical examples](/en/examples/)
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### Why isn't my system executing?
|
||||||
|
|
||||||
|
Ensure:
|
||||||
|
1. System is added to scene: `this.addSystem(system)` (in Scene's initialize method)
|
||||||
|
2. Scene is set: `Core.setScene(scene)`
|
||||||
|
3. Game loop is calling: `Core.update(deltaTime)`
|
||||||
|
|
||||||
|
### How to debug ECS applications?
|
||||||
|
|
||||||
|
Enable debug mode:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
Core.create({ debug: true })
|
||||||
|
|
||||||
|
// Get debug data
|
||||||
|
const debugData = Core.getDebugData()
|
||||||
|
console.log(debugData)
|
||||||
|
```
|
||||||
43
docs/en/guide/index.md
Normal file
43
docs/en/guide/index.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Guide
|
||||||
|
|
||||||
|
Welcome to the ECS Framework Guide. This guide covers the core concepts and usage of the framework.
|
||||||
|
|
||||||
|
## Core Concepts
|
||||||
|
|
||||||
|
### [Entity](./entity.md)
|
||||||
|
Learn the basics of ECS architecture - how to use entities, lifecycle management, and best practices.
|
||||||
|
|
||||||
|
### [Component](./component.md)
|
||||||
|
Learn how to create and use components for modular game feature design.
|
||||||
|
|
||||||
|
### [System](./system.md)
|
||||||
|
Master system development to implement game logic processing.
|
||||||
|
|
||||||
|
### [Entity Query & Matcher](./entity-query.md)
|
||||||
|
Learn to use Matcher for entity filtering and queries with `all`, `any`, `none`, `nothing` conditions.
|
||||||
|
|
||||||
|
### [Scene](./scene.md)
|
||||||
|
Understand scene lifecycle, system management, and entity container features.
|
||||||
|
|
||||||
|
### [Event System](./event-system.md)
|
||||||
|
Master the type-safe event system for component communication and system coordination.
|
||||||
|
|
||||||
|
### [Serialization](./serialization.md)
|
||||||
|
Master serialization for scenes, entities, and components. Supports full and incremental serialization for game saves, network sync, and more.
|
||||||
|
|
||||||
|
### [Time and Timers](./time-and-timers.md)
|
||||||
|
Learn time management and timer systems for precise game logic timing control.
|
||||||
|
|
||||||
|
### [Logging](./logging.md)
|
||||||
|
Master the leveled logging system for debugging, monitoring, and error tracking.
|
||||||
|
|
||||||
|
### [Platform Adapter](./platform-adapter.md)
|
||||||
|
Learn how to implement and register platform adapters for browsers, mini-games, Node.js, and more.
|
||||||
|
|
||||||
|
## Advanced Features
|
||||||
|
|
||||||
|
### [Service Container](./service-container.md)
|
||||||
|
Master dependency injection and service management for loosely-coupled architecture.
|
||||||
|
|
||||||
|
### [Plugin System](./plugin-system.md)
|
||||||
|
Learn how to develop and use plugins to extend framework functionality.
|
||||||
317
docs/en/index.md
Normal file
317
docs/en/index.md
Normal file
@@ -0,0 +1,317 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: ESEngine - High-performance TypeScript ECS Framework
|
||||||
|
---
|
||||||
|
|
||||||
|
<ParticleHeroEn />
|
||||||
|
|
||||||
|
<section class="news-section">
|
||||||
|
<div class="news-container">
|
||||||
|
<div class="news-header">
|
||||||
|
<h2 class="news-title">Quick Links</h2>
|
||||||
|
<a href="/en/guide/" class="news-more">View Docs</a>
|
||||||
|
</div>
|
||||||
|
<div class="news-grid">
|
||||||
|
<a href="/en/guide/getting-started" class="news-card">
|
||||||
|
<div class="news-card-image" style="background: linear-gradient(135deg, #1e3a5f 0%, #1e1e1e 100%);">
|
||||||
|
<div class="news-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 0 24 24"><path fill="#4fc1ff" d="M12 3L1 9l4 2.18v6L12 21l7-3.82v-6l2-1.09V17h2V9zm6.82 6L12 12.72L5.18 9L12 5.28zM17 16l-5 2.72L7 16v-3.73L12 15l5-2.73z"/></svg>
|
||||||
|
</div>
|
||||||
|
<span class="news-badge">Quick Start</span>
|
||||||
|
</div>
|
||||||
|
<div class="news-card-content">
|
||||||
|
<h3>Get Started in 5 Minutes</h3>
|
||||||
|
<p>From installation to your first ECS app, learn the core concepts quickly.</p>
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
<a href="/en/guide/behavior-tree/" class="news-card">
|
||||||
|
<div class="news-card-image" style="background: linear-gradient(135deg, #1e3a5f 0%, #1e1e1e 100%);">
|
||||||
|
<div class="news-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 0 24 24"><path fill="#4ec9b0" d="M12 2a2 2 0 0 1 2 2a2 2 0 0 1-2 2a2 2 0 0 1-2-2a2 2 0 0 1 2-2m3 20h-1v-7l-2-2l-2 2v7H9v-7.5l-2 2V22H6v-6l3-3l1-3.5c-.3.4-.6.7-1 1L6 9v1H4V8l5-3c.5-.3 1.1-.5 1.7-.5H11c.6 0 1.2.2 1.7.5l5 3v2h-2V9l-3 1.5c-.4-.3-.7-.6-1-1l1 3.5l3 3v6Z"/></svg>
|
||||||
|
</div>
|
||||||
|
<span class="news-badge">AI System</span>
|
||||||
|
</div>
|
||||||
|
<div class="news-card-content">
|
||||||
|
<h3>Visual Behavior Tree Editor</h3>
|
||||||
|
<p>Built-in AI behavior tree system with visual editing and real-time debugging.</p>
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="features-section">
|
||||||
|
<div class="features-container">
|
||||||
|
<h2 class="features-title">Core Features</h2>
|
||||||
|
<div class="features-grid">
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#4fc1ff" d="M13 2.05v2.02c3.95.49 7 3.85 7 7.93c0 1.45-.39 2.79-1.06 3.95l1.59 1.09A9.94 9.94 0 0 0 22 12c0-5.18-3.95-9.45-9-9.95M12 19c-3.87 0-7-3.13-7-7c0-3.53 2.61-6.43 6-6.92V2.05c-5.06.5-9 4.76-9 9.95c0 5.52 4.47 10 9.99 10c3.31 0 6.24-1.61 8.06-4.09l-1.6-1.1A7.93 7.93 0 0 1 12 19"/><path fill="#4fc1ff" d="M12 6a6 6 0 0 0-6 6c0 3.31 2.69 6 6 6a6 6 0 0 0 0-12m0 10c-2.21 0-4-1.79-4-4s1.79-4 4-4s4 1.79 4 4s-1.79 4-4 4"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">High-performance ECS Architecture</h3>
|
||||||
|
<p class="feature-desc">Data-driven entity component system for large-scale entity processing with cache-friendly memory layout.</p>
|
||||||
|
<a href="/en/guide/entity" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#569cd6" d="M3 3h18v18H3zm16.525 13.707c0-.795-.272-1.425-.816-1.89c-.544-.465-1.404-.804-2.58-1.016l-1.704-.296c-.616-.104-1.052-.26-1.308-.468c-.256-.21-.384-.468-.384-.776c0-.392.168-.7.504-.924c.336-.224.8-.336 1.392-.336c.56 0 1.008.124 1.344.372c.336.248.536.584.6 1.008h2.016c-.08-.96-.464-1.716-1.152-2.268c-.688-.552-1.6-.828-2.736-.828c-1.2 0-2.148.3-2.844.9c-.696.6-1.044 1.38-1.044 2.34c0 .76.252 1.368.756 1.824c.504.456 1.308.792 2.412.996l1.704.312c.624.12 1.068.28 1.332.48c.264.2.396.46.396.78c0 .424-.192.756-.576.996c-.384.24-.9.36-1.548.36c-.672 0-1.2-.14-1.584-.42c-.384-.28-.608-.668-.672-1.164H8.868c.048 1.016.46 1.808 1.236 2.376c.776.568 1.796.852 3.06.852c1.24 0 2.22-.292 2.94-.876c.72-.584 1.08-1.364 1.08-2.34z"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">Full Type Support</h3>
|
||||||
|
<p class="feature-desc">100% TypeScript with complete type definitions and compile-time checking for the best development experience.</p>
|
||||||
|
<a href="/en/guide/component" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#4ec9b0" d="M12 2C6.5 2 2 6.5 2 12s4.5 10 10 10s10-4.5 10-10S17.5 2 12 2m0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8s8 3.59 8 8s-3.59 8-8 8m-5-8l4-4v3h4v2h-4v3z"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">Visual Behavior Tree</h3>
|
||||||
|
<p class="feature-desc">Built-in AI behavior tree system with visual editor, custom nodes, and real-time debugging.</p>
|
||||||
|
<a href="/en/guide/behavior-tree/" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#c586c0" d="M4 6h18V4H4c-1.1 0-2 .9-2 2v11H0v3h14v-3H4zm19 2h-6c-.55 0-1 .45-1 1v10c0 .55.45 1 1 1h6c.55 0 1-.45 1-1V9c0-.55-.45-1-1-1m-1 9h-4v-7h4z"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">Multi-Platform Support</h3>
|
||||||
|
<p class="feature-desc">Support for browsers, Node.js, WeChat Mini Games, and seamless integration with major game engines.</p>
|
||||||
|
<a href="/en/guide/platform-adapter" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#dcdcaa" d="M4 3h6v2H4v14h6v2H4c-1.1 0-2-.9-2-2V5c0-1.1.9-2 2-2m9 0h6c1.1 0 2 .9 2 2v14c0 1.1-.9 2-2 2h-6v-2h6V5h-6zm-1 7h4v2h-4z"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">Modular Design</h3>
|
||||||
|
<p class="feature-desc">Core features packaged independently, import only what you need. Support for custom plugin extensions.</p>
|
||||||
|
<a href="/en/guide/plugin-system" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
<div class="feature-card">
|
||||||
|
<div class="feature-icon">
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 24 24"><path fill="#9cdcfe" d="M22.7 19l-9.1-9.1c.9-2.3.4-5-1.5-6.9c-2-2-5-2.4-7.4-1.3L9 6L6 9L1.6 4.7C.4 7.1.9 10.1 2.9 12.1c1.9 1.9 4.6 2.4 6.9 1.5l9.1 9.1c.4.4 1 .4 1.4 0l2.3-2.3c.5-.4.5-1.1.1-1.4"/></svg>
|
||||||
|
</div>
|
||||||
|
<h3 class="feature-title">Developer Tools</h3>
|
||||||
|
<p class="feature-desc">Built-in performance monitoring, debugging tools, serialization system, and complete development toolchain.</p>
|
||||||
|
<a href="/en/guide/logging" class="feature-link">Learn more</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
/* Home page specific styles */
|
||||||
|
.news-section {
|
||||||
|
background: #0d0d0d;
|
||||||
|
padding: 64px 0;
|
||||||
|
border-top: 1px solid #2a2a2a;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-container {
|
||||||
|
max-width: 1400px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 0 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-header {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
align-items: center;
|
||||||
|
margin-bottom: 32px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-title {
|
||||||
|
font-size: 1.5rem;
|
||||||
|
font-weight: 700;
|
||||||
|
color: #ffffff;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-more {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 10px 20px;
|
||||||
|
background: #1a1a1a;
|
||||||
|
border: 1px solid #2a2a2a;
|
||||||
|
border-radius: 6px;
|
||||||
|
color: #a0a0a0;
|
||||||
|
font-size: 0.875rem;
|
||||||
|
font-weight: 500;
|
||||||
|
text-decoration: none;
|
||||||
|
transition: all 0.2s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-more:hover {
|
||||||
|
background: #252525;
|
||||||
|
color: #ffffff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(2, 1fr);
|
||||||
|
gap: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card {
|
||||||
|
display: flex;
|
||||||
|
background: #1f1f1f;
|
||||||
|
border: 1px solid #2a2a2a;
|
||||||
|
border-radius: 12px;
|
||||||
|
overflow: hidden;
|
||||||
|
text-decoration: none;
|
||||||
|
transition: all 0.2s;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card:hover {
|
||||||
|
border-color: #3b9eff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card-image {
|
||||||
|
width: 200px;
|
||||||
|
min-height: 140px;
|
||||||
|
flex-shrink: 0;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
padding: 16px;
|
||||||
|
gap: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-icon {
|
||||||
|
opacity: 0.9;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-badge {
|
||||||
|
display: inline-block;
|
||||||
|
padding: 4px 12px;
|
||||||
|
background: transparent;
|
||||||
|
border: 1px solid #3a3a3a;
|
||||||
|
border-radius: 16px;
|
||||||
|
color: #a0a0a0;
|
||||||
|
font-size: 0.75rem;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card-content {
|
||||||
|
padding: 20px;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card-content h3 {
|
||||||
|
font-size: 1.125rem;
|
||||||
|
font-weight: 600;
|
||||||
|
color: #ffffff;
|
||||||
|
margin: 0 0 8px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card-content p {
|
||||||
|
font-size: 0.875rem;
|
||||||
|
color: #707070;
|
||||||
|
margin: 0;
|
||||||
|
line-height: 1.6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-section {
|
||||||
|
background: #0d0d0d;
|
||||||
|
padding: 64px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-container {
|
||||||
|
max-width: 1400px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 0 48px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-title {
|
||||||
|
font-size: 1.5rem;
|
||||||
|
font-weight: 700;
|
||||||
|
color: #ffffff;
|
||||||
|
margin: 0 0 32px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(3, 1fr);
|
||||||
|
gap: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-card {
|
||||||
|
background: #1f1f1f;
|
||||||
|
border: 1px solid #2a2a2a;
|
||||||
|
border-radius: 12px;
|
||||||
|
padding: 24px;
|
||||||
|
transition: all 0.15s ease;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-card:hover {
|
||||||
|
border-color: #3b9eff;
|
||||||
|
background: #252525;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-icon {
|
||||||
|
width: 48px;
|
||||||
|
height: 48px;
|
||||||
|
background: #0d0d0d;
|
||||||
|
border-radius: 10px;
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
margin-bottom: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-title {
|
||||||
|
font-size: 16px;
|
||||||
|
font-weight: 600;
|
||||||
|
color: #ffffff;
|
||||||
|
margin: 0 0 8px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-desc {
|
||||||
|
font-size: 14px;
|
||||||
|
color: #707070;
|
||||||
|
line-height: 1.7;
|
||||||
|
margin: 0 0 16px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-link {
|
||||||
|
font-size: 14px;
|
||||||
|
color: #3b9eff;
|
||||||
|
text-decoration: none;
|
||||||
|
font-weight: 500;
|
||||||
|
}
|
||||||
|
|
||||||
|
.feature-link:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 1024px) {
|
||||||
|
.news-container,
|
||||||
|
.features-container {
|
||||||
|
padding: 0 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-grid {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-grid {
|
||||||
|
grid-template-columns: repeat(2, 1fr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 768px) {
|
||||||
|
.news-card {
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.news-card-image {
|
||||||
|
width: 100%;
|
||||||
|
min-height: 120px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.features-grid {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -96,20 +96,8 @@ title: ESEngine - 高性能 TypeScript ECS 框架
|
|||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<style>
|
<style scoped>
|
||||||
/* 隐藏 VitePress 默认样式 */
|
/* 首页专用样式 | Home page specific styles */
|
||||||
.VPDoc {
|
|
||||||
padding: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.vp-doc {
|
|
||||||
padding: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.VPContent {
|
|
||||||
padding: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.news-section {
|
.news-section {
|
||||||
background: #0d0d0d;
|
background: #0d0d0d;
|
||||||
padding: 64px 0;
|
padding: 64px 0;
|
||||||
|
|||||||
Reference in New Issue
Block a user