Базовое использование

Содержание

  1. Базовое использование
    1. Первоначальная настройка
    2. Главное меню
    3. Панель настроек
      1. Минимально необходимые настройки
    4. Панель информации о моде
    5. Списки модов
    6. Внешние метаданные
      1. Метаданные мастерской Steam (steamDB.json)
      2. Правила (Community Rules Database, User Rules)

Первоначальная настройка

По умолчанию RimSort предложит настроить пути к конфигурации игры и установить SteamCMD. Также может спросить вас о предпочтениях для более важных настроек, например включать ли интеграцию со Steam. В остальном применяются настройки по умолчанию — дальше можно свободно всё настроить из панели настроек.

Главное меню

Главное меню — в зависимости от вашей операционной системы и окружения рабочего стола — это либо полоса в верхней части главного окна RimSort, либо часть глобального меню системы. В нём отображается версия RimSort и выпадающие меню со скрытыми дополнительными опциями. Здесь доступны специальные возможности для работы с RimSort: открытие, добавление, сохранение, импорт и экспорт списка модов, загрузка логов, использование оптимизатора текстур todds или доступ к мастерской Steam.

Чтобы объединить список модов с текущим активным списком, используйте File → Append Mod List…. Моды из выбранного файла, которых ещё нет в активном списке, будут добавлены в него.

Панель настроек

Открыть панель настроек можно из главного меню: File → Settings… В этом окне несколько вкладок, каждая подписана.

Минимально необходимые настройки

Как минимум должны быть заданы пути к каталогу установки RimWorld, каталогу конфигурации RimWorld и локальным модам. Все остальные настройки опциональны для базовых операций, но некоторые функции могут не работать.

Панель информации о моде

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

Списки модов

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

Внешние метаданные

Релизы RimSort не содержат этих дополнительных внешних метаданных. Об опциональных, но настоятельно рекомендуемых базах данных, которые предоставляют такие метаданные, и о том, как их получить, см. страницу Базы данных.

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

Помимо описанных ниже баз мастерской Steam и правил, RimSort поддерживает и другие опциональные базы метаданных, включая Use This Instead (альтернативные моды для устаревших или несовместимых модов), No Version Warning (заведомо версионно-независимые моды) и RimWorld Versions (используется функцией Download RimWorld). Подробнее об их настройке см. страницу Базы данных.

Метаданные мастерской Steam (steamDB.json)

Steam Workshop Metadata

Содержит метаданные, полученные из Steam WebAPI + Steamworks API, с использованием схемы из базы данных RimPy Mod Manager от Paladin (db.json).

Чтобы собрать базу мастерской Steam самостоятельно, используйте SteamDB Builder.

Зачем это нужно?

  • Метаданные зависимостей, доступные в Steam — разработчики модов указывают на Steam зависимости от DLC и от других модов.
    • В идеале это полностью покрывается корректным About.xml. Однако SteamDB может дополнить доступные данные, если этого не сделано.
  • Часть локальных метаданных берётся из About.xml модов. Сюда входят PackageId и gameVersions.
    • Полная база позволяет пользователю иногда находить зависимости модов, даже если сами моды ещё не скачаны.
      • При импорте списка модов, содержащего ещё не доступные локально моды, для поиска соответствия PackageId → PublishedFileId необходима SteamDB.

Правила (Community Rules Database, User Rules)

Rules Metadata

RimSort использует две внешние базы правил: userRules.json и communityRules.json. Они дают одинаковую функциональность, но одна создаётся сообществом и предназначена для общего использования, а другая — для ваших личных правил порядка загрузки.

Обе базы используют схему, совместимую с communityRules.json из базы RimPy Mod Manager от Paladin.

Базы можно менять напрямую — это обычные текстовые файлы, — но для редактирования правил в этих базах рекомендуется использовать встроенную утилиту Редактор правил.

Зачем это нужно?

Это также позволяет загружать пользовательские правила сортировки! Авторы модов не всегда быстро реагируют, когда находятся конфликты или несовместимости. Поэтому сообщество может определять дополнительные правила сортировки, которые большинство считают необходимыми. Традиционно Paladin распространял их через RimPy Community Mod Manager Database. RimSort выбрал другой путь распространения — git.

  • loadAfter и loadBefore
    • Это встроенные правила RimWorld. Обычно они задаются в About.xml мода.
  • loadBottom — изначально определено Paladin в community rules из RimPy Community Mod Manager Database.
    • Принудительно помещает моды в самый низ списка при сортировке. RimSort помечает такие моды меткой из внешних метаданных, считая их «модами 3 уровня» (tier 3 mod) и сортируя их после всех модов без этой метки.
  • loadTop
    • Принудительно помещает моды в самое начало списка при сортировке. RimSort помечает такие моды меткой из внешних метаданных, считая их «модами 1 уровня» (tier 1 mod) и сортируя их перед всеми модами без этой метки. Это пользовательское правило — оригинальная особенность RimSort.
  • WIP isFramework
    • «Каркасный мод» (framework mod) расширяет другие моды, но при самостоятельном использовании не даёт контента. Это пользовательское правило — оригинальная особенность RimSort.
    • Примеры таких модов: Universum, Vanilla Expanded Framework, XMLExtensions и т.д.
    • RimSort помечает моды с этим правилом меткой, чтобы показывать предупреждение, когда на такие моды нет «ссылок». Использовать такие моды без использующих их модов бессмысленно — это же каркас!

Подробные инструкции по созданию и управлению правилами через редактор правил, включая добавление пользовательских правил порядка загрузки для конкретных модов, см. на странице Редактор правил.