mirror of
https://github.com/DCFApixels/DragonECS-Unity.git
synced 2025-09-18 01:54:35 +08:00
update readme
This commit is contained in:
parent
4ba850728f
commit
b51cffae4e
35
README.md
35
README.md
@ -5,8 +5,39 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-Unity?color=%23ff4e85&style=for-the-badge">
|
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-Unity?color=%23ff4e85&style=for-the-badge">
|
||||||
<img alt="GitHub" src="https://img.shields.io/github/license/DCFApixels/DragonECS-Unity?color=ff4e85&style=for-the-badge">
|
<img alt="GitHub" src="https://img.shields.io/github/license/DCFApixels/DragonECS-Unity?color=ff4e85&style=for-the-badge">
|
||||||
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
|
<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>
|
</p>
|
||||||
|
|
||||||
# Integration with Unity for [DragonECS](https://github.com/DCFApixels/DragonECS)
|
# Integration with Unity for [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||||
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
|
|
||||||
|
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) |
|
||||||
|
| :--- | :--- | :--- |
|
||||||
|
|
||||||
|
The extension is designed to reduce the amount of code by simplifying dependency injection by doing injections automatically.
|
||||||
|
> **NOTICE:** 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-Unity/blob/main/README-RU.md).
|
||||||
|
|
||||||
|
|
||||||
|
</br>
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
Versioning semantics - [Open](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
||||||
|
## Environment
|
||||||
|
Requirements:
|
||||||
|
+ Dependency: [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||||
|
+ Minimum version of C# 7.3;
|
||||||
|
+ Minimum version of Unity 2021.2.0;
|
||||||
|
|
||||||
|
Tested with:
|
||||||
|
+ **Unity:** Minimum version 2021.2.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-Unity.git
|
||||||
|
```
|
||||||
|
* ### Source Code
|
||||||
|
The framework can also be added to the project as source code.
|
||||||
|
|
||||||
|
</br>
|
||||||
|
35
README_RU.md
35
README_RU.md
@ -5,8 +5,39 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-Unity?color=%23ff4e85&style=for-the-badge">
|
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-Unity?color=%23ff4e85&style=for-the-badge">
|
||||||
<img alt="GitHub" src="https://img.shields.io/github/license/DCFApixels/DragonECS-Unity?color=ff4e85&style=for-the-badge">
|
<img alt="GitHub" src="https://img.shields.io/github/license/DCFApixels/DragonECS-Unity?color=ff4e85&style=for-the-badge">
|
||||||
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
|
<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>
|
</p>
|
||||||
|
|
||||||
# Integration with Unity for [DragonECS](https://github.com/DCFApixels/DragonECS)
|
# Интеграция с Unity для [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||||
|
|
||||||
|
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-Unity/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-Unity) |
|
||||||
|
| :--- | :--- | :--- |
|
||||||
|
|
||||||
|
Расширение добавит набор инструментов для дебага и связи с движком Unity. С помощью инструментов отладки можно
|
||||||
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
|
> **ВАЖНО!** Проект в стадии разработки. API может меняться.
|
||||||
|
# Оглавление
|
||||||
|
- [Установка](#установка)
|
||||||
|
|
||||||
|
</br>
|
||||||
|
|
||||||
|
# Установка
|
||||||
|
Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
||||||
|
## Окружение
|
||||||
|
Обязательные требования:
|
||||||
|
+ Зависимость: [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||||
|
+ Минимальная версия C# 7.3;
|
||||||
|
+ Минимальная версия Unity 2021.2.0;
|
||||||
|
|
||||||
|
Протестированно:
|
||||||
|
+ **Unity:** Минимальная версия 2021.2.0;
|
||||||
|
|
||||||
|
## Установка для Unity
|
||||||
|
* ### 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-Unity.git
|
||||||
|
```
|
||||||
|
* ### В виде иходников
|
||||||
|
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||||
|
|
||||||
|
</br>
|
||||||
|
Loading…
Reference in New Issue
Block a user