Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.2
2.1.3
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Тут будут публиковаться все значимые изменения и их версии.

***

- 2.1.3 - Добавлены справочнки для [DLC Definition](unnoficial_docs/references/dlc/dlc_definition.md) и [DLC Mounters](unnoficial_docs/references/dlc/dlc_mounters.md)
- 2.1.0-2.1.3 - Начат [цикл](unnoficial_docs/base/dlc/index.md) пошагового руководства по созданию DLC-модов
- 2.1.0 - Добавдены справочники: [Asset Browser](unnoficial_docs/references/editors/asset_browser.md), [редактор локализуемых строк (Localized Strings Editor)](unnoficial_docs/references/editors/localized_strings_editor.md)
- 2.0.8 - Добавлена [страница](unnoficial_docs/guides/create_new_hud_medallion.md)
- 2.0.7 - Добавлена [страница](unnoficial_docs/base/loading_screens.md), отредактирована [страница](unnoficial_docs/guides/create_usm_video.md)
- 2.0.6 - Добавлена [страница](unnoficial_docs/guides/create_usm_video.md)
Expand All @@ -15,5 +19,5 @@
[5](unnoficial_docs/references/world/shadow_params.md), [6](unnoficial_docs/references/world/umbra.md),
[7](unnoficial_docs/references/world/world_params.md), [8](unnoficial_docs/references/data_types.md)

- 1.1.0 - Добавлена [страница](unnoficial_docs/references/file_extensions.md)
- 1.0.0 - Init версия. Перенесены некоторые доки из discord
- 1.1.0 - Добавлена [страница](unnoficial_docs/references/file_extensions.md)
- 1.0.0 - Init версия. Перенесены некоторые доки из discord
2 changes: 1 addition & 1 deletion docs/unnoficial_docs/base/dlc/dlc_steps/step_1.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
tags:
- dlc
- retddlc
- reddlc

status: new

Expand Down
4 changes: 2 additions & 2 deletions docs/unnoficial_docs/base/dlc/dlc_steps/step_2.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
tags:
- dlc
- retddlc
- reddlc
- mod_name

status: new
Expand Down Expand Up @@ -35,7 +35,7 @@ status: new
!!! info "Примечание"
Именно для работы с этим редактором мы [ранее](../dlc_steps/step_1.md) определяли пространство идентификаторов.

Для добавления публикуемого мода откройте редактор [локализуемых строк (Localized Strings Editor)](../../../references/editors/localized_strings_editor.md).
Для добавления публикуемого мода откройте [редактор локализуемых строк (Localized Strings Editor)](../../../references/editors/localized_strings_editor.md).
Прежде чем добавлять новый строковой ресурс, выберите язык который будет по умолчанию в процессе разработки мода.
Далее нажмите кнопку добавить (+) в результате чего появится новая строчка, куда нужно вписать (слева на право):

Expand Down
4 changes: 3 additions & 1 deletion docs/unnoficial_docs/base/dlc/dlc_steps/step_3.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
tags:
- dlc
- retddlc
- reddlc
- structure

status: new
Expand Down Expand Up @@ -42,6 +42,8 @@ status: new
Если ваше DLC не предполагает создания нового мира, то для начала достаточно создать папку с именем DLC внутри папки "dlc". Как вы уже можете заметить в этой папке множество других DLC от самих разработчиков. Это хорошо, так как это поможет подсматривать структуру папок для создания единого стиля.
![create_empty_dlc_struct.webp](../../../../assets/images/unnoficial_docs/base/dlc/create_empty_dlc_struct.webp)

!!! warning "Важно!"
Не спешите наполнять вашу папку подпапками, так как многие структуры папок создаются автоматически при выполнении определенных действий. Старайтесь создавать папки, только когда об этом сказано в конкретной статье руководства, дибо когда вы уверены, что ее расположение структурно верно!
***
Автор: lxgdark

Expand Down
44 changes: 44 additions & 0 deletions docs/unnoficial_docs/base/dlc/dlc_steps/step_4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
tags:
- dlc
- reddlc
- dlc_definition

status: new

---
# Шаг 4: Определение DLC

На данный момент вы провели все подготовительные работы, однако сама игра ничего не знает о ваших намерениях и все предшествующие действия никак на нее не повлияют.

Чтобы игра узнала о вашем DLC нужно создать специальный файл определение, который укажет все необходимые параметры, используемые игрой для внедрения DLC.
Такой файл называется **DLC Definition** и должен быть создан в [корневой папке](step_3.md) вашего DLC.

Для создание DLC Definition, откройте [Asset Browser](../../../references/editors/asset_browser.md) и перейдите в папку вашего DLC (которая будет по пути dlc\dlc77).
Нажмите правой кнопкой мши на пустое место в окне просмотра файлов и выберите **Create --> DLC Definition**.
![create_dlc_definition.webp](../../../../assets/images/unnoficial_docs/base/dlc/create_dlc_definition.webp)
В качестве имени используйте основное кодовое имя вашего DLC. Итог получится, например таким - **"dlc77.reddlc"**.

Откройте созданный файл .reddlc, чтобы начать его настройку.
![set_reddlc_property.webp](../../../../assets/images/unnoficial_docs/base/dlc/set_reddlc_property.webp)
На первом этапе достаточно будет настроить только основные свойства(не имеющие значка (+) на скрине), а свойства **mounters** и **languagePacks** по ходу разработки мода.
!!! info "Примечание"
Работа с mounters будет показана в тех статьях, где потребуется соответсвующий маунтер, однако заранее ознакомится с общим списком mounters можно [здесь](../../../references/dlc/dlc_mounters.md)

Итак задайте значения для основных свойств:

- **id** - ИД вашего DLC. ИД должен быть уникальным значением, показывающим принадлежность к вашему DLC. Разработчики рекомендуют формат dlc_xxx_yyy, поэтому мы сделаем также. В качестве ИД укажите, например **dlc_077_001**
!!! info "Примечание"
Причина по которой формат именни такой, связна с тем, что у вас может быть более отдного DLC Definition для вашего мода. Например один для внедрения в основноую игру, а второй для самостоятельного запуска из главного меню. Именно поэтому нужен формат имени, где xxx - это номер dlс, а yyy - это порядковый номер DLC Definition
- **localizedNameKey** - это внешнее название нашего мода, которое будет отображаться в игре. Необходимо указать ключ к локализованной строке. Благо мы его заготовили [ранее](../dlc_steps/step_2.md). В нашем примере тут будет указано **dlc77_title**
- **localizedDescriptionKey** - то же самое что и выше, только нужен для строки описания мода. Тут используем **dlc77_desc**.
- **initiallyEnabled** - определяет включено ли DLC по умолчанию. Если нет, игроку нужно самостоятельно поставить галочку, чтобы мод появился в игре.
- **visibleInDLCMenu** - определит можно ли включить/выключить мод из меню игры **Настройки > Игровой процесс**. Выбор настройки зависит от сложности вашего DLC. Если DLC включает квесты и отдельные миры, то лучше поставить тут красный крестик, так как отключения мода сломает сохранения.
- **requiredByGameSave** - настройка как раз на случай описанный выше. Если поставить зеленый крестик, то игра при загрузке сохранения будет требовать наличие этого мода. Выберите эту настройку если ваш DLC включает квесты или отдельные миры.

На этом стартовые настройки вашего DLC можно считать завершенными. Дальнейший порядок дейтвий завит от типа DLC и степени влияния на основную игру.
***
Автор: lxgdark

*Документация поддерживается участниками сообщества [REDkit RU](https://discord.gg/kRTEy8KcNa)*
***
20 changes: 18 additions & 2 deletions docs/unnoficial_docs/base/dlc/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
tags:
- dlc
- retddlc
- reddlc

status: new

Expand Down Expand Up @@ -35,4 +35,20 @@ DLC-моды являются модификациями игры, которы

Имя мода.

[:octicons-arrow-right-24: Перейти](dlc_steps/step_2.md)
[:octicons-arrow-right-24: Перейти](dlc_steps/step_2.md)

- **Шаг 3**

***

Структура папок.

[:octicons-arrow-right-24: Перейти](dlc_steps/step_3.md)

- **Шаг 4**

***

Определение DLC.

[:octicons-arrow-right-24: Перейти](dlc_steps/step_4.md)
67 changes: 67 additions & 0 deletions docs/unnoficial_docs/references/dlc/dlc_definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
tags:
- dlc
- reddlc
- dlc_definition

status: new

---
# Описание DLC Definition

Файл DLC Definition - это файл с расширением **.reddlc**, является ключевым элементом при создании DLC для игрового проекта. В нем содержатся настройки и инструкции, определяющие ресурсы и пути к ним в вашем DLC. Кроме того, он управляет процессом загрузки и монтирования этих ресурсов.

Один из ключевых компонентов файла DLC Definition - это mounters. Mounters - это инструменты, которые указывают движку игры, какие файлы и ресурсы должны быть загружены из вашего DLC.

Каждый mounter связан с определенным типом ресурсов или действий. Например, mounter может указывать на текстуры, модели персонажей, звуковые эффекты или скрипты, которые должны быть загружены и использованы в вашем DLC.

Доступные mounters описаны [здесь](../dlc/dlc_mounters.md)

## Своства DLC Definition

### **id**

Уникальный идентификатор DLC. Используется для внутреннего обозначения и ссылок на конкретное DLC.

!!! info "Примечание"
Используйте формат dlc_xxx_yyy (например dlc_077_001).
Причина по которой формат именни такой, связна с тем, что у вас может быть более отдного DLC Definition для вашего мода. Например один для внедрения в основноую игру, а второй для самостоятельного запуска из главного меню. Именно поэтому нужен формат имени, где xxx - это номер dlс, а yyy - это порядковый номер DLC Definition

### **localizedNameKey**

Указывает идентификатор строки для названия DLC в меню. Этот ключ связывается с локализованными строками, чтобы обеспечить корректное отображение названия DLC на различных языках.

### **localizedDescriptionKey**

Указывает идентификатор строки для описания DLC в меню. Этот ключ связывается с локализованными строками, чтобы обеспечить корректное отображение описания DLC на различных языках.

### **mounters**

Массив объектов, которые указывают движку игры, какие файлы и ресурсы должны быть загружены из вашего DLC. Каждый элемент массива представляет отдельный компонент DLC, например, текстуры, модели, звуковые файлы или скрипты. Эти объекты обеспечивают правильную интеграцию новых ресурсов в игровой процесс.

### **languagePacks**

Массив строк, представляющих поддерживаемые языковые пакеты для данного DLC. Эти языковые пакеты позволяют игре адаптировать текстовые и звуковые ресурсы под выбранный пользователем язык. Если массив пустой, это указывает на отсутствие дополнительных языковых пакетов и использование основных ресурсов игры.

### **initiallyEnabled**

Определяет, будет ли DLC включено по умолчанию.
!!! info "Примечание"
Значение **false** часто используется для DLC которые привносят в игру альтернативные облики NPC, таким образом игрок должен вручную включить это DLC в настройках.

### **visibleInDLCMenu**

Указывает, будет ли DLC отображаться в списке DLC для включения/выключения его игроком в меню игры в разделе **Настройки --> Игровой процесс**.
!!! info "Примечание"
Значение **true** часто используется для DLC которые привносят в игру альтернативные облики NPC, таким образом игрок может включить или выключить эти образы в настройках.

### **requiredByGameSave**

Указывает, требуется ли DLC для загрузки сохранений игры, которые были сохранены с этим DLC.
!!! info "Примечание"
Это полезно для необязательных DLC, которые не влияют на игровой процесс, а по большей части являются косметическими, таким образом при значении **false**, можно будет загрузить сохраннее которое было сохранено с этим DLC, но при этом само DLC может быть не установлено.
***
Автор: lxgdark

*Документация поддерживается участниками сообщества [REDkit RU](https://discord.gg/kRTEy8KcNa)*
***
Loading