|
1 | 1 | # Unity Data Constructor |
2 | 2 |
|
3 | | -**Unity Data Constructor** — это мощное и гибкое расширение редактора Unity для визуального создания и управления структурированными игровыми данными. |
4 | | -Оно разработано для упрощения и ускорения рабочего процесса конфигурации — идеально подходит как для дизайнеров, так и для разработчиков. |
| 3 | +**Unity Data Constructor** is a powerful and flexible Unity Editor extension for visually creating and managing structured game data. |
| 4 | +It is designed to simplify and speed up the configuration workflow — perfect for both designers and developers. |
5 | 5 |
|
6 | | -⚠️ В настоящее время находится в активной разработке. Интерфейс, пользовательский опыт и функциональность могут изменяться. |
| 6 | +⚠️ Currently in active development. UI, UX, and functionality may change. |
7 | 7 |
|
8 | | -## 📖 Гайд |
9 | | -Полная документация и руководство по использованию доступны в [**ГАЙДЕ**](https://github.com/Onimka/unity-data-constructor/blob/main/Documentation/README.md) |
| 8 | +## 📖 Guide |
10 | 9 |
|
11 | | -**✨ Возможности:** |
12 | | -* Система на основе шаблонов для повторного использования структур данных |
13 | | -* Поддержка списков с возможностью переупорядочивания и редактирования прямо в списке |
14 | | -* Полная поддержка вложенных полей и сложных типов |
15 | | -* Работа с абстрактными классами и иерархиями наследования |
16 | | -* Поддержка всех типов на основе UnityEngine.Object (например, Prefab, ScriptableObject, Texture, AudioClip) |
17 | | -* Внешние ссылки на поля между шаблонами |
18 | | -* Импорт/экспорт с использованием чистой JSON сериализации |
19 | | -* Чистый, масштабируемый и интуитивно понятный интерфейс |
20 | | -* Бесшовная интеграция с редактором Unity |
21 | | -* Для командной разработки. Поддержка Firebase Realtime Database в качестве облачной базы данных. |
| 10 | +Full documentation and usage instructions are available in the **GUIDE**: |
| 11 | +[https://github.com/Onimka/unity-data-constructor/blob/main/Documentation/README.md](https://github.com/Onimka/unity-data-constructor/blob/main/Documentation/README.md) |
22 | 12 |
|
23 | | -**Установка пакета Addressables (Обязательная зависимость):** |
24 | | -1. Откройте Window > Package Manager |
25 | | -2. Переключитесь на представление Unity Registry |
26 | | -3. Найдите Addressables и нажмите Install |
| 13 | +## ✨ Features |
27 | 14 |
|
28 | | -**Установка Data Constructor:** |
29 | | -1. Скопируйте папку Plugin в Assets |
30 | | -2. Инициализация во время выполнения - DataConstructor.Initializer.Init(); |
31 | | -3. Ваши данные находятся в runtime по адресу DataConstrucrtor.DataManager.ИМЯ_ВАШИХ_ДАННЫХ (Пример: List<DataConstrucrtor.DataManager.ExampleClass> ExampleData) |
| 15 | +* Template-based system for reusable data structures |
| 16 | +* List support with reordering and inline editing |
| 17 | +* Full support for nested fields and complex types |
| 18 | +* Works with abstract classes and inheritance hierarchies |
| 19 | +* Supports all UnityEngine.Object-based types (e.g., Prefab, ScriptableObject, Texture, AudioClip) |
| 20 | +* External field references between templates |
| 21 | +* Import/export via clean JSON serialization |
| 22 | +* Clean, scalable, intuitive interface |
| 23 | +* Seamless Unity Editor integration |
| 24 | +* Team-friendly: supports Firebase Realtime Database as a cloud storage backend |
32 | 25 |
|
33 | | -**⚙️ Требования:** |
34 | | -* Unity 2021.3+ (рекомендуется LTS) |
35 | | -* Пакет Addressables 1.21.0+ |
| 26 | +## 📦 Addressables Installation (required) |
36 | 27 |
|
37 | | -**Превью** |
38 | | -<p align="left"> |
39 | | - <img src="https://github.com/user-attachments/assets/4677d1e1-ee3d-4143-8644-70c8b18b1fe4" width="32%"> |
40 | | - <img src="https://github.com/user-attachments/assets/56b56375-7af8-4b87-885d-3c294822d966" width="32%"> |
41 | | - <img src="https://github.com/user-attachments/assets/f04e02b6-1077-41b8-9fdf-b43e9c898d06" width="32%"> |
42 | | -</p> |
| 28 | +1. Open **Window > Package Manager** |
| 29 | +2. Switch to **Unity Registry** view |
| 30 | +3. Find **Addressables** and click **Install** |
43 | 31 |
|
| 32 | +## 📥 Installing Data Constructor |
44 | 33 |
|
45 | | -**Как это работает?** |
46 | | -1. Определите свои структуры данных с помощью сериализуемых C# классов (включая абстрактные базовые классы или унаследованные типы). |
| 34 | +1. Copy the **Plugin** folder into your **Assets** |
| 35 | +2. Initialize at runtime: `DataConstructor.Initializer.Init();` |
| 36 | +3. Access your runtime data via `DataConstructor.DataManager.YOUR_DATA_NAME` |
47 | 37 |
|
48 | | -2. Используйте редактор для добавления полей, включая вложенные структуры или ссылки на объекты Unity. |
| 38 | + * Example: `List<DataConstructor.DataManager.ExampleClass> ExampleData` |
49 | 39 |
|
50 | | -3. Создавайте файлы данных и записи визуально. |
| 40 | +## ⚙️ Requirements |
51 | 41 |
|
| 42 | +* Unity 2021.3+ (LTS recommended) |
| 43 | +* Addressables 1.21.0+ |
52 | 44 |
|
53 | | -4. Автоматически генерируйте C# код и итоговые JSON файлы данных. |
| 45 | +## 🖼️ Preview |
54 | 46 |
|
55 | | -5. Во время выполнения ваша игра автоматически загружает распарсенные JSON данные из сгенерированного файла. |
| 47 | +(Images not embedded in this document) |
56 | 48 |
|
57 | | -**Локализация.** |
58 | | -<img width="2560" height="1020" alt="image" src="https://github.com/user-attachments/assets/72060d0e-6d82-4555-a207-f7e0dc124048" /> |
59 | | -Поддержка локализованных строк. Автоматический перевод с поддержкой локального Ollama и других сервисов. |
| 49 | +## 🔧 How It Works |
60 | 50 |
|
61 | | -**Ресурсы.** |
62 | | -<img width="2559" height="1033" alt="image" src="https://github.com/user-attachments/assets/c13cf51e-7bc1-44c5-9ae4-73b5fb37a4bd" /> |
63 | | -Управление ресурсами, которые используются конструктором. |
| 51 | +1. Define your data structures with serializable C# classes (including abstract or inherited types). |
| 52 | +2. Use the editor to add fields, including nested structures or Unity object references. |
| 53 | +3. Create data files and entries visually. |
| 54 | +4. Automatically generate C# code and final JSON data files. |
| 55 | +5. At runtime, the game loads parsed JSON data from the generated file. |
64 | 56 |
|
65 | | -🚧 Планы по развитию: |
66 | | -* Поиск и фильтрация |
67 | | -* Валидация полей и ограничения |
68 | | -* Доработка локализации |
69 | | -* Шаблоны настроек и архитектура плагинов |
70 | | -* Перетаскивание Addressables в окно редактора |
| 57 | +## 🌐 Localization |
71 | 58 |
|
72 | | -🧑💻 Лицензия |
| 59 | +Supports localized strings. Includes automatic translation using local Ollama or external services. |
73 | 60 |
|
74 | | -Этот инструмент можно бесплатно использовать в личных и коммерческих проектах Unity. |
75 | | -Однако модификация, распространение или перепубликация исходного кода не допускаются. |
| 61 | +## 📁 Resources |
76 | 62 |
|
77 | | -© 2025 Onimka. Все права защищены. |
| 63 | +Manage assets used by the constructor directly through the interface. |
| 64 | + |
| 65 | +## 🚧 Roadmap |
| 66 | + |
| 67 | +* Search and filtering |
| 68 | +* Field validation and constraints |
| 69 | +* Localization improvements |
| 70 | +* Settings templates and plugin architecture |
| 71 | +* Drag-and-drop of Addressables into the editor window |
| 72 | + |
| 73 | +## 🧑💻 License |
| 74 | + |
| 75 | +This tool is free to use in personal and commercial Unity projects. |
| 76 | +However, modifying, redistributing, or republishing the source code is not allowed. |
| 77 | + |
| 78 | +© 2025 Onimka. All rights reserved. |
0 commit comments