+ + ESEngine +
+ + Cross-platform 2D Game Engine +
-**[Documentation](https://esengine.github.io/ecs-framework/) | [API Reference](https://esengine.github.io/ecs-framework/api/) | [Examples](./examples/)** +
+ 
+ English | 中文 +
+ ++ Documentation · + API Reference · + Download Editor · + Examples +
+ +--- ESEngine is a cross-platform 2D game engine for creating games from a unified interface. It provides a comprehensive set of common tools so that developers can focus on making games without having to reinvent the wheel. @@ -190,7 +213,7 @@ ESEngine Editor is a cross-platform desktop application built with Tauri and Rea ```bash # Clone repository git clone https://github.com/esengine/esengine.git -cd ecs-framework +cd esengine # Install dependencies pnpm install @@ -212,7 +235,7 @@ pnpm tauri:dev ### Project Structure ``` -ecs-framework/ +esengine/ ├── packages/ Engine packages (runtime, editor, platform) ├── docs/ Documentation source ├── examples/ Example projects diff --git a/README_CN.md b/README_CN.md index eca87ab7..59e2cc75 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,8 +1,31 @@ -# ESEngine +
+ + 跨平台 2D 游戏引擎 +
-**[文档](https://esengine.github.io/ecs-framework/) | [API 参考](https://esengine.github.io/ecs-framework/api/) | [示例](./examples/)** +
+
+ English | 中文 +
+ + + +--- ESEngine 是一个跨平台 2D 游戏引擎，提供统一的开发界面。它包含完整的常用工具集，让开发者专注于游戏创作本身。 @@ -190,7 +213,7 @@ ESEngine 编辑器是基于 Tauri 和 React 构建的跨平台桌面应用。 ```bash # 克隆仓库 git clone https://github.com/esengine/esengine.git -cd ecs-framework +cd esengine # 安装依赖 pnpm install @@ -212,7 +235,7 @@ pnpm tauri:dev ### 项目结构 ``` -ecs-framework/ +esengine/ ├── packages/ 引擎包（运行时、编辑器、平台） ├── docs/ 文档源码 ├── examples/ 示例项目 diff --git a/SECURITY.md b/SECURITY.md index a107b4a5..60df0522 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,13 +1,71 @@ +# Security Policy / 安全政策 + +**English** | [中文](#安全政策-1) + +## Supported Versions + +We provide security updates for the following versions: + +| Version | Supported | +| ------- | ------------------ | +| 2.x.x | :white_check_mark: | +| 1.x.x | :x: | + +## Reporting a Vulnerability + +If you discover a security vulnerability, please report it through the following channels: + +### Reporting Channels + +- **GitHub Security Advisories**: [Report a vulnerability](https://github.com/esengine/esengine/security/advisories/new) (Recommended) +- **Email**: security@esengine.dev + +### Reporting Guidelines + +1. **Do NOT** report security vulnerabilities in public issues +2. Provide a detailed description of the vulnerability, including: + - Affected versions + - Steps to reproduce + - Potential impact + - Suggested fix (if available) + +### Response Timeline + +- **Acknowledgment**: Within 72 hours +- **Initial Assessment**: Within 1 week +- **Fix Release**: Typically within 2-4 weeks, depending on severity + +### Process + +1. We will confirm the existence and severity of the vulnerability +2. Develop and test a fix +3. Release a security update +4. Publicly disclose the vulnerability details after the fix is released + +## Security Best Practices + +When using ESEngine, please follow these security recommendations: + +- Always use the latest stable version +- Regularly update dependencies +- Disable debug mode in production +- Validate all external input data +- Do not store sensitive information on the client side + +--- + # 安全政策 +[English](#security-policy--安全政策) | **中文** + ## 支持的版本 我们为以下版本提供安全更新： | 版本 | 支持状态 | | ------- | ------------------ | -| 2.0.x | :white_check_mark: | -| 1.0.x | :x: | +| 2.x.x | :white_check_mark: | +| 1.x.x | :x: | ## 报告漏洞 @@ -15,10 +73,10 @@ ### 报告渠道 -- **邮箱**: [安全邮箱将在实际部署时提供] -- **GitHub**: 创建私有安全报告（推荐） +- **GitHub 安全公告**: [报告漏洞](https://github.com/esengine/esengine/security/advisories/new)（推荐） +- **邮箱**: security@esengine.dev -### 报告流程 +### 报告指南 1. **不要**在公开的 issue 中报告安全漏洞 2. 提供详细的漏洞描述，包括： @@ -40,9 +98,9 @@ 3. 发布安全更新 4. 在修复发布后，会在相关渠道公布漏洞详情 -### 安全最佳实践 +## 安全最佳实践 -使用 ECS Framework 时，请遵循以下安全建议： +使用 ESEngine 时，请遵循以下安全建议： - 始终使用最新的稳定版本 - 定期更新依赖项 @@ -50,4 +108,6 @@ - 验证所有外部输入数据 - 不要在客户端存储敏感信息 -感谢您帮助保持 ECS Framework 的安全性！ +感谢您帮助保持 ESEngine 的安全性！ + +Thank you for helping keep ESEngine secure! diff --git a/docs/public/logo.svg b/docs/public/logo.svg new file mode 100644 index 00000000..5a54f816 --- /dev/null +++ b/docs/public/logo.svg @@ -0,0 +1,45 @@ + diff --git a/packages/core/tests/integration/IdentifierPool.integration.test.ts b/packages/core/tests/integration/IdentifierPool.integration.test.ts index 05aa8469..52652c00 100644 --- a/packages/core/tests/integration/IdentifierPool.integration.test.ts +++ b/packages/core/tests/integration/IdentifierPool.integration.test.ts @@ -100,27 +100,6 @@ describe('IdentifierPool 集成测试', () => { }); }); - describe('性能和内存验证', () => { - test('ID分配性能应该满足要求', () => { - const count = 1000; - const startTime = performance.now(); - - for (let i = 0; i < count; i++) { - scene.createEntity(`PerfTest_${i}`); - } - - const endTime = performance.now(); - const duration = endTime - startTime; - - // 1000个实体应该在100ms内创建完成 - expect(duration).toBeLessThan(100); - - // 验证内存使用合理（动态分配应该更高效） - const stats = scene.identifierPool.getStats(); - expect(stats.memoryUsage).toBeLessThan(1000 * 100); // 每个实体少于100字节 - }); - - }); describe('向后兼容性', () => { test('现有的Entity API应该继续工作', () => {