Update README.md

This commit is contained in:
Mikhail 2023-05-25 17:40:19 +08:00 committed by GitHub
parent 816cd59a4f
commit 1e34dc2acd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,4 +1,3 @@
<p align="center"> <p align="center">
<img width="660" src="https://github.com/DCFApixels/DragonECS/assets/99481254/176e13c8-20c8-4e7a-8eaf-e8f3ca590231.png"> <img width="660" src="https://github.com/DCFApixels/DragonECS/assets/99481254/176e13c8-20c8-4e7a-8eaf-e8f3ca590231.png">
</p> </p>
@ -8,17 +7,29 @@
> **ВАЖНО!** Проект в стадии разработки. API может меняться. README так же не завершен. > **ВАЖНО!** Проект в стадии разработки. API может меняться. README так же не завершен.
## Оглавление ## Оглавление
* [Установка](#Установка)
* [Unity-модуль](#Unity-модуль)
* [В виде иходников](#В-виде-иходников)
* [Основные концепции](#Основные-концепции) * [Основные концепции](#Основные-концепции)
* [Сущность](#Сущность) * [Сущность](#Сущность)
* [Компонент](#Компонент) * [Компонент](#Компонент)
* [Система](#Система) * [Система](#Система)
* [Pipeline](#Pipeline) * [Pipeline](#Pipeline)
* [Процесс/Раннер](#Процесс-Раннер) * [Процесс и Раннер](#Процесс-и-Раннер)
* [Группа](#Группа) * [Группа](#Группа)
* [Субъект](#Субъект) * [Субъект](#Субъект)
* [Запрос](#Запрос) * [Запрос](#Запрос)
* [Расширения](#Расширения) * [Расширения](#Расширения)
# Установка
* ### Unity-модуль
Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или редактирования `Packages/manifest.json`:
```
https://github.com/DCFApixels/DragonECS.git
```
* ### В виде иходников
Фреймворк так же может быть добавлен в проект в виде исходников.
# Основные концепции # Основные концепции
## Сущность ## Сущность
Сущности - это идентификаторы, к которым крепятся данные. Есть 2 типа идентификатора: Сущности - это идентификаторы, к которым крепятся данные. Есть 2 типа идентификатора:
@ -64,7 +75,7 @@ class UserSystem : IEcsPreInitProcess, IEcsInitProcess, IEcsRunProcess, IEcsDest
## Pipeline ## Pipeline
Является двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы. Является двжиком систем, определяя поочередность их вызова, предоставляющий механизм для сообщений между системами и механизм внедрения зависимостей в системы.
## Процесс/Раннер ## Процесс и Раннер
Процессы - это очереди систем реализующие общий интерфейс. Раннеры запускюат выполнение процессов. Система раннеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>(). Процессы - это очереди систем реализующие общий интерфейс. Раннеры запускюат выполнение процессов. Система раннеров и процессов может использоваться для создания реактивного поведения или для управления очередью вызова систем. Встроенные процессы вызываются автоматически, для ручного запуска испольщуйте раннеры получаемые из EcsPipeline.GetRunner<TInterface>().
> Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры. > Метод GetRunner относительно медленный, поэтому рекомендуется кешировать полученные раннеры.