X Rebirth Tools
Оригинальный текст: egosoft.comПеревод: alexalspВ pdf формате X Rebirth Tools PDFSteam Workshop для X Rebirth и X4
Содержание• Основные правила публикации
• Подготовка
• Использование инструмента Workshop
• Публикация модов
• Обновление модов
• Поддержка нескольких версий игры
• Публикация модов для X Rebirth и X Rebirth VR Edition
В Steam Workshop поиск и установка модов для X игр стала проще, чем прежде. Существуют раздельные мастерские для X Rebirth, X Rebirth VR Edition и X4: Foundations. Изучите моды в мастерской для вашей игры, подпишитесь на интересные моды, и они будут установлены автоматически при следующем запуске игры. Прочтите описание и проверьте совместимость с другими модами.
Моды из мастерской будут обновляться автоматически после того, как автор обновит свой мод в мастерской. Для того, чтобы отключить использование мода при следующем старте игры, достаточно выключить мод в игре или отписаться от него в мастерской Steam.
Общие правила публикации
Общие правила и рекомендации:• Не публикуйте моды, которые не были созданы вами, без разрешения автора.
• Запрещено также публиковать исправления модов без согласия автора.
• Не публикуйте один и тот же мод несколько раз. Если вы не уверены, что загрузка прошла успешно, проверьте мод на странице мастерской.
• Если ваш мод зависит от других модов или несовместим с другими модами, укажите это в описании, что бы игроки знали об этом.
• В мастерской Steam размещаемые моды содержат названия и описания. Данная информация должна быть указана на английском языке. Но Steam предоставляет возможность дополнительно указать данную информацию на необходимом для вас языке. Но помните, что обязательно должна присутствовать информация на английском языке.
Подготовка
Для публикации мода в Steam Workshop вам понадобится:• X Tools или тут (ранее известный как X Rebirth Tools)
• Папка, содержащая файлы мода, включая файл content.xml
• Обложка мода и скриншоты к моду (изображения должны быть в формате JPG, либо PNG). Мы рекомендуем размер 640x360 или больше.
Дополнительные условия:• Мод должен находится в своей папке. Когда мод будет загружен или обновлен из Мастерской Steam, он будет помещено в папку "extensions" в папке установленной игры.
• Скорее всего, вы будете загружать файлы непосредственно из папки extensions. В этом случае у вас уже будет данная папка.
• Существует несколько ограничений при создании папки мода:
• В имени папки допускаются только следующие символы: a-z 0-9. ...и пробел...
• Имя в верхнем регистре; любые большие буквы будут автоматически преобразованы в строчные.
• Имя папки должно состоять не более чем из 32 символов.
• Игра может работать с несколькими модами Мастерской, с одинаковым названием папок, но будут ошибки, если игрок подпишется на оба мода.
• Если есть моды не из мастерской Steam, с таким же именем папки, игрок должен будет разрешить конфликт самостоятельно.
• Имя папки не должно быть общеупотребительным. Вам необходимо придумать оригинальное название папки, что бы оно не могло совпасть с названием папки другого мода.
• Если вы решите переименовать папку во время обновления, помните обо всех вытекающих из этого последствиях, например, не забудьте обновить индексные файлы.
• Все файлы, имеющие отношение к игре, должны сохраняться в
cat файлы.
• Если в папке расширения нет cat файлов, вы можете использовать ключ -buildcat для автоматической упаковки файлов мода в cat файл.
• Для создания cat файлов вы можете использовать инструмент, входящий в состав X Tools.
• Будут загружены в мастерскую только эти типы файлов: *.cat, *.dat, *.cur, *.txt, *.pdf*
• Если у вашего мода есть файлы курсора мыши (*.cur), они должны находиться в корневой папке мода, а не в cat файле.
• Примечания по
content.xml:
• Атрибут id должен быть пустым до первой загрузки мода в мастерскую Steam – имя идентификатора будет сгенерировано Мастерской Steam.
• Вы должны указать название мода и его описание в элементе . Эти данные будут использоваться при создании темы мода в Мастерской Steam при публикации.
• Для добавления перевода строки в атрибуте описания description, используйте 
. \n не поддерживается.
• Название мода и его описание могут быть изменены в мастерской Steam после публикации.
• В игре отображаются текущее имя и описание к моду, как в Мастерской Steam, если только файл content.xml не содержит локализованный текст для текущего языка игры.
• Мы рекомендуем не указывать номер версии в названии.
• Вам нужен атрибут version. Значением версии, является значение умноженное на 100, поэтому, например, для отображения значения v2.50 необходимо указать версию version="250".
• По умолчанию, "author" будет указано имя, взятое с имени аккаунта Steam. Если вы хотите изменить его, задайте имя автора в поле . author="Vasiliy Pupkin"
• Ваш мод может зависеть от другого мода и этот мод или моды должны уже быть в Мастерской Steam. Используйте идентификаторы этих модов в своем файле content.xml.
• Также ваш мод может зависеть от версии игры X Rebirth (т.е. мод работает от версии игры 3.00 и на более ранних он не работает). .
Пример content.xml для публикации нового мода:Код
<?xml version="1.0" encoding="utf-8" ?>
<!-- My Test Extension v0.10 -->
<content id="totally_unimportant" name="My Test Extension" description="This is just an example." version="10">
<!—Требуется элемент мастерской 12345, минимальная версия 1.00 -->
<dependency id="ws_12345" version="100" />
<!—требуется минимальная версия игры 1.50 -->
<dependency version="150" />
<!—Опции локализации (ВНИМАНИЕ: текст перевода только относится к файлу content.xml. В мастерской Steam этот текст не отображается. ) -->
<!-- Русский: -->
<text language="7" name="Тест моего мода" description="Это только для примера." />
<!-- Немецкий: -->
<text language="49" name="Meine Test-Erweiterung" description="Dies ist nur ein Beispiel." />
</content>
Код
<?xml version="1.0" encoding="utf-8" ?>
<content id="" name="Foo" description="Test" version="100">
</content>
Workshop инструмент содержится в
X Tools. Этот инструмент работает из командной строки, у него нет графического интерфейса (пока нет). Для запуска вам понадобится запустить из мастерской Steam инструмент X Tools. Откроется консоль Windows из папки X Tools, в которой расположен файл
WorkshopTool.exe.
(
Примечание: Если приложение уже было установлено до изменения его названия, первоначальное имя папки
"X Rebirth Tools" останется прежним.)
Напечатайте
WorkshopTool и нажмите
Enter. В результате вы получите информацию о доступных командах и ключах. Не бойтесь, инструмент спросит разрешения перед загрузкой чего-либо в Мастерскую Steam.
Публикация модаВажно: Вы должны принять
Steam Workshop Legal Agreement для загрузки какой либо информации в Мастерскую Steam.
Представьте, что вы подготовили ваш мод для
X Rebirth в папке
"extensions":
Код
...\steamapps\common\X Rebirth\extensions\my first mod
Вы также подготовили привью изображение (см. выше). Он называется
preview.jpg (или любое имя) и вы поместили его в папку мода
("my first mod"). Имя папки должно быть в нижнем регистре. Теперь пришло время запустить WorkshopTool! Ваша командная строка для публикации вашего мода будет выглядеть следующим образом, в зависимости от игры:
Пример для X Rebirth:Код
WorkshopTool publish -path "..\X Rebirth\extensions\my first mod" -preview "..\X Rebirth\extensions\my first mod\preview.jpg" -buildcat
Код
WorkshopTool publishvr -path "..\X Rebirth VR\extensions\my first mod" -preview "..\X Rebirth VR\extensions\my first mod\preview.jpg" -buildcat
Код
WorkshopTool publishx4 -path "..\X4 Foundations\extensions\my first mod" -preview "..\X4 Foundations\extensions\my first mod\preview.jpg" -buildcat
Вы можете опубликовать мод только для той игры, которая у вас есть в Steam, в противном случае будет выдана ошибка.
[Вы также можете использовать ключ
-tags, но они еще не реализованы. Зайдите позже, посмотрите, не изменилось ли это.]
Во время работы инструмента WorkshopTool вы должны войти в Steam под своей учетной записью.
Так что теперь происходит?• Здесь мы не используем ключ -foldername, поэтому WorkshopTool берет имя папки: "my first mod" (обратите внимание, что это не лучшее имя папки).
• Мы не используем ключ -contentdef, поэтому WorkshopTool просто берет файл content.xml из папки "my first mod". Так как мы не потрудились создать cat файлы самостоятельно, мы используем ключ -buildcat, и WorkshopTool сделает все за нас.
• Утилита catalog tool создает ext_01.cat / ext_01.dat, которые будут загружены в мастерскую. Эти cat файлы будут автоматически удалены по окончании работы программы WorkshopTool. Вы можете отключить удаление с помощью ключа -keepcatfiles, но в этом случае не забудьте обновить или удалить cat файлы самостоятельно позже! WorkshopTool проверяет метаданные в файле content.xml и отображает некоторую информацию. Пожалуйста, прочтите все это и убедитесь, что вы не допустили ошибок.
• Программа спросит подтверждения: "Начать загрузку в облако Steam (y/n)?" Нажмите Y или N, и нажмите Enter.
• Дождитесь окончания загрузки. Это может занять некоторое время. Вы можете прервать загрузку с помощью Ctrl+C.
• После завершения загрузки некоторые атрибуты XML будут записаны в файл content.xml, наиболее важным атрибутом является id, который опознает мод в качестве элемента Workshop.
После успешной загрузки появится запрос на открытие веб-страницы мастерской. Вы должны сделать это по нескольким причинам:
• Возможно, вам придется подтвердить соглашение Steam Workshop в онлайн-режиме.
• Даже после загрузки объект Workshop пока не будет виден другим игрокам. Вам нужно будет настроить права на странице мода (доступен для всех или только для друзей).
• На странице параметров можно напрямую изменить название и описание, не обновляя при этом мод в мастерской.
Если на веб-странице указано, что элемент Workshop не существует, вероятно, вы не вошли в систему. Просто войдите в систему, чтобы увидеть ваш мод.
Если вы хотите вернуться к странице позже, создайте закладку в браузере или запустите WorkshopTool с командой
showpage:
Код
WorkshopTool showpage -path "..\X Rebirth\extensions\my first mod"
Обычно, когда вы подписываетесь на моды в Мастерской и запускаете игру, оно загружает мод из мастерской и перезаписывает все файлы предыдущей версии мода. Это не случится для вашего мода, потому что WorkshopTool создает запись синхронизации мода с мастерской в значение
= "false" в вашем
content.xml файле после публикации. Таким образом, вы можете безопасно хранить свои моды в папке игры во время работы над обновлениями. (Тем не менее, рекомендуется регулярно выполнять резервное копирование файлов.) Если вы все равно хотите включить синхронизацию, нет проблем: зайдите в меню
Дополнений в игре и переключите обновление мода на значение
"Да".
Побочным эффектом отключения обновления является то, что игра не будет обновлять имя и описание в вашем локальном файле
content.xml при их изменении на странице Steam Workshop. Однако, другие игроки увидят обновленное имя и описание в своих играх.
Как только игроки увидят ваш мод в Мастерской, они смогут подписаться на него и установить его, запустив игру. Для отключения мода необходимо отписаться от него в мастерской либо отключить его в игре. Если игроки просто удалят папку мода, не отписавшись от него, мод будет загружена снова при следующем запуске игры.
Если ваш мод зависит от других модов мастерской, игроки должны подписаться на них самостоятельно, иначе они получат сообщение об ошибке в игре. Эти моду будут скачаны с мастерской при запуске игры и отобразятся в списке модов в игре.
Обновление модовДля обновления существующего элемента Мастерской, командная строка должна выглядеть так:
Код
WorkshopTool update -path "..\X Rebirth\extensions\my first mod" -buildcat -changenote "This is my first update"
• Ключ -changenote необходим для всех обновлений. Если вы не хотите указывать описание, напишите -changenote "". После обновления можно текст описания исправления отредактировать в мастерской.
• WorkshopTool предполагает, что вы повысили номер версии обновленного мода. Если вы намеренно сохраняете номер версии в файле content.xml без изменения, используйте переключатель -minor.
• Обычно обновление не влияет на название и описание Мастерской. Для загрузки названия и описания из content.xml в Steam Workshop используйте ключ "-nameesc up" (без кавычек).
• Изменение файла привью не является обязательным. Если вы хотите изменить файл привью без загрузки мода, воспользуйтесь командой updatepreview вместо update.
• Можно изменить имя папки мода. Важно: Следите за тем, чтобы это не произошло случайно, например, при загрузке из другой папки! Инструмент WorkshopTool отобразит старые и новые имена папок, прежде чем вы подтвердите загрузку. Пожалуйста, внимательно проверьте эти данные.
• После загрузки несколько данных XML будут записаны в content.xml, как при публикации, но атрибут Syncне будет добавлен или изменен. Таким образом, если вы включили обновления после публикации мода, то их нельзя будет снова отключить.
• Команда обновления работает для всех игр серии X, поддерживаемых программой. Игры автоматически определяются на основе идентификатора.
Когда игра обновляет мод, она проверяет требуемую версию игры для мода в
content.xml файле. Если мод требует отличную версию игры чем та, что указана в
content.xml, мод будет загружен с предупреждением. Однако такие проверки на зависимость от других модов не проводится, и они будут загружены в любом случае.
Поддержка нескольких версийВ некоторых случаях вам может понадобиться разместить разные файлы для разных версий игр в одном и том же моде. Это удобно, когда Egosoft выпускает бета-версию новой версии игры, и вы хотите настроить свой мод для этой бета-версии, не затрагивая всех игроков, которые все еще играют в публичные версии с вашим модом. Например, новая бета-версия может добавить новые возможности, которые вы хотите включить в ваш мод, или ваш мод может стать несовместимым и должен быть исправлен. Вы можете использовать фазу
beta для внесения необходимых изменений и одновременно поддерживать как текущую версию, так и бета-версию.
Вот как это работает: Как описано в документации к
catalog tool, игра будет искать
cat файл текущей версии игры в папке мода, например, версия
1.50 - в этом случае будет осуществляться поиск файла
ext_v150.cat. Если он присутствует, то будет использоваться для замены содержимого других
cat файлов мода).
Если вы не работаете с
catalog tool самостоятельно, WorkshopTool может выполнить всю работу за вас. Например, у вас есть мод, который работает с текущей версией X Rebirth (скажем,
1.50) и есть бета-версия X Rebirth (скажем, версия
2.00). Вы хотите внести изменения в мод, чтобы подготовить его к
v2.00. Вот что нужно сделать:
• Вы создаете подкаталог с названием "v150" для версии игры 1.50.
• В эту папку копируется *все* из существующей папки мода (за исключением content.xml и ранее существовавших папок версий, таких как "v140"). Именно этот контент игроки увидят в игре версии 1.50.
• В обычных папках мода вы вносите изменения для версии 2.00.
• Задайте требуемую версию X Rebirth равного версии 1.50 в content.xml, а не 2.00, поскольку этот файл также используется в v1.50. (Если вы используете) версии игр старше 1.50, то вы также должны создать для них папки с версиями).
• Когда вы будете готовы загрузить обновление, используйте WorkshopTool с ключом -buildvcat вместо -buildcat. Это практически то же самое, но -buildvcat также будет искать папки с версиями. Он найдет v150 и создаст каталог различий ext_v150.cat/dat. Он будет содержать только файлы, отличные от содержимого версии 2.00.
• Оба каталога ext_01 (с контентом 2.00) и ext_v150 будут загружены и предоставлены игрокам. Игроки с версией игры 1.50 будут видеть содержимое версии 1.50, а 2.00 бета с новым содержимым будут видеть игроки бета версии без файла ext_v150, так как он загружаться не будет.
• После выхода версии 2.00 для всех, не бойтесь удалить папку v150 и изменить версию игры на "200" в content.xml, если вы не хотите продолжать поддержку игроков, которые отключили обновления игры, но включили обновления для мастерской.
Если вы собираете все свои
cat файлы самостоятельно, помните, что вам следует создавать их заново при каждом обновлении - каталоги версий всегда должны отличаться от текущей версии.
Публикация модов для обеих редакций X Rebirth и X Rebirth VR EditionМожно опубликовать один и тот же мод для обеих игр следующим образом:
• Убедитесь, что мод совместим с обеими играми. Существуют тонкие различия между XR и XR VR, которые могут вызвать проблемы для существующих модов, и наоборот. • Если вам нужно особое поведение сценариев в игре, вы можете указать в скриптах, находитесь ли вы в версии VR. Таким образом, вы будете использовать один и тот же сценарий в обеих играх.
• У вас будет два предмета в Мастерской, а не один. Таким образом, вам понадобятся два файла описания содержания, даже если вы используете их с одним модом. • Сделайте две копии своего content.xml файла, по одной для каждой игры. Вы должны использовать ключ -contentdef при публикации и обновлении мода.
• Публикуйте мод дважды: сначала с помощью команды "publish", затем с помощью команды "publishvr" и с использованием соответствующих файлов описания.
Чтобы обновить мод для обеих игр, выполните команду
"update" для обоих элементов Мастерской, как описано выше.
Фильмы |
