Руководство по созданию модов для Transport Fever 3: файлы, первый мод и публикация

Это руководство по созданию модов для Transport Fever 3 основано на официальной документации игры. Мод представляет собой отдельную папку, содержащую ресурсы и метаданные. Urban Games рекомендует разработчикам не изменять файлы установки игры, а помещать все изменения в отдельный мод. Официальные примеры включают небольшое изменение конфигурации и размещаемый 3D-объект (ассет), поэтому вы можете выбрать отправную точку в соответствии со своими навыками.

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

Создание папки мода

На странице определения мода (Mod Definition) показана следующая общая структура:

mods/
  author_example_mod/
    _metadata/
      modinfo.json
      description.html       # опционально
      0.png                  # опциональный превью
    content/
      mod.script.tl          # опциональный скрипт
    mod.json
    strings.json             # опциональные переводы

Имя папки не является техническим идентификатором игры. Вики рекомендует использовать имя в стиле <автор>_<имя_мода> и следить за тем, чтобы оно совпадало с ID в mod.json. Игровые ресурсы, такие как модели, текстуры и скрипты, находятся в папке content/; в _metadata/ содержится информация, отображаемая в браузерах модов (Mod Browser).

Не каждому моду нужны все необязательные файлы. Например, для размещаемого ассета требуются файлы модели и конструкции, в то время как в официальном примере изменения конфигурации используются базовые файлы определения и метаданных плюс mod.script.tl. При начале работы скопируйте подходящую официальную демо-версию, а не добавляйте пустые файлы для неиспользуемых функций.

Определение мода в mod.json

mod.json — это техническое определение мода. Его параметр modId идентифицирует мод независимо от места установки, а revision отслеживает обновления. В вики также описаны параметры severityAdd, severityRemove, visible, cosmetic, зависимости и несовместимости. Минимальная начальная структура выглядит следующим образом:

{
  "modId": "author_example_mod",
  "revision": 1,
  "severityAdd": "None",
  "severityRemove": "Warning",
  "visible": true,
  "cosmetic": false
}

Выбирайте значения критичности (severity) в зависимости от влияния мода. Доступные варианты: None, Warning и Critical. Удаление мода, который добавляет тип груза или другой зависящий от сохранения ресурс, может иметь более серьезные последствия, чем удаление чисто визуального изменения. В вики указано, что cosmetic: true предназначен для действительно косметических модов; геймплейные изменения, такие как измененная вместимость транспорта или объемы производства, не должны помечаться как косметические. Перед публикацией ознакомьтесь с определениями полей и примерами.

Добавление метаданных браузера и текста

Файл _metadata/modinfo.json содержит отображаемое имя, краткую сводку и описание. Согласно официальному руководству, имя должно содержать не более 32 символов, а краткое описание — не более 100 символов; ни то, ни другое не должно содержать переносов строк. В нем также документированы локализованные имена и описания, информация об авторе, поддерживаемые теги и необязательный URL.

Файл strings.json используется для текста внутри мода. Вики демонстрирует строки с привязкой к языку и резервным вариантом на английском языке. Используйте его, когда меткам ассетов или названиям параметров требуется локализация. Сохраняйте стабильность технических идентификаторов для всех языков и переводите только отображаемые строки.

Для визуального предпросмотра на странице Mod Definition описаны пронумерованные файлы PNG в папке _metadata/; файл 0.png используется в сетке браузера. На странице рекомендуются изображения размером 1920 × 1080 пикселей. Это необязательно для локального прототипа, но полезно, когда нужно, чтобы другие игроки могли легко узнать мод.

Выбор первого проекта

Изменение конфигурации: Официальный демо-мод конфигурации изменяет параметры торможения поезда. Он демонстрирует небольшое переопределение на основе скрипта с использованием mod.json, _metadata/modinfo.json и mod.script.tl. Начните с загружаемой демо-версии и изменяйте по одному значению за раз. Проверяйте результат в отдельной игре перед добавлением новых изменений.

Размещаемый объект (ассет): В официальном демо-ассете помимо определения мода используются модель, меш, текстуры и файлы конструкции/скрипта. Этот путь подходит, если вы хотите изучить процесс работы с 3D. Копирование только метаданных не создаст рабочий ассет; ресурсы модели также должны присутствовать и иметь правильные ссылки.

Перекраска транспорта (репаинт): Во введении перекраска описывается как возможная отправная точка для авторов, уже обладающих навыками редактирования изображений. Используйте документацию по перекраске транспорта для правильной настройки ресурсов, а не предполагайте, что одной лишь текстуры будет достаточно.

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

Публикация и обновление мода

Transport Fever 3 имеет встроенный Mod Browser на платформе mod.io. Urban Games заявляет, что моды поддерживаются на ПК и консолях через этот браузер. На официальной странице поддержки также указано, что Steam Workshop не поддерживается, а ручной обмен файлами вне браузера остается возможным.

В руководстве по публикации в вики описан игровой Mod Hub и раздел «Мои моды» (My Mods) для загрузки. Эта страница помечена как устаревшая редакция, поэтому проверьте актуальный порядок действий в игре, прежде чем следовать указанным кнопкам или путям к папкам. При обновлении опубликованного мода увеличьте значение revision в mod.json и проверьте текущие инструкции по публикации, чтобы обновление попало в нужную запись мода.

Перед загрузкой убедитесь, что у вас есть разрешение на распространение каждой модели, текстуры, звука и скрипта в пакете. Официальное руководство по публикации требует, чтобы моды были бесплатными и соответствовали условиям платформы.

Частые вопросы

Где следует редактировать файлы базовой игры?

Создайте отдельную папку мода. В официальном введении особо рекомендуется не изменять установочный каталог игры.

Взаимозаменяемы ли mod.json и modinfo.json?

Нет. mod.json содержит технический ID и логику поведения, тогда как _metadata/modinfo.json содержит информацию, отображаемую в браужере модов.

Использует ли Transport Fever 3 Steam Workshop?

В официальном FAQ по поддержке указано, что вместо этого используется встроенный браузер mod.io. Ручной обмен модами по-прежнему возможен.

Источники: Официальное введение в моддинг, Определение мода (Mod Definition), Руководство по публикации и FAQ по поддержке.