Как сообщать об ошибках в модах RimWorld - RimWorld гайд

Авторы: Fluffy, Skullywag, ModsK (перевод на русский язык)

Текстовая версия гайда на русском языке

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

Это краткое руководство, взятое с форумов Ludeon, о том, как сообщать об ошибках таким образом, чтобы создатели модов могли что-то с ними делать!

Обо всем по порядку

Прежде чем отправлять отчет об ошибке, давайте удостоверимся, что на самом деле она существует.

Перезапустите игру!

Каждый раз, когда вы меняете настройку, которая приводит к изменению игровых данных (например, включение/отключение мода или смена языков), вы должны всегда перезапускать игру! Если ошибка не устранена после перезапуска игры, перейти к следующему шагу.

Создать новое сохранение

Некоторые моды могут быть добавлены в середине игры. Некоторые моды изменяют игровые данные таким образом, что в случае с ними этого сделать будет нельзя. Обычно в описаниях модов, которым требуется новая игра, указывается об этом, но так бывает не всегда. Чтобы убедиться в наличии ошибки наверняка, начните новую колонию, и посмотрите, возникнет ли ошибка вновь.

Мод несовместимости

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

Если ничего из этого не помогло, тогда ознакомьтесь с дополнительной информации об ошибках в следующем разделе!

Сбор информации

Многие сообщения об ошибках зачастую имеют вид: «это не работает» или «я не могу открыть вкладку X». Эта информация не очень полезна для создателя мода, так как, скорее всего, происходит что-то еще. Если бы ошибка была так проста, создатель мода поймал бы ошибку во время тестирования!

Ниже приведена информация о том, как поделиться тремя наиболее полезными частями информации;

  • Выходной журнал (The output log)
  • Файл конфигурации мода
  • Сохранение игры

Загрузите журнал (log) с помощью HugsLib

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

  • Нажмите Ctrl + F12, чтобы открыть издатель журнала (log publisher).
  • Подтвердите публикацию журнала и скопируйте его URL-адрес.
  • Опубликуйте URL-адрес вместе с описанием ошибки.

Загрузить журнал вручную

Игра отслеживает полный журнал ошибок. Вы можете найти его в следующих местах;

  • Windows: C:\Program Files\Steam\steamapps\common\RimWorld\RimWorldWin_Data\output_log.txt
  • OSX: лично не знаю, кто-нибудь с Mac хочет помочь?
  • Linux: output_log.txt генерируется в выбранном вами месте путем установки -logFile <pathname> пометка в исполняемом файле RimWorld.

Этот файл невероятно полезен для целей отладки! Поэтому, пожалуйста, загрузите его куда-нибудь, и поместите ссылку с отчетом об ошибке (вероятно, отчет получится довольно длинным, вы ведь не хотите просто скопировать/вставлять содержимое, Dropbox или что-то подобное подойдет для загрузки файла).

Предоставьте ваш modsconfig

Создателю мода может быть важно знать, какие другие моды у вас есть или не включены, и в каком порядке. Простой способ убедиться в этом — предоставить файл modsconfig.xml. Если вы загрузили свой журнал с помощью HugsLib, информация о конфигурации модов уже включена, поэтому вы можете пропустить этот шаг. Вы найдете его в следующих местах;

  • Windows: %appdata%/../LocalLow/Ludeon Studios/RimWorld by Ludeon Studios/Config/modsconfig.xml
  • OSX: /Users/[username]/Library/Application Support/RimWorld/Config/ModsConfig.xml
  • Linux: /home/[username]/.config/unity3d/Ludeon Studios/RimWorld/Config/ModsConfig.xml

Если же список модов короткий, просто скопируйте/вставьте его вместе с отчетом об ошибке, в противном случае поместите его в Dropbox или в другой подобный сервис, и предоставьте создателю мода ссылку на файл.

Передайте сохранение игры

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

  • Windows: %appdata%/../LocalLow/Ludeon Studios/RimWorld by Ludeon Studios/Saves/
  • OSX: /Users/[username]/Library/Application Support/RimWorld/Saves/
  • Linux: /home/[username]/.config/unity3d/Ludeon Studios/RimWorld/Saves/

Загрузите сохраненную игру в Dropbox или в подобный сервис (сохранения могут быть довольно больших размеров!) И предоставьте создателю мода ссылку.

Последнее слово

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

Кроме того, многие авторы размещают свои моды на GitHub или в аналогичных сервисах. Эти веб-сайты созданы с учетом разработки программного обеспечения с открытым исходным кодом, и оснащены сложным средством отслеживания ошибок, которое специально предназначено для сообщения об ошибках и проблемах. Если такая возможность предоставляется, используйте это! Создатель мода поблагодарит вас за это.

Спасибо за то, что прочитали все это, и, надеюсь, мы сможем исправить эти ошибки вместе!

Text version of the guide «How to report bugs in mods» in English

There’s a large number of mods out there — and some of them will have errors, or be incompatible. Most mod creators will want to know about bugs, but without enough information it’s hard for them to know what went wrong, and what to do about it.

This is a short guide, taken from the Ludeon forums, on how to report bugs in a way that mod creators can do something with it!

First things first

Before you submit a report, let’s make sure there’s actually a bug.

Restart the game!

Every time you change a setting that causes the game data to change (e.g. enable/disable a mod, or change languages), you must always restart the game! If the bug still persists after restarting the game, go to the next step.

Create a new save

Some mods can be added mid-game. Some mods alter the game data in such a way that this is not possible. Usually, mods that require a new game will say so, but this isn’t always the case. To be safe, start a new colony, and see if the bug still happens.

Mod incompatibilities

It may be that there’s an incompatibility between one or more of the mods you have installed. Try disabling all other mods (of course, always leave Core enabled). If the bug goes away, you likely have an incompatibility. This is probably still something the mod creator will want to know, as he can warn other users, or try to resolve the problem.

Did none of this help? Then let’s go get some more information about the bug in the next section!

Gathering information

Many bug reports come in the form of ‘it doesn’t work’ or, ‘I can’t open tab X’. This is not very useful to the mod creator, as there’s likely at least some other things going on. If the bug was that simple, he/she would have caught the bug during testing!

The following will provide information on how to share the three most useful parts of information;

  • The output log.
  • The mod config file.
  • The save game.

Upload the log with HugsLib

Many mods require HugsLib, and if you’re using mods, there’s a good chance you have HugsLib installed. If so, HugsLib allows you to easily gather the output log and mods config file and upload them at the same time.

  • Press Ctrl + F12 to open the log publisher.
  • Confirm publishing the log, and copy the URL it gives you.
  • Post the URL together with a description of the bug.

Upload the log manually

The game keeps track of a full error log. You can find it in the following locations;

  • Windows: C:\Program Files\Steam\steamapps\common\RimWorld\RimWorldWin_Data\output_log.txt.
  • OSX: no idea, anyone with a mac feel like helping?
  • Linux: output_log.txt is generated in a location of your choosing by setting the -logFile <pathname> flag on the RimWorld executable.

This file is incredibly useful for debugging purposes! So please upload it somewhere, and put the link with your bug report (it’s likely quite long, you don’t want to just copy/paste the contents, dropbox or something similar will do fine).

Provide your modsconfig

It may be vital for the mod creator to know what other mods you have or have not enabled, and in what order. An easy way to make sure of this, is to provide your modsconfig.xml file. If you uploaded your log with HugsLib, the mods config information is already included, so you can skip this step. You’ll find it in the following locations;

  • Windows: %appdata%/../LocalLow/Ludeon Studios/RimWorld by Ludeon Studios/Config/modsconfig.xml
  • OSX: /Users/[username]/Library/Application Support/RimWorld/Config/ModsConfig.xml
  • Linux: /home/[username]/.config/unity3d/Ludeon Studios/RimWorld/Config/ModsConfig.xml

If the list is short, just copy/paste it, otherwise put it on dropbox or a similar service, and provide the mod creator with a link to the file.

Provide a save game

If the bug only occurs in very specific situations, it’s very helpful for the modder to have a save game available where this situation is already set up. The easiest way to achieve this is by providing a save game. You’ll find save games in the following locations;

  • Windows: %appdata%/../LocalLow/Ludeon Studios/RimWorld by Ludeon Studios/Saves/
  • OSX: /Users/[username]/Library/Application Support/RimWorld/Saves/
  • Linux: /home/[username]/.config/unity3d/Ludeon Studios/RimWorld/Saves/

Upload the save game to dropbox or a similar service (they can get quite big!), and provide the mod creator with a link.

A final word

The Steam workshop has many benefits, but a good environment for bug tracking is not one of them. Many mods also have a thread on the official Ludeon Forums. You may want to have a look over there (the community is also really helpful!), and see if there is already a solution to your problem, or at the very least the forums will give you a more direct way of communicating.

In addition, many authors host their mods on github, or a similar service. These websites are build with open source software development in mind, and have a sophisticated issue tracker that is specifically meant to report bugs and issues. If you can, use it! The mod creator will thank you for it.

Thanks for reading all of this, and hopefully we can start bashing those bugs together!

Другие гайды авторов - Fluffy, Skullywag, ModsK

Другие гайды, похожие на "Как сообщать об ошибках в модах RimWorld"

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

Чтобы приступить к поиску, введите ваш запрос и нажмите клавишу «ENTER»