How to Report a Bug

Started by enystrom8734, November 04, 2013, 08:38:21 AM

Previous topic - Next topic


Please look around to see if your bug has already been reported in this forum.

Do not post bugs from games with mods active. If you find a bug with a specific mod, inform the mod author.  If you aren't sure which mod caused it, post in Mod Bugs.

For the thread title, write a one-line summary of what happened with version in [brackets] at the start.

  • BAD: "Sieger AI bug". This is not a summary, it's a label.
  • GOOD: "[B19] Siegers eat each other after running out of food". Succinctly summarizes the issue.

When reporting a bug, please include:

1. What the circumstances were.

2. What happened.

3. What you expected to happen.

4. Steps we can follow to make the bug appear on our machine. This part is important! We need a set of steps which we can follow to get the same results you're seeing. Ideally you'll test these steps to make sure they work from scratch.

5. Savegame file
It's very helpful to include a savegame, especially when you have trouble reproducing the bug.

- Windows users can find their save files by clicking the 'open save games folder' button in the in-game Options menu.
- Mac users don't have it quite so easy, and you will need to navigate to the save folder manually, which can be found here: /Users/your user name/Library/Application Support/RimWorld . Or you can search for .rws files. Although note that the Library folder could be hidden which might prevent you from both navigating to it and searching for .rws files. More information on where and how to find your save files on the Mac can be found in the following post/thread:

This forum has a 600kb limit for attachments, so the save file (which will have a .rws extension) will be too big to post as it is. But you might be able to attach it after zipping it with a utility such as WinRAR or 7zip. If it's still to big to attach then you can upload it to Google Drive / One Drive / Dropbox / Zippyshare (or other such cloud storage / file sharing service) and post the download link in your bug report.  Make sure you make the file shareable to anyone that has the link, if using Google Drive.

6. Log File
Posting a log file means uploading the log RimWorld generated. Here's where to find it:

  • Windows: %userprofile%\AppData\LocalLow\Ludeon Studios\RimWorld by Ludeon Studios\Player.log

  • Mac: Users/<YourUserName>/Library/Logs/Unity/RimWorld by Ludeon Studios/Player.log

  • Linux: /home/<YourUserName>/.config/unity3d/Ludeon Studios/RimWorld/Player.log
Note for Linux: You must run RimWorld from the console or the log file will not be created.  If you don't run RimWorld from the console, you may find the log at /tmp/rimworld_log

Note: Bug posts are usually addressed chronologically, as in oldest first.  If you 'bump' your post to get it seen, this has the opposite effect and removes it from its place in line and makes it take even longer to review.

E Nystrom - @enystrom8734