diff --git a/VERSION b/VERSION index eca07e4..ac2cdeb 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.1.2 +2.1.3 diff --git a/docs/assets/images/unnoficial_docs/base/dlc/create_dlc_definition.webp b/docs/assets/images/unnoficial_docs/base/dlc/create_dlc_definition.webp new file mode 100644 index 0000000..12226da Binary files /dev/null and b/docs/assets/images/unnoficial_docs/base/dlc/create_dlc_definition.webp differ diff --git a/docs/assets/images/unnoficial_docs/base/dlc/set_reddlc_property.webp b/docs/assets/images/unnoficial_docs/base/dlc/set_reddlc_property.webp new file mode 100644 index 0000000..3eba931 Binary files /dev/null and b/docs/assets/images/unnoficial_docs/base/dlc/set_reddlc_property.webp differ diff --git a/docs/changelog.md b/docs/changelog.md index 1b5aac0..1e9a6f8 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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) @@ -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 \ No newline at end of file +- 1.1.0 - Добавлена [страница](unnoficial_docs/references/file_extensions.md) +- 1.0.0 - Init версия. Перенесены некоторые доки из discord diff --git a/docs/unnoficial_docs/base/dlc/dlc_steps/step_1.md b/docs/unnoficial_docs/base/dlc/dlc_steps/step_1.md index 566ad29..f02912d 100644 --- a/docs/unnoficial_docs/base/dlc/dlc_steps/step_1.md +++ b/docs/unnoficial_docs/base/dlc/dlc_steps/step_1.md @@ -1,7 +1,7 @@ --- tags: - dlc - - retddlc + - reddlc status: new diff --git a/docs/unnoficial_docs/base/dlc/dlc_steps/step_2.md b/docs/unnoficial_docs/base/dlc/dlc_steps/step_2.md index 163b7cc..24f56b9 100644 --- a/docs/unnoficial_docs/base/dlc/dlc_steps/step_2.md +++ b/docs/unnoficial_docs/base/dlc/dlc_steps/step_2.md @@ -1,7 +1,7 @@ --- tags: - dlc - - retddlc + - reddlc - mod_name status: new @@ -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). Прежде чем добавлять новый строковой ресурс, выберите язык который будет по умолчанию в процессе разработки мода. Далее нажмите кнопку добавить (+) в результате чего появится новая строчка, куда нужно вписать (слева на право): diff --git a/docs/unnoficial_docs/base/dlc/dlc_steps/step_3.md b/docs/unnoficial_docs/base/dlc/dlc_steps/step_3.md index 5df632a..c7dde91 100644 --- a/docs/unnoficial_docs/base/dlc/dlc_steps/step_3.md +++ b/docs/unnoficial_docs/base/dlc/dlc_steps/step_3.md @@ -1,7 +1,7 @@ --- tags: - dlc - - retddlc + - reddlc - structure status: new @@ -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 diff --git a/docs/unnoficial_docs/base/dlc/dlc_steps/step_4.md b/docs/unnoficial_docs/base/dlc/dlc_steps/step_4.md new file mode 100644 index 0000000..39d6a12 --- /dev/null +++ b/docs/unnoficial_docs/base/dlc/dlc_steps/step_4.md @@ -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)* +*** diff --git a/docs/unnoficial_docs/base/dlc/index.md b/docs/unnoficial_docs/base/dlc/index.md index bf1861a..d4829f9 100644 --- a/docs/unnoficial_docs/base/dlc/index.md +++ b/docs/unnoficial_docs/base/dlc/index.md @@ -1,7 +1,7 @@ --- tags: - dlc - - retddlc + - reddlc status: new @@ -35,4 +35,20 @@ DLC-моды являются модификациями игры, которы Имя мода. - [:octicons-arrow-right-24: Перейти](dlc_steps/step_2.md) \ No newline at end of file + [: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) \ No newline at end of file diff --git a/docs/unnoficial_docs/references/dlc/dlc_definition.md b/docs/unnoficial_docs/references/dlc/dlc_definition.md new file mode 100644 index 0000000..e115bdc --- /dev/null +++ b/docs/unnoficial_docs/references/dlc/dlc_definition.md @@ -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)* +*** diff --git a/docs/unnoficial_docs/references/dlc/dlc_mounters.md b/docs/unnoficial_docs/references/dlc/dlc_mounters.md new file mode 100644 index 0000000..b2c17a0 --- /dev/null +++ b/docs/unnoficial_docs/references/dlc/dlc_mounters.md @@ -0,0 +1,164 @@ +--- +tags: + - dlc + - reddlc + - dlc_mounters + +status: new + +--- + +# DLC Mounters + +DLC Mounters - это набор настроек вашего DLC, которые помогают игре определить стартовые действия а так же набор используемых ресурсов. +Практически все элементы вашего DLC в том или ином виде будут упомянуты среди DLC Mounters. + +## CR4QuestDLCMounter + +Этот маунтер используется для определения квестов, добавляемых в игру через DLC. Он включает в себя пути к файлам квестов и связанным с ними данным, таким как теги голосовых сцен и уровни квестов. + +**quest** - путь к файлу квеста, описывающего ваше DLC. + +**taintFact** - путь к файлу, содержащему факты, влияющие на игру или квесты. + +**sceneVoiceTagsTableFilePath** - путь к файлу с тегами голосовых сцен, используемыми в квестах. + +**questLevelsFilePath** -путь к файлу с уровнями квестов, который определяет сложности и уровни квестов. + +## CR4RewardsDLCMounter + +Этот маунтер используется для добавления наград в игру через DLC. Он определяет пути к файлам наград, которые могут включать различные предметы, опыт и другие бонусы. + +**rewordsXmlFilePath** -путь к файлу xml, содержащему определения наград, добавляемых в игру. + +## CR4JournalDLCMounter + +Этот маунтер предназначен для добавления записей в журнал игры через DLC. Он включает пути к директории журналов, где хранятся все новые записи. + +**journalDirectoryPath** - путь к директории, содержащей файлы журналов, добавляемых в игру. + +## CR4AttitudesDLCMounter + +Этот маунтер используется для добавления новых настроений и аттитюдов (отношений) NPC в игру через DLC. Он определяет пути к файлам с группами настроений и аттитюдов. + +**attitudeGroupsTableFilePath** - путь к файлу, содержащему группы настроений/отношений NPC. + +**attitudesXMLFilePath** - путь к XML-файлу, определяющему настроений/отношений NPC. + +## CR4DefinitionsDLCMounter + +Этот маунтер используется для добавления новых определений предметов в игру через DLC. Он включает пути к файлам, содержащим определения этих предметов. + +**definitionXmlFilePath** - путь к XML-файлу, содержащему определения новых предметов. + +## CR4DefinitionsEntitieTemplatesDLCMounter + +Этот маунтер предназначен для добавления новых шаблонов сущностей в игру через DLC. Он определяет пути к директории с шаблонами сущностей. + +**entitieTemplatesDirectoryPath** - путь к директории, содержащей файлы с шаблонами сущностей. + +## CR4SceneAnimationsDLCMounter + +Этот маунтер используется для добавления новых анимаций сцен в игру через DLC. Он определяет пути к файлам с анимациями тел и мимики. + +**sceneAnimationsBodyFilePath** - путь к файлу, содержащему анимации тел для сцен. + +**sceneAnimationsMimicsFilePath** - путь к файлу, содержащему анимации мимики для сцен. + +## CGameplayDLCMounterScripted + +Предназначен для внедрения игровых скриптов, добавление новых функций и поведенческих элементов в DLC. + +## CSaveFileDLCMounter + +Позволяет игрокам начинать игру с нового контента DLC без необходимости прохождения предыдущих этапов. + +## CR4QuestDLCMounter + +Активирует новые квесты, входящие в состав DLC, сразу после запуска игры. + +## CR4ActionPointCategoriesDLCMounter + +Добавляет в игру новые точки взаимодействия, позволяя создавать уникальные сценарии и задания. + +## CR4AnimationsCategoriesDLCMounter + +Расширяет библиотеку анимаций, включая новые движения и анимационные эффекты для персонажей и элементов мира. + +## CR4EntityExternalAppearanceDLCMounter + +Интегрирует новые модели и модификаторы внешности для существ, предметов и персонажей в DLC. + +## CR4AttitudesDLCMounter + +Загружает и применяет новые настройки поведения персонажей, изменяющие динамику взаимоотношений в игровом мире. + +## CR4DefinitionsEntitieTemplatesDLCMounter + +Используется для определения и создания новых игровых объектов с уникальными атрибутами и свойствами. + +## CR4DefinitionsDLCMounter + +Обрабатывает XML-файлы определений, необходимые для корректного отображения и функционирования новых элементов игры. + +## CR4DropPhysicsSetupDLCMounter + +Настраивает параметры падения и взаимодействия объектов с физическим миром, гарантируя их реалистичное поведение. + +## CR4EntityTemplateParamDLCMounter + +Регистрирует параметры для шаблонов сущностей, обеспечивая их соответствие заданной логике и игровым механикам. + +## CR4EntityTemplateSlotDLCMounter + +Указывает слоты для шаблонов сущностей, позволяя корректно расположить новые объекты в игровом пространстве. + +## CR4FinishersDLCMounter + +Добавляет новые финишеры и анимационные наборы, расширяя вариативность завершающих движений в бою. + +## CR4JournalEntriesDLCMounter + +Регистрирует новые элементы для журнала заданий, делая их доступными в пользовательском интерфейсе игры. + +## CR4JournalDLCMounter + +Добавляет новые разделы в игровой журнал, расширяя документацию и справочную информацию внутри игры. + +## CR4MappinsDLCMounter + +Обновляет карту и визуальные метки на ней, интегрируя указатели на новые объекты и квесты. + +## CR4ResourceDefinitionsDLCMounter + +Загружает определения ресурсов, обеспечивая поддержку нового контента, такого как текстуры и модели. + +## CR4RewardsDLCMounter + +Управляет системой вознаграждений, добавляя новые предметы и награды для игроков в DLC. + +## CR4ScaleformContentDLCMounter + +Интегрирует ресурсы Scaleform, такие как графические и видеофайлы, используемые в пользовательском интерфейсе. + +## CR4SceneAnimationsDLCMounter + +Загружает данные для анимаций сцен, обогащая кинематографические моменты новыми визуальными эффектами. + +## CR4VideoDLCMounter + +Обрабатывает видеофайлы формата USM, включаемые в качестве кинематографических вставок и отрывков. + +## CR4VoicetagDLCMounter + +Добавляет голосовые теги к шаблонам сущностей, позволяя им воспроизводить новые звуковые эффекты и диалоги. + +## CR4WorldDLCMounter + +Регистрирует новые миры и локации в игре, обеспечивая их интеграцию и доступность для исследования игроками. + +*** +Автор: lxgdark + +*Документация поддерживается участниками сообщества [REDkit RU](https://discord.gg/kRTEy8KcNa)* +*** diff --git a/mkdocs.yml b/mkdocs.yml index 777c4be..655f2ff 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,7 +22,8 @@ nav: - О DLC модах: unnoficial_docs/base/dlc/index.md - Шаг 1. Пространство ID: unnoficial_docs/base/dlc/dlc_steps/step_1.md - Шаг 2. Имя мода: unnoficial_docs/base/dlc/dlc_steps/step_2.md - - Шаг 2. Структура папок: unnoficial_docs/base/dlc/dlc_steps/step_3.md + - Шаг 3. Структура папок: unnoficial_docs/base/dlc/dlc_steps/step_3.md + - Шаг 4. Определение DLC: unnoficial_docs/base/dlc/dlc_steps/step_4.md Поведения: - Общие сведения: unnoficial_docs/base/behavior/behavior.md Мир: @@ -49,8 +50,11 @@ nav: - Справочники: - Главная: unnoficial_docs/references/index.md - Редакторы: - - Редактор локализуемых строк: unnoficial_docs\references\editors\localized_strings_editor.md - - Asset Browser: unnoficial_docs\references\editors\asset_browser.md + - Редактор локализуемых строк: unnoficial_docs/references/editors/localized_strings_editor.md + - Asset Browser: unnoficial_docs/references/editors/asset_browser.md + - DLC Definition: + - Описание DLC Definition: unnoficial_docs/references/dlc/dlc_definition.md + - DLC Mounters: unnoficial_docs/references/dlc/dlc_mounters.md - Мир: - Параметры мира: unnoficial_docs/references/world/world_params.md - Umbra: unnoficial_docs/references/world/umbra.md