How to Report - zymex22/Project-RimFactory-Revived GitHub Wiki

This Page describes how you should report issues to us. Following those instructions will allow us to assist you more effectively.

Bug Reports

A Bug Report should consist of the following Elements:

Description of the Issue

The Description should explain what the issue is. (What is happening? How does it differ from your expectations)

Where to report it

  • On our Discord in the rimfactory or troubleshooting Channel
  • On Steam in the Bug Reports Discussion
  • On Github

Incompatibility's

Your report should include

Name of the Incompatible Mod(s)

Simply the name of the Incompatible Mod(s). Do not use abbreviation. state the full name of the mod. If there are Mods with similar meanings please consider including a link to that Mod to avoid confusion.

Description of the Incompatibility

Describe the Incompatibility. How does it affect you? What happens? What do you expect should happen?

Where to report it

  • On our Discord in the rimfactory or troubleshooting Channel
  • On Steam in the Bug Reports Discussion
  • On Github

Feature Requests

Your Request should explain the Feature that you would like to see added. Have you considered alternatives? Why are the insufficient?

Where to report it

Performance Concerns

Performance is an important consideration for us and we are strongly interested in resolving issues should they arise. Since Performance issues manifest differently from Bugs, a different process must be used.

To Measure the Performance you may use Dubs Performance Analyzer or Wiri's fork Dubs Performance Analyzer - Wiri's Butchery

Wiri also provide some documentation on how to read it.

In any case I strongly suggest that you Join Dubs Discord and ask for Help there in an appropriate Channel.

Where to report it

The best Place to report / debug Performance Concerned is Dubs Discord. Should Discord be unavailable to you, you may share the Analyzer Screenshots on Steam or GitHub. (expect longer response times)

How to Reproduce it

If you are able to reproduce the issue, Please provide detailed steps on how to do so.

a HugsLib Log

Yes we want a full HugsLib Log, as it paints a much better picture of your situation. To Obtain a HugsLib Log you need one of the following mods installed:

Please note that you should post the Log after observing the issue.

Press CTRL & F12 to Upload your Log and include the link in your post

Should the Upload fail:

  1. Untick Use recommended settings
  2. Tick allow unlimited log size
  3. Press to clipboard
  4. Upload that Log

Should you experience a crash: Please Share you Player.log after the Crash and a HugsLib Log from the main menu.