Skip to content

Commit 0bf4333

Browse files
authored
Update First Launch.md
1 parent 59783d8 commit 0bf4333

File tree

1 file changed

+39
-22
lines changed

1 file changed

+39
-22
lines changed

Documentation/First Launch.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,48 @@
1-
<img width="1894" height="550" alt="image" src="https://github.com/user-attachments/assets/89785a8e-8ee7-4911-81ff-847093a13185" />### Предисловие ###
1+
# Data Constructor - Документация
2+
3+
## Предисловие
4+
25
Базовая информация о работе конструктора:
3-
* Конструктор работает на JSON данных: Templates, Data, Localizatins, Logs и так далее.
4-
* Он имеет поддержку сохранения созданных вами данных: локально (Assets/Data Costructor), облачно(на данный момент есть только поддержка Firebase Realtime database).
5-
* Ссылки на ваши юнити ресурсы(картинки, звуки модели и всё что лежит внутри папки проекта) хранятся в системном Scriptable Object, это сделано с целью того чтобы они попали в ваш билд, у вас так же усть возможность менежмента этих ресурсов во вкладке ** Resources **.
6-
** Data ** является списком, экзампляры которого реализуют выбранный ** Template **.
7-
* Вы можете создавать неограниченное кол-во ** Data ** на любой ** Template **.
8-
Поскольку я верду одиночкую разработку, есть много аспектов, которые я не могу проверить или успевать реализовать, мне хотело бы чтобы этот редактор помог разработчикам игр, и мне в том числе, сделать подход к работе с данными более легким.
9-
10-
Installation:
11-
Addressables Installation (required)
12-
Open Window > Package Manager
13-
Switch to Unity Registry view
14-
Find Addressables and click Install
15-
16-
Copy the Plugin folder into your Assets
17-
18-
Инициализация при запуске игры:
19-
Чтобы инициализировать работу редактора в момент запуска вашей игры, вам нужно вызвать: DataConstructor.Initializer.Init();
6+
7+
- Конструктор работает с JSON данными: Templates, Data, Localizations, Logs и другие
8+
- Поддерживает сохранение созданных данных:
9+
- Локально (Assets/Data Constructor)
10+
- Облачно (в настоящее время поддерживается только Firebase Realtime Database)
11+
- Ссылки на Unity ресурсы (изображения, звуки, модели и другие ресурсы проекта) хранятся в системном Scriptable Object для включения в билд
12+
- Управление ресурсами доступно во вкладке **Resources**
13+
14+
**Data** представляет собой список экземпляров, реализующих выбранный **Template**
15+
- Вы можете создавать неограниченное количество **Data** для любого **Template**
16+
17+
## Установка
18+
19+
### Установка Addressables (обязательно)
20+
21+
1. Откройте `Window > Package Manager`
22+
2. Переключитесь на представление `Unity Registry`
23+
3. Найдите `Addressables` и нажмите `Install`
24+
25+
### Установка плагина
26+
27+
Скопируйте папку `Plugin` в вашу папку `Assets`
28+
29+
## Инициализация при запуске игры
30+
31+
Для инициализации редактора в момент запуска игры вызовите:
32+
33+
```csharp
34+
DataConstructor.Initializer.Init();
35+
```
2036
Там будут списке ваших данных, они будут иметь те же название что вы создавали в Data, и наследоваться от классов которые вы создавали в Template
2137

22-
Первый запуск:
38+
39+
## Первый запуск: ##
2340
Найди в вернем тул баре Data Constructor, затем нажмите Launch
2441
<img width="903" height="57" alt="image" src="https://github.com/user-attachments/assets/08e17ac6-c2b6-4b7a-b265-bf57a376f808" />
2542
Запустится редактор, он автоматически создаст нужные ему папки
2643
У вас будет несколько вкладок, пока нам нужны только: ** Templates ** и ** Data **
2744

28-
1. Первый Template
45+
### 1. Первый Template ###
2946
Перейдите во вкладку Template
3047
<img width="1900" height="208" alt="image" src="https://github.com/user-attachments/assets/e31d3dd8-f963-47b0-8f83-647fca568cb8" />
3148
1.Найдите Create левой панели (там будут все ваши классы)
@@ -37,7 +54,7 @@ Copy the Plugin folder into your Assets
3754
2.Заполните данные поля, выберите из списка списка тип поля, который вам нужен
3855
Ваш ** Template ** создан.
3956

40-
2. Первый Data
57+
### 2. Первый Data ###
4158
Перейдите во вкладку Data
4259
<img width="1892" height="859" alt="image" src="https://github.com/user-attachments/assets/f4d61e40-7936-4e62-9a6a-34222040efbd" />
4360
1. нажмите Create
@@ -47,7 +64,7 @@ Copy the Plugin folder into your Assets
4764
нажмите ** Add Entry **, создастся экземпляр класа, вы можете его заполнить необходимыми данными.
4865
После сделанных изменений можете нажать ** Save ** или ** Reset **.
4966

50-
3. Первый Deploy
67+
### 3. Первый Deploy ###
5168
Перейдите во вкладку Deploy
5269
<img width="1897" height="624" alt="image" src="https://github.com/user-attachments/assets/62a30f6c-2b74-4671-bdfd-447246f8e3ff" />
5370

0 commit comments

Comments
 (0)