mirror of
https://github.com/DCFApixels/DragonECS.git
synced 2025-09-18 01:44:35 +08:00
68 lines
3.6 KiB
Markdown
68 lines
3.6 KiB
Markdown
<p align="center">
|
|
<img width="660" src="https://github.com/DCFApixels/DragonECS/assets/99481254/c09e385e-08c1-4c04-904a-36ad7e25e45b">
|
|
</p>
|
|
|
|
<!--<a href="https://discord.gg/kqmJjExuCf"><img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%2300b269&label=Discord&logo=Discord&logoColor=%23ffffff&style=for-the-badge"></a>-->
|
|
|
|
<p align="center">
|
|
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS?color=%23ff4e85&style=for-the-badge">
|
|
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/DragonECS?color=ff4e85&style=for-the-badge">
|
|
<a href="https://discord.gg/kqmJjExuCf"><img alt="Discord" src="https://img.shields.io/badge/Discord-JOIN-00b269?logo=discord&logoColor=%23ffffff&style=for-the-badge"></a>
|
|
<a href="http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=IbDcH43vhfArb30luGMP1TMXB3GCHzxm&authKey=s%2FJfqvv46PswFq68irnGhkLrMR6y9tf%2FUn2mogYizSOGiS%2BmB%2B8Ar9I%2Fnr%2Bs4oS%2B&noverify=0&group_code=949562781"><img alt="QQ" src="https://img.shields.io/badge/QQ-JOIN-00b269?logo=tencentqq&logoColor=%23ffffff&style=for-the-badge"></a>
|
|
</p>
|
|
|
|
# DragonECS - C# Entity Component System Framework
|
|
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS) |
|
|
| :--- | :--- | :--- |
|
|
|
|
The [ECS](https://en.wikipedia.org/wiki/Entity_component_system) Framework aims to maximize usability, modularity, extensibility and performance of dynamic entity changes. Without code generation and dependencies. Inspired by [LeoEcs](https://github.com/Leopotam/ecslite).
|
|
|
|
> [!WARNING]
|
|
> The project is a work in progress, API may change.
|
|
>
|
|
> While the English version of the README is incomplete, you can view the [Russian version](https://github.com/DCFApixels/DragonECS/blob/main/README-RU.md).
|
|
|
|
</br>
|
|
|
|
# Installation
|
|
Versioning semantics - [Open](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
|
## Environment
|
|
Requirements:
|
|
+ Minimum version of C# 7.3;
|
|
|
|
Optional:
|
|
+ Support for NativeAOT
|
|
+ Game engines with C#: Unity, Godot, MonoGame, etc.
|
|
|
|
Tested with:
|
|
+ **Unity:** Minimum version 2020.1.0;
|
|
|
|
## Unity Installation
|
|
* ### Unity Package
|
|
The framework can be installed as a Unity package by adding the Git URL [in the PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) or manually adding it to `Packages/manifest.json`:
|
|
```
|
|
https://github.com/DCFApixels/DragonECS.git
|
|
```
|
|
* ### Source Code
|
|
The framework can also be added to the project as source code.
|
|
|
|
</br>
|
|
|
|
# Projects powered by DragonECS
|
|
* [3D Platformer (Example)](https://github.com/DCFApixels/3D-Platformer-DragonECS)
|
|
|
|
</br>
|
|
|
|
# Extensions
|
|
* [Unity integration](https://github.com/DCFApixels/DragonECS-Unity)
|
|
* [Dependency autoinjections](https://github.com/DCFApixels/DragonECS-AutoInjections)
|
|
* [Classic C# multithreading](https://github.com/DCFApixels/DragonECS-ClassicThreads)
|
|
* [Hybrid](https://github.com/DCFApixels/DragonECS-Hybrid)
|
|
* [One-Frame Components](https://gist.github.com/DCFApixels/46d512dbcf96c115b94c3af502461f60)
|
|
* [Code Templates for IDE](https://gist.github.com/ctzcs/0ba948b0e53aa41fe1c87796a401660b) and [for Unity](https://gist.github.com/ctzcs/d4c7730cf6cd984fe6f9e0e3f108a0f1)
|
|
* Graphs (Work in progress)
|
|
|
|
# Feedback
|
|
+ Discord (RU-EN) [https://discord.gg/kqmJjExuCf](https://discord.gg/kqmJjExuCf)
|
|
+ QQ (中文) [949562781](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=IbDcH43vhfArb30luGMP1TMXB3GCHzxm&authKey=s%2FJfqvv46PswFq68irnGhkLrMR6y9tf%2FUn2mogYizSOGiS%2BmB%2B8Ar9I%2Fnr%2Bs4oS%2B&noverify=0&group_code=949562781)
|