From 848b637f45edd19a7b24a2a64987bacb117b88ec Mon Sep 17 00:00:00 2001
From: YHH <359807859@qq.com>
Date: Sat, 18 Oct 2025 23:45:34 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A2=9E=E5=BC=BA=20README=E5=8F=AF?=
=?UTF-8?q?=E8=A7=86=E5=8C=96=E5=92=8C=E7=BB=9F=E8=AE=A1=E5=B1=95=E7=A4=BA?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.all-contributorsrc | 111 +++++++++++++++++++++++---------------------
README.md | 92 +++++++++++++++++++++++++++++++++++-
2 files changed, 150 insertions(+), 53 deletions(-)
diff --git a/.all-contributorsrc b/.all-contributorsrc
index 3dcb6762..cc877244 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -1,55 +1,62 @@
{
- "projectName": "ecs-framework",
- "projectOwner": "esengine",
- "repoType": "github",
- "repoHost": "https://github.com",
- "files": [
- "README.md"
- ],
- "imageSize": 100,
- "commit": true,
- "commitConvention": "angular",
- "contributors": [],
- "contributorsPerLine": 7,
- "contributorsSortAlphabetically": false,
- "badgeTemplate": "[](#contributors)",
- "contributorTemplate": "\">![](\"<%=)
\" width=\"<%= options.imageSize %>px;\" alt=\"<%= contributor.name %>\"/>
<%= contributor.name %>",
- "types": {
- "code": {
- "symbol": "💻",
- "description": "Code",
- "link": "[<%= symbol %>](<%= url %> \"Code\")"
+ "projectName": "ecs-framework",
+ "projectOwner": "esengine",
+ "repoType": "github",
+ "repoHost": "https://github.com",
+ "files": ["README.md"],
+ "imageSize": 100,
+ "commit": true,
+ "commitConvention": "angular",
+ "contributors": [
+ {
+ "login": "yhh",
+ "name": "Frank Huang",
+ "avatar_url": "https://avatars.githubusercontent.com/u/145575?v=4",
+ "profile": "https://github.com/yhh",
+ "contributions": ["code"]
+ }
+ ],
+ "contributorsPerLine": 7,
+ "contributorsSortAlphabetically": false,
+ "badgeTemplate": "[](#contributors)",
+ "contributorTemplate": "\">\" width=\"<%= options.imageSize %>px;\" alt=\"<%= contributor.name %>\"/>
<%= contributor.name %>",
+ "types": {
+ "code": {
+ "symbol": "💻",
+ "description": "Code",
+ "link": "[<%= symbol %>](<%= url %> \"Code\")"
+ },
+ "doc": {
+ "symbol": "📖",
+ "description": "Documentation",
+ "link": "[<%= symbol %>](<%= url %> \"Documentation\")"
+ },
+ "test": {
+ "symbol": "⚠️",
+ "description": "Tests",
+ "link": "[<%= symbol %>](<%= url %> \"Tests\")"
+ },
+ "bug": {
+ "symbol": "🐛",
+ "description": "Bug reports",
+ "link": "[<%= symbol %>](<%= url %> \"Bug reports\")"
+ },
+ "example": {
+ "symbol": "💡",
+ "description": "Examples",
+ "link": "[<%= symbol %>](<%= url %> \"Examples\")"
+ },
+ "design": {
+ "symbol": "🎨",
+ "description": "Design",
+ "link": "[<%= symbol %>](<%= url %> \"Design\")"
+ },
+ "ideas": {
+ "symbol": "🤔",
+ "description": "Ideas & Planning",
+ "link": "[<%= symbol %>](<%= url %> \"Ideas & Planning\")"
+ }
},
- "doc": {
- "symbol": "📖",
- "description": "Documentation",
- "link": "[<%= symbol %>](<%= url %> \"Documentation\")"
- },
- "test": {
- "symbol": "⚠️",
- "description": "Tests",
- "link": "[<%= symbol %>](<%= url %> \"Tests\")"
- },
- "bug": {
- "symbol": "🐛",
- "description": "Bug reports",
- "link": "[<%= symbol %>](<%= url %> \"Bug reports\")"
- },
- "example": {
- "symbol": "💡",
- "description": "Examples",
- "link": "[<%= symbol %>](<%= url %> \"Examples\")"
- },
- "design": {
- "symbol": "🎨",
- "description": "Design",
- "link": "[<%= symbol %>](<%= url %> \"Design\")"
- },
- "ideas": {
- "symbol": "🤔",
- "description": "Ideas & Planning",
- "link": "[<%= symbol %>](<%= url %> \"Ideas & Planning\")"
- }
- },
- "skipCi": true
+ "skipCi": true
}
+
diff --git a/README.md b/README.md
index d7c8852f..a28daaaf 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,43 @@
[](https://github.com/esengine/ecs-framework/stargazers)
[](https://deepwiki.com/esengine/ecs-framework)
-一个高性能的 TypeScript ECS (Entity-Component-System) 框架，专为现代游戏开发而设计。
+
+
+
一个高性能的 TypeScript ECS (Entity-Component-System) 框架，专为现代游戏开发而设计。
+
+
A high-performance TypeScript ECS (Entity-Component-System) framework designed for modern game development.
+
+
+
+[](https://star-history.com/#esengine/ecs-framework&Date)
+
+
+
+
+
+### 📈 下载趋势 / Download Trends
+
+
+
+[](https://www.npmjs.com/package/@esengine/ecs-framework)
+
+[](https://npmtrends.com/@esengine/ecs-framework)
+
+
+
+---
## 特性
@@ -96,6 +132,30 @@ function gameLoop(deltaTime: number) {
- **多场景** - 支持 World/Scene 分层架构
- **时间管理** - 内置定时器和时间控制系统
+## 🏗️ 架构设计 / Architecture
+
+```mermaid
+graph TB
+ A[Core 核心] --> B[World 世界]
+ B --> C[Scene 场景]
+ C --> D[EntityManager 实体管理器]
+ C --> E[SystemManager 系统管理器]
+ D --> F[Entity 实体]
+ F --> G[Component 组件]
+ E --> H[EntitySystem 实体系统]
+ E --> I[WorkerSystem 工作线程系统]
+
+ style A fill:#e1f5ff
+ style B fill:#fff3e0
+ style C fill:#f3e5f5
+ style D fill:#e8f5e9
+ style E fill:#fff9c4
+ style F fill:#ffebee
+ style G fill:#e0f2f1
+ style H fill:#fce4ec
+ style I fill:#f1f8e9
+```
+
## 平台支持
支持主流游戏引擎和 Web 平台：
@@ -159,9 +219,28 @@ function gameLoop(deltaTime: number) {
- [路径寻找](https://github.com/esengine/ecs-astar) - A*、BFS、Dijkstra 算法
- [AI 系统](https://github.com/esengine/BehaviourTree-ai) - 行为树、效用 AI
+## 💪 支持项目 / Support the Project
+
+如果这个项目对你有帮助，请考虑：
+
+If this project helps you, please consider:
+
+
+
+[](https://github.com/sponsors/esengine)
+[](https://github.com/esengine/ecs-framework)
+
+
+
+- ⭐ 给项目点个 Star
+- 🐛 报告 Bug 或提出新功能
+- 📝 改进文档
+- 💖 成为赞助者
+
## 社区与支持
- [问题反馈](https://github.com/esengine/ecs-framework/issues) - Bug 报告和功能建议
+- [讨论区](https://github.com/esengine/ecs-framework/discussions) - 提问、分享想法
- [QQ 交流群](https://jq.qq.com/?_wv=1027&k=29w1Nud6) - ecs游戏框架交流
## 贡献者 / Contributors
@@ -173,8 +252,19 @@ Thanks goes to these wonderful people:
+
+
+
本项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 规范。欢迎任何形式的贡献！
