Discussion - How to report a bug (1 Viewer)

[Lisie]

Inevitably while using various scripts and plugins for MacroQuest you will occasionally encounter bugs that hinder your usage or cause something to crash. Properly reporting these bugs with a good description and any messages you received will help creators to solve your problem quicker and easier.

How to report a bug​

• Provide all information you can in your report.
  
  • What were you doing at the time the bug occurred?
  • Can you reproduce the bug? What steps can the creator follow to reproduce the bug themselves?
  • What was the behavior you expected? What actually happened?
• Provide any logs or error messages you received at the time the bug occurred.
  
  • Did the script crash? At a minimum include the red text from the console when the script crashed.
    
    • 
  • Has the creator included logging functions? Include the text from logging of the script. If possible set the logging to the highest verbosity possible to aid in finding the problem.
    
    • 
  • Did this crash cause EverQuest to entirely crash? Include the information from the EverQuest Crash Detected message.
    
    • 
    • A screen shot of this window is good, but it is even better if you also transcribe the CrashID to text so whoever is attempting to resolve your issue does not have to do so themselves.
  • Are there any other settings or messages in the script GUI that may be relevant to the issue? An unexpected behavior only when settings are a certain way?
    
    • Include any information about these settings you think might be important. Screenshots of the settings screen may be helpful for troubleshooting as well.
• Other useful information.
  
  • Did this bug occur more than once?
  • Did you have any other scripts or plugins that were running at the time of the bug?
  • Were you using the latest version of the script and MacroQuest?
  • When this bug occurred did it happen every time, or was it an intermittent issue?
  • How severe was the bug?
    
    • Did it stop the script entirely?
    • Were you able to manually intervene and make it past the bug?
    • Was it just a minor bug that threw errors but the script still functioned properly?
• Information you should not share publicly.
  
  • Do not upload the crash dump file to discord or the forums.
    
    • The crash dumps contain identifying information about your character and server. Only include the CrashID as this will allow the developers to look up that crash dump and see what happened.
  • Do not include any identifying information.
    
    • Do not include which server you play on (unless it is directly relevant to the bug.)
    • Do not include your character names.
    • Make sure any screenshots or logs that you share publicly have been sanitized of any character names.

 

[Lisie]

An example bug report
​

What happened?
While running Epic Laziness my character was supposed to be traveling to Everfrost but they were stopping every few steps and then starting again.

How often did it happen?
This is happening every time the script is trying to make my character travel.

What did you expect to happen?
The script should have ran to the destination without stopping every few steps.

Any relevant logs or screenshots?

[INFO   ] [ROG2.0-39] Resuming navigation to zone everfrost.
[SUPER-VERBOSE] [ROG2.0-39] Performing xtarget check.
[SUPER-VERBOSE] [ROG2.0-39] Checking if we are missing travel speed buff.
[VERBOSE] [ROG2.0-39] We do not have a travel speed buff to cast.
[SUPER-VERBOSE] [ROG2.0-39] Checking if we should be invis.
[SUPER-VERBOSE] [ROG2.0-39] Yes, we should be invis.
[VERBOSE] [ROG2.0-39] Checking if we are near a translocator npc before invising.
[INFO   ] [ROG2.0-39] Pausing navigation.
[INFO   ] [ROG2.0-39] Using invisibility.
[SUPER-VERBOSE] [ROG2.0-39] Using a cloudy potion.
[INFO   ] [ROG2.0-39] Resuming navigation to zone everfrost.
[SUPER-VERBOSE] [ROG2.0-39] Performing xtarget check.
[SUPER-VERBOSE] [ROG2.0-39] Checking if we are missing travel speed buff.
[VERBOSE] [ROG2.0-39] We do not have a travel speed buff to cast.
[SUPER-VERBOSE] [ROG2.0-39] Checking if we should be invis.
[SUPER-VERBOSE] [ROG2.0-39] Yes, we should be invis.
[VERBOSE] [ROG2.0-39] Checking if we are near a translocator npc before invising.
[INFO   ] [ROG2.0-39] Pausing navigation.
[INFO   ] [ROG2.0-39] Pausing script.
[INFO   ] [ROG2.0-39] Using invisibility.
[SUPER-VERBOSE] [ROG2.0-39] Using a cloudy potion.
[INFO   ] [ROG2.0-39] Resuming navigation to zone everfrost.
[SUPER-VERBOSE] [ROG2.0-39] Performing xtarget check.
[INFO   ] [ROG2.0-39] Pausing navigation.
[INFO   ] [ROG2.0-39] Pausing on step 39.

Did this occur more than once?
This is happening any time the script is trying to travel.

What did you expect to happen?
The script should have ran to the destination without stopping every few steps.

Did you have any other scripts or plugins running?
Lootly and MQ2Rogue were in use at the time of this issue.

What version of the script and MacroQuest were you running??
I was running v0.1.22 of Epic Laziness and the latest download of MacroQuest.

How severe was this bug?
It did not crash the script, but it made travel almost entirely non-functional due to the constant stops.

Any other relevant information?
This only happens on my rogue. When using my SK or Shaman the problem does not seem to happen.

 

[a_moss_snake]

Ctrl-C on crash windows should copy the text

 

[Lisie]

How to obtain logs and screenshots of windows
​

There are a few easy methods of gathering the necessary information to include in your bug report.

1. You may select the text in the MacroQuest console window and press Control+C to copy that text to the clipboard. And then use Control+V to paste that text into your post.
2. You can take a screenshot of your entire display. Press Print Screen and then open Paint. Paste the screenshot you just took into Paint with Control+V and then crop the image to only include the relevant section of the screenshot.
   1. Be sure to remove any identifying information. Draw a black box over any character names or other identifying information.
3. You can use a tool like Gyazo to create a screen capture of a specific area of your screen and then paste that image into your post.
4. You can use the included Windows snipping tool
   1. Press Windows Key + Shift + S to bring up the snipping tool. Then you may drag over an area of your screen to capture an image of that area.
5. If the script that is having the issue is set to log to a file you may open the MacroQuest.log file in the log directory and copy out any text from when the issue occured.
   1. Remember to remove any character names, server names, or other identifiable information.
6. On the EverQuest Crash Detected window you may use Control+C to copy the information in the window to a text format for posting.
   1. This will make it easy for you to include the CrashID in a text format that is easy to use.

That's it! I hope everyone finds this helpful.

​

 

[Redfrog]

Call the bugbusters
(apologies to @Lisie )