How to properly report a bug from a mod

Project Zomboid142 views3 favorites2 min readby 1VitaUpdated 12 JulView on Steam ↗

For those who won't read

First, make sure the mod is up to date!

If your bug doesn't trigger a lua error, the developers will need to be able to reproduce your error, so create a discussion giving as much info as possible.

Otherwise, the developers need the errors stacktrace to be able to fix your bug. Please use Error Magnifier to get that code and create a discussion.

Don't report bugs in the comments...

Requirements

1.
Make sure you are using the latest version of the mod. Modders usually indicate the version of the updates in the change notes.

To make sure you're using the latest version, you can force Steam to update the mod by:
  • Closing the game.
  • Unsubscribing from the mod.
  • Waiting for Steam to erase the files (a progress bar will be shown in the downloads section).
  • Resubscribing to the mod.
2.
Subscribe to Error Magnifier. This tool will give us all the information the developer needs from the error.
https://steamcommunity.com/sharedfiles/filedetails/?id=2896041179

Identify the error

1.
We want to stick to the same conditions in which the error occured, so don't create a new world. Enable Error Magnifier in the load menu for your save and start it.
2.
Reproduce the error. A tiny red button will appear in the bottom right corner of your game, click it.
3.
Take a look at the list Error Magnifier shows:
The names of the mods that caused the errors are highlighted in yellow.
4.
Copy the error of the mod you want to report by clicking in the clipboard icon.

Create a discussion

Don't report bugs in the comments section! Create a discussion, please.
Here's a template to clarify the information and facilitate debugging for the developer.

IF YOU ARE HOSTING A SERVER, MAKE SURE TO POINT IT OUT.

TITLE
BUG: Random error when launching the save
DESCRIPTION
MULTIPLAYER: No
STEPS TO REPRODUCE 1. Launch a saved game lol
BUG REPORT
Lua((MOD:First Aid Overhaul - No Antizin)).registries.lua(registries.lua:4) ERROR: General f:0> Lua((MOD:First Aid Overhaul - No Antizin)).registries.lua> Exception thrown java.lang.reflect.InvocationTargetException at DirectMethodHandleAccessor.invoke(null:-1). Stack trace: Caused by: java.lang.IllegalArgumentException: Tried to register duplicate object: faotraits:medicalpractitioner in: character_trait
Don't make additional comments after you paste the code, it's harder to read.

Thank you for contributing to the modding community and making PZ greater!

This guide was created by its original author on the Steam Community. Are you the author and want it removed? Request removal.