Skip to content

TokiraNeo/NekiraECS

Repository files navigation

NekiraECSLib

GitHub License GitHub top language C++ Std CMake Version GitHub commit activity

CI Code Quality Documentation Release

README CN README EN

概述

NekiraECSLib 是基于 C++20 的 ECS 框架库。

事项

  • 基础的 Entity、Component、System、Coordinator
  • 基于稀疏集的基本 ECS 框架
  • 组件存储的进一步优化
  • 多组件的 view 查询机制
  • 事件系统、缓存系统、任务流程系统

CI/CD

本项目集成了完整的持续集成和持续部署流程:

🔧 持续集成 (CI)

  • 多平台构建: 支持 Linux、Windows、macOS
  • 多编译器支持: GCC、Clang、MSVC
  • 自动化测试: 每次提交都会运行完整的测试套件
  • 代码质量检查: 自动检查代码格式和静态分析

📊 代码质量

  • 格式检查: 使用 clang-format 确保代码风格一致
  • 静态分析: 使用 clang-tidy 进行代码质量分析
  • 安全扫描: 集成 CodeQL 进行安全漏洞检测

🚀 自动化发布

  • 版本标签: 推送版本标签自动触发发布流程
  • 构建产物: 自动构建多平台的发布包
  • GitHub Releases: 自动创建 GitHub 发布页面

📚 文档生成

  • API 文档: 自动生成并发布 Doxygen 文档
  • 文档检查: 验证文档完整性和链接有效性

安装

克隆仓库至本地,使用 cmake 构建

cmake -S . -B build -G "Ninja"
cmake --build build
cmake --install build [--prefix] [install_dir]

链接库

find_package(NekiraECSLib REQUIRED)

target_link_libraries(YourTarget PRIVATE NekiraECSLib::NekiraECSCore)
target_include_directories(YourTarget PRIVATE ${NekiraECSLib_INCLUDE_DIRS})

文档

NekiraECSCore

License

License

About

A Simple Entity-Component-System frame based on C++20.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors