Skip to content

Commit 59783d8

Browse files
authored
Update First Launch.md
1 parent 1030f76 commit 59783d8

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

Documentation/First Launch.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,57 @@
1+
<img width="1894" height="550" alt="image" src="https://github.com/user-attachments/assets/89785a8e-8ee7-4911-81ff-847093a13185" />### Предисловие ###
2+
Базовая информация о работе конструктора:
3+
* Конструктор работает на JSON данных: Templates, Data, Localizatins, Logs и так далее.
4+
* Он имеет поддержку сохранения созданных вами данных: локально (Assets/Data Costructor), облачно(на данный момент есть только поддержка Firebase Realtime database).
5+
* Ссылки на ваши юнити ресурсы(картинки, звуки модели и всё что лежит внутри папки проекта) хранятся в системном Scriptable Object, это сделано с целью того чтобы они попали в ваш билд, у вас так же усть возможность менежмента этих ресурсов во вкладке ** Resources **.
6+
** Data ** является списком, экзампляры которого реализуют выбранный ** Template **.
7+
* Вы можете создавать неограниченное кол-во ** Data ** на любой ** Template **.
8+
Поскольку я верду одиночкую разработку, есть много аспектов, которые я не могу проверить или успевать реализовать, мне хотело бы чтобы этот редактор помог разработчикам игр, и мне в том числе, сделать подход к работе с данными более легким.
19

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();
20+
Там будут списке ваших данных, они будут иметь те же название что вы создавали в Data, и наследоваться от классов которые вы создавали в Template
21+
22+
Первый запуск:
23+
Найди в вернем тул баре Data Constructor, затем нажмите Launch
24+
<img width="903" height="57" alt="image" src="https://github.com/user-attachments/assets/08e17ac6-c2b6-4b7a-b265-bf57a376f808" />
25+
Запустится редактор, он автоматически создаст нужные ему папки
26+
У вас будет несколько вкладок, пока нам нужны только: ** Templates ** и ** Data **
27+
28+
1. Первый Template
29+
Перейдите во вкладку Template
30+
<img width="1900" height="208" alt="image" src="https://github.com/user-attachments/assets/e31d3dd8-f963-47b0-8f83-647fca568cb8" />
31+
1.Найдите Create левой панели (там будут все ваши классы)
32+
<img width="1877" height="862" alt="image" src="https://github.com/user-attachments/assets/3e3fab61-3a76-449e-b27c-d32b72570382" />
33+
2. После нажатия, вам откроется окно в котором вы можете заполнить данные, пока нам хватит только названия
34+
После создания вы можете открыть созданный вами ** Template **
35+
<img width="1918" height="895" alt="image" src="https://github.com/user-attachments/assets/3e8993f3-4643-4ec2-8e46-e9396bd94836" />
36+
1.нажмите ** Add Field **
37+
2.Заполните данные поля, выберите из списка списка тип поля, который вам нужен
38+
Ваш ** Template ** создан.
39+
40+
2. Первый Data
41+
Перейдите во вкладку Data
42+
<img width="1892" height="859" alt="image" src="https://github.com/user-attachments/assets/f4d61e40-7936-4e62-9a6a-34222040efbd" />
43+
1. нажмите Create
44+
2. Заполните данные (выберите тот Template который вы создали)
45+
3. Найдите его в левой панели
46+
<img width="1894" height="550" alt="image" src="https://github.com/user-attachments/assets/7be7f1fb-8a6f-4fef-9938-e696eb0f08da" />
47+
нажмите ** Add Entry **, создастся экземпляр класа, вы можете его заполнить необходимыми данными.
48+
После сделанных изменений можете нажать ** Save ** или ** Reset **.
49+
50+
3. Первый Deploy
51+
Перейдите во вкладку Deploy
52+
<img width="1897" height="624" alt="image" src="https://github.com/user-attachments/assets/62a30f6c-2b74-4671-bdfd-447246f8e3ff" />
53+
54+
1. Deploy делает генерацию созданных данных и классов под них.
55+
2. Нажмите эту кнопку и дожитесь окончания компиляции
56+
3. После этого у вас в коде появится доступ к вашим данным заполненным данным (пример: IReadOnlyList<TestTemplate> testData = DataConstructor.DataManager.TestData;)
57+
Вы прошли ознокомительный этап по работе с конструктором, остальную более детальную документацию я напишу в других разделах

0 commit comments

Comments
 (0)