Мод «HugsLib» для Rimworld (v1.0 - 1.5)

Это мод-библиотека (фреймворк), которая обеспечивает основу для других модов и общую функциональность.

  УСТАНОВКА HugsLib:   

• Для достижения наилучших результатов убедитесь, что HugsLib идет сразу после Core (Ядра игры) в порядке загрузки модов.

Инструкция - Как установить HugsLib: 

Примеры порядка загрузки модов HugsLib и Harmony

Примерные виды порядка загрузки модов в списке модов, который у Вас может получится, если у Вас есть еще дополнительные моды.
Обратите внимание на местонахождение и порядок следования в списке модов HugsLib, Harmony, Core, и официальных DLC (дополнений Royalty и Ideology).
           

Как и полагается моду-библиотеке (фреймворку), содержит много полезного, многократно используемого кода для других модов.

Для обычных игроков, самая главная функция о которой они должны знать:

• Log Publisher - журнал логов игры.
  Нажмите Ctrl+F12, чтобы загрузить свои журналы Rimworld и получить ссылку. 
  Благодаря этому Вы можете легко поделиться журналом логов своей игры с другими.
  

  Это необходимо, когда игрок хочет понять ошибку в игре и просит кого-то (например, модера) её найти и исправить.

  И для того, чтобы общение имело смысл и было продуктивным, в самом начале взаимодействия, игрок должен показать собеседнику журнал логов и ошибок своей игры!

• Прочтите прежде чем задавать вопросы и писать о проблемах с Вашей игрой!
  
  Руководство о том, как заставить Ctrl+F12 работать правильно!

  Распространенным и наиболее важным моментом в общении игроков является то, что у многих людей возникают вопросы при попытке решить проблему: как нужно правильно использовать HugsLib и предоставить ту информацию, что от меня просят?
  
  Стандартный ответ на вопрос об ошибке и просьбу о помощи: «Мне нужна дополнительная информация! Пришлите логи HugsLib, журнал логов Ctrl+F12!».
  Это руководство о том, как заставить Ctrl+F12 работать правильно.
  
  1) Убедитесь, что HugsLib есть в вашем списке модов и он активен.
  
  
  2) После запуска или переустановки Hugslib в первый раз, вот быстрый тест, чтобы убедиться, что он работает правильно (он также поможет вам в будущей отладке!)
  
  
  

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

  
  
  

  4) Откройте ЖУРНАЛ ОТЛАДКИ.

  Щелкните ПЕРВЫЙ КВАДРАТНЫЙ ЗНАЧОК НА ВЕРХУ.

  Наведение на них заставит их выделяться СИНИМ при выборе и даст вам подсказку.

  
  
  

  5) Обычно каждый модер на форуме Steam, здесь и на других сайтах просит [поделиться журналами логов игры], когда вы сообщаете об ошибке.

  продолжайте и нажмите «Поделиться журналами» ("Share Logs"), чтобы увидеть, как это работает:

  
  
  

  6) Использование кнопки "To clipboard" (буфер обмена) предназначено для лучшего понимания Вами деталей отчёта. ИЛИ если у вас возникла проблема с созданием сокращенной URL-ссылки на gist.github.com/HugsLibRecordKeeper/ - На этот сайт будут публиковаться отчёты если Вы нажмете кнопку "Загрузить" (Upload). И здесь же Вы можете ознакомиться с уже опубликованными другими игроками их отчётов с помощью мода-библиотеки HugsLib.

  Вот и всё .. теперь только остаётся убедиться, что Вы задаете правильный вопрос в правильной теме...

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

Основные функции HugsLib:

Mod foundation (Основа модов):

базовый класс для создания модов. Расширяющие классы имеют доступ к настраиваемым журналам, настройкам и получают следующие события от контроллера библиотеки: Initialize, DefsLoaded, Tick, Update, FixedUpdate, OnGUI, WorldLoaded, MapGenerated, MapComponentsInitializing, MapLoaded, MapDiscarded, SceneLoaded, SettingsChanged.

 

Persistent in-game settings (Постоянные внутриигровые настройки):

базовый класс для создания модов. Расширяющие классы имеют доступ к настраиваемым журналам, настройкам и получают следующие события от контроллера библиотеки: Initialize, DefsLoaded, Tick, Update, FixedUpdate, OnGUI, WorldLoaded, MapGenerated, MapComponentsInitializing, MapLoaded, MapDiscarded, SceneLoaded, SettingsChanged.

 

Mod update news (Новости об обновлениях модов):

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

 

Log publisher (журнал логов игры):

добавляет сочетание клавиш (Ctrl+F12) для публикации журналов из игры. Возвращает URL-адрес, которым вы можете поделиться с другими или отправить автору мода. Опубликованные журналы также включают список запущенных модов и их версий, а также полный список активных патчей Harmony. Это отличный способ для автора мода получить логи от игрока, у которого возникла проблема с его модом.

 

Quickstarter (быстрый запуск):

Загрузите файл сохранения или создайте новую карту с заданным сценарием и размером сразу после запуска игры. Также позволяет создать новую карту одним щелчком мыши. Диалог настроек включен.

 

UtilityWorldObjects (для сохранений):

удобный способ сохранить ваши данные в файле сохранения. Поскольку MapComponents A16 больше не являются надежным способом хранения ваших данных, а UWO предназначены для замены.

 

Custom tick scheduling (Пользовательское планирование тиков):

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

 

Auto-restarter (Автоперезапуск):

автоматически перезапускает игру при смене языка.

 

Log window additions (Дополнения к окну журнала):

добавлено меню для поиска общих файлов: откройте файл журнала и просмотрите папки пользовательских данных и модов.

 

---

Скриншоты работы HugsLib:

 Примеры работы различных функций библиотеки HugsLib вы можете видеть в разделе "Скриншоты", и также ниже:

 

---

СОВМЕСТИМОСТЬ HugsLib:

• Можно смело добавлять в существующие игры (Save-файлы сохранения).
  
  
• Совместим со многими другими модами-библиотеками. Например, с Harmony.
  Более того, в описании на GitHub сказано, что "для правильной работы HugsLib требуется установленный мод Harmony".
  

  UnlimitedHugs: "Пожалуйста, используйте библиотеку Harmony для ваших нужд, и все должно хорошо работать вместе".

 

• В настоящее время нет известных проблем совместимости.

---

ТРЕБОВАНИЯ для HugsLib:

• Несмотря на то, что, в принципе, HugsLib может быть самодостаточным модом и работать отдельно,
• Автор просит устанавливать совместно еще и мод-библиотеку Harmony. [Lib.Harmony (Vers >= 2.1.0)]
• .NET Framework версии >= 4.7.2. (Это требование самой игры, так что если игра запускается, то у Вас это уже скорее всего есть).

---

ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ о HugsLib:

Чтобы получить дополнительную информацию о том, что и как делает этот мод, или сообщить о проблемах, ознакомьтесь с сообщениями здесь:

• Ветка форума Ludeon мода HugsLib.
  
  
• GitHub мода HugsLib. Здесь также Wiki-ресурс "HugsLib wiki". 
  
  
• gist.github.com/HugsLibRecordKeeper/ - На этот сайт публикуется код (отчёты, логи, фрагменты) с помощью HugsLib если Вы нажмете кнопку "Загрузить" (Upload). И здесь же Вы можете ознакомиться с уже опубликованными другими игроками их данными которыми они решили поделиться.
  
  
• Первоначальная Версия B19 все еще доступна, и ее можно найти, например, здесь: HugsLib (B19).
• Ранее в мод-библиотеку Hugslib был включен мод-библитека Harmony. После версии Harmony 1.1 эти два мода существуют как отдельные, совместимые и взаимодополняемые проекты.
• В описании на GitHub, Ludeon и NuGet сказано, что для правильной работы HugsLib требуется установленный мод Harmony.
• На странице автора (UnlimitedHugs) в Steam в графе адреса указано: "Tolyatti, Samara, Russian Federation".

---

Моды использующие фреймворк HugsLib:

Если Вы хотите узнать какие моды уже используют этот фреймворк (мод-библиотеку), то прежде всего, автор рекомендует ознакомиться с его модами. Например, это такие моды как:   

• Allow Tool  (Разрешить инструмент)
• Map Reroll (Изменение карты)
• Defensive Positions (Защитные позиции)
• Remote Tech (Удаленная технология)

---

Юридический аспект (Лицензия):

• Фреймворк HugsLib может использоваться кем угодно. Количество модов использующих его постоянно растёт. Автор фреймворка открыт к взаимодействию с другими модерами.
  
  
• Этот мод-библиотека (фреймворк) создан для работы других модов, которые от него зависят.
  Поэтому, несмотря на то, что технически этот мод с открытым исходным кодом и может быть использован кем угодно, не предполагается созданий другими модерами новых модов с копирующими функциями из этого фреймворка. 
  
  
• Т.е. простое копирование битов, которые будет сделано без осторожности, может привести к серьезным конфликтам совместимости.
  
  
• Кроме того, вы упустите улучшения и исправления, примененные к коду, если просто сделаете его копию.
  
  
• Фреймворк HugsLib должен устанавливаться игроками как отдельный мод. Сама сборка библиотеки не должна поставляться с модами созданными модерами.
  
  
• Это общедоступная библиотека, аналогичная Community Core Library (основной библиотеке сообщества), которая легко обновляется между версиями Rimworld.
  Не стесняйтесь использовать этот фреймворк для своих собственных проектов. 

• UnlimitedHugs: "Не стесняйтесь использовать и включать где угодно. Упоминания не являются обязательным".

---

Список модов автора UnlimitedHugs:

• на top-mods.ru.
• в Мастерской Steam.
• на GitHub.

---

ДЛЯ МОДЕРОВ использующих в своих модах HugsLib:

1) Теги зависимостей: 
Если ваш мод зависит от HugsLib, рекомендуется включить эти теги в файл About.xml:

строчки кода:

<modDependencies>
         <li>
                <packageId>UnlimitedHugs.HugsLib</packageId>
                <displayName>HugsLib</displayName>
                <downloadUrl>https://github.com/UnlimitedHugs/RimworldHugsLib/releases/latest</downloadUrl>
                <steamWorkshopUrl>steam://url/CommunityFilePage/818773962</steamWorkshopUrl>
         </li>
</modDependencies>
<loadAfter>
         <li>UnlimitedHugs.HugsLib</li>
</loadAfter>

 

2) Документация по библиотеке HugsLib:

 

Список документации по HugsLib:

• ModBase reference (Справочник по ModBase)
• Adding mod settings (Добавляем настройки мода)
• World data storage (Мировое хранилище данных)
• Mod update news (Новости обновления мода)
• Introduction to Patching (Введение в исправление)
• Custom Tick Scheduling (Пользовательское расписание тиков)
• Development Utilities (Утилиты разработки)
• Detouring (A16) (Объезд)
• GUI injection (A16) (Инъекция графического интерфейса)

3) "HugsLib wiki" - Wiki-ресурс с подробной информацией обо всех нюансах HugsLib. Эта вики должна помочь вам начать работу с библиотекой и выделить некоторые распространенные варианты использования доступных систем.          

UnlimitedHugs: "Если чего-то не хватает, просмотрите код или напишите мне, если вам нужна дополнительная информация".

---

Благодарности:

• Автор проекта фреймворка (мода-библиотеки) HugsLib и модов Allow Tool, Map Reroll, Defensive Positions, Remote Tech - UnlimitedHugs.
• Объезд по атрибуту (Detour by attribute) добавленн Fluffy.
• Проверка безопасности объезда (Detour safety checks) предоставлена ​​1000101 и Zhentar.
• Значок HubsLib предоставлен Alistaire.
• Команды оболочки (Shell commands) предоставлены scuba156.
• Особая благодарность и почетное упоминание Andreas Pardeike за прекрасную библиотеку Harmony.

---

Варианты языков перевода мода HugsLib:

Существует несколько вариантов перевода мода HugsLib на русский язык: 

1. Первый вариант перевода мода на русский язык уже встроен в мод HugsLib. Авторы перевода: аноним, dragomano.
   
   
2. Второй вариант перевода на русский язык: Мод-русификатор HugsLib. Автор перевода (Animal Mind) сделал перевод под себя, немного по другому, адаптируя его в некоторых местах. Части игроков такой перевод нравится больше.
   
   Способы установки русификатора HugsLib от Animal Mind:

   1) Установить русификатор как отдельный мод. Чтобы полностью применить данный перевод - поместите мод с русификатором ниже основного мода HugsLib. Для того, чтобы дополнить существующий перевод (который уже есть в моде HugsLib) - поместите выше основного мода.
   
   2) Замена папки "Russian" с русским переводом. Сначала удаляете эту папку из мода HugsLib. Затем, после скачивания и распаковки мода с русификатором, находите там такую-же папку "Russian" и копируете её в мод HugsLib, где подобная папка была до этого. 
   В этом варианте установки русского языка, устанавливать весь мод-русификатор уже не нужно. Достаточно замены одной папки.

Местонахождение папки с русским переводом во всех модах выглядит так: "[Название_мода]\Languages\Russian".
Вы можете сравнить варианты перевода, в том числе, путём открытия файлов из этой папки в текстовом редакторе.

Помимо русского языка, в мод HugsLib также включены следующие языки переводов:

• упрощенный китайский (от автора cainiaowu), традиционный китайский (от duduluu, shiuanyue, CuteLasty), польский (от Kunegard), испанский (от nahuen89, PelucheKawaii, 53N4), японский (от Proxyer) , корейский (от urty5656), французский (от kaptain-kavern), немецкий (от maculator). 

---

---

 

Мод проверен на версии игры: 1.0 , 1.1 , 1.2 , 1.3 , 1.4 , 1.5

• 1.5

Версия 22.10.22 для Rimworld (v1.0 - 1.4)

• Поддержка версии 1.4

СКАЧАТЬ

Версия 9.0.1 (25.09.2021) для Rimworld (v1.0 - 1.3)

• Существенно дополнено описание мода-библиотеки (фреймворка) HugsLib.
• Объяснено как установить мод HugsLib для игры RimWorld.
• Представлена инструкция установки мода в ручную.
• Представлена инструкция установки мода через Steam.
• Представлены  примеры порядка загрузки модов HugsLib и Harmony.
• Описано про Log Publisher - журнал логов и ошибок игры, Ctrl+F12.
• Список основных функции HugsLib.
• Руководство о том, как заставить Ctrl+F12 работать правильно.
• Объяснено как эффективнее задавать вопрос и искать ошибки в игре RimWorld.
• Скриншоты работы HugsLib.
• Примеры работы различных функций библиотеки HugsLib.
• Требования для работы HugsLib.
• Про историю развития и совместимость HubsLib и Harmony.
• Описан Wiki-ресурс "HugsLib wiki". 
• Описано взаимодействие ресурса gist (https://gist.github.com/HugsLibRecordKeeper/) с функциями HugsLib.
• Описаны моды использующие фреймворк HugsLib.
• Юридические аспекты и лицензия.
• Список модов автора UnlimitedHugs.
• Представлена информация для модеров использующих в своих модах HugsLib.
• Включение тегов зависимостей.
• Документация по библиотеке HugsLib.
• Благодарности модерам. Команда.
• Варианты языков перевода мода HugsLib.
• Русский язык. Русификатор мода HugsLib.
• Способы установки русификатора HugsLib от Animal Mind.
• Сравнение русификаторов HugsLib.
• Полный список языков перевода для мода HugsLib.
• Добавлены скриншоты мода-библиотеки HugsLib с примерами работы его функций.
• и многое другое.

СКАЧАТЬ

Версия 17.07.21 для Rimworld (v1.0 - 1.3)

• Обновление до 1.3 версии

СКАЧАТЬ

Версия 15.08.20 для Rimworld (v1.0 - 1.2)

Незначительная настройка

• Ошибки исправлений устаревшего метода заменены на предупреждения.
• Удалены предупреждения об устаревших патчах метода из версии Rimworld 1.1.

СКАЧАТЬ

Версия 21.05.20 для Rimworld (v1.0 - 1.1)

• Отменено непреднамеренное изменение пространства имен Dialog_VanillaModSettings (мод Real Ruins);
• Вернулось изменение времени ловушки OnGUI (мод Heat Map);
• Обновлен японский перевод.

СКАЧАТЬ

Версия 18.05.20 для Rimworld (v1.0 - 1.1)

•  Добавлено окно статуса быстрого запуска при запуске игры.
•  Добавлен ModSpottingManager для идентификации пользователей, впервые работающих с модом.
•  Добавлен режим «Загрузить последнее сохранение» для быстрого старта
•  Добавлено автоматическое сохранение настроек мода при выходе из игры.
•  Добавлен обратный вызов ModBase.ApplicationQuit.
•  Добавлена ​​настройка Handle.CustomDrawerFullWidth
•  Добавлено меню при наведении в окне настроек мода.
•  Добавлено свойство ContextHenle и ModSettingsPack ContextMenuEntries
•  Добавлен пункт меню для сброса всех настроек, добавленных одним модом
•  Добавлен тумблер для необязательного сброса настроек скрытого мода.
•  Добавлена ​​минимальная проверка версии HugsLib (Version.xml -> requiredLibraryVersion)
•  Добавлена ​​/About/Manifest.xml версия для входа издателя
•  Добавлены сочетания клавиш для открытия настроек мода и обновления новостей мода.
•  Добавлено расширенное окно обновления модов с инструментами фильтрации и режима разработки.
•  Добавлена ​​перезагрузка новостей обновления мода (нажмите F5 в расширенном окне новостей)
•  Добавлено поле UpdateFeatureDef.targetAudience, чтобы установить поведение пользователя впервые
•  Новости об обновлениях мода больше не показываются пользователям, впервые работающим с модом.
•  Окно настроек быстрого запуска «Загрузить сейчас» и «Создать сейчас» больше не переключает режим
•  Mod SettingHandle.CustomDrawer теперь автоматически помечает дескрипторы как несохраненные изменения
•  Изменен OnGUI для вызова после обработки мира и карты камеры.
•  Новости обновления мода теперь будут загружаться в фоновом потоке для более быстрого запуска
•  Оптимизирована производительность окна настроек мода
•  Исправлен журнал издателя на MacOS

СКАЧАТЬ

Версия 02.04.20 для Rimworld (v1.0 - 1.1)

• Исправлена ​​ошибка перевода новостей при загрузке из папок / News и / Defs.

СКАЧАТЬ

Версия 30.03.20 для Rimworld (v1.0 - 1.1)

• Исправлена ​​ошибка публикации журнала при загрузке модов с номерами версий из двух частей.

СКАЧАТЬ

Версия 29.03.20 для Rimworld (v1.0 - 1.1)

• Исправлена ошибка, при которой издатель журнала (лога) игнорировал конфигурацию LoadFolders при чтении версий файла сборки;
• Издатель журнала теперь будет сообщать как версию файла сборки, так и версию сборки, если они не идентичны;
• Обновлен китайский перевод.

СКАЧАТЬ

Версия 24.03.20 для Rimworld (v1.0 - 1.1)

• Добавлена поддержка перевода для UpdateFeatureDefs;
• Абстрактному UpdateFeatureDefs больше не требуется глобальное уникальное имя;
• Исправлена ошибка, когда UpdateFeatureDef показывался игроку несколько раз, когда он не упорядочен по версии.

СКАЧАТЬ

Версия 01.03.20 для Rimworld (v1.0 - 1.1)

СКАЧАТЬ