Reporting Bugs

by Enelvon

Summary

I realized that we have never formally explained a process for reporting bugs with SES scripts and decided to take the time to rectify that error. There are three preferred methods, all of which are described below.

How to Report an Error

1) Reporting Errors through GitHub
This is the best way to report an error, but it will require a GitHub account. If you look at the options on the right side of the repository for any script you will notice a tab that is labelled ‘Issues.’ Click on this and then press the green “New issue” button on the upper-right. Give it a name and description and submit it! We’ll correct it as soon as we can.

2) Reporting Errors through the SES Blog
This is another good way to report errors. Simply post a comment on the post for the most recent release of the script! The comment will not be displayed immediately as we do have moderation turned on, but we will approve it the next time that we check the blog and will fix the error as soon as possible. Once one of your comments has been approved, future comments will automatically be approved.

3) Reporting Errors through the RPG Maker Web Forums
This is the most hit-or-miss way to report errors, as Solistra and I tend to be rather lax about checking the forums. That said, it will suffice for most users. Simply go to the release thread for the script and make a post! We will add it to the list of errors to correct as soon as we become aware of it.

Post Contents

All errors will be given attention, but poorly-documented errors will be given a far lower priority than well-documented ones. Here are some basics dos and don’ts.

DO

  • Post a screenshot of any graphical error
  • If the error causes a crash, provide either a screenshot or textual representation of the crash message
  • Provide as much context as you can – what did you do in the time leading up to the error?
  • Give a list of scripts that you’re using that affect similar things – if Enhanced Events causes a crash, what other event-related scripts do you use? If the Bestiary is causing problems, do you use any unusual enemy-related scripts?

DON’T

  • Say “It crashed my game” without context information
  • Say “It doesn’t work” without describing *what* doesn’t work and the way you attempted to set it up
  • Anything that involves posting without specific details about the problem

Here is an example of a well-reported non-fatal error. Note that the suspected problem is outlined clearly through the use of quoted code. A possible solution is also provided – this is not essential, as many users may not possess knowledge of scripting, but if you feel like you may be able to provide a solution then feel free to post it. If the solution works or helps a working solution to be found, it will allow a fixed version of the script to be released that much more quickly.

In short, Solistra and I may be capable of quickly writing and debugging efficient and useful scripts, but we are not perfect. We can and will miss bugs, and as such rely on reports given by you, our users. Without you, we would have a far more difficult time producing error-free scripts.

Thank you.