Version 1, last updated by sirebral at Jul 04 12:45 2009 UTC

This small guide will help users of Open RPG show the developers the precise location of bugs they encounter. Currently most bugs are not fatal, unless you run 1.7.5 then placing a mini on a map is. Most bugs will not force the software to crash, but each bug slows the software down and makes it less stable.

What is a Bug?

I bug is a problem in the code that creates an error or raises an exception. Bugs will print out in the Debug screen, Terminal, or Prompt with a Traceback and then they will display a list of files and the line numbers of those files which the error occurs in. The Traceback displays a list, even if there is only one bug. The list shows you in reverse order where the bug is, and then shows you all the other files affected. This means, The Last Line is the First Bug.

Finding Bugs

One of the easiest way to find bugs is to run OpenRPG_Debug.py. This opens a small window that will show you what is happening as the code is being read. Errors in the code will display here. Unfortunately this closes when you shut down Open RPG, but there is another option.

Terminal or DOS Prompt Running Open RPG in a terminal or a DOS prompt is a great way to save all of the data that passes through the debugging screen. These windows will stay open until you close them.

Detailing the Bugs

So now you know how to get a list of the bugs that happen during your playing experience. So how do you send bugs to developers with as little hassle as possible. Well, there are two ways that are easiest for us all. * Copy and Paste from the Terminal or Prompt * Send a screen shot in with your ticket

With some OS's ( I use Linux ) you can highlight the bug in your Terminal or Prompt and Right-Click > Copy and then paste it to your ticket. Not all OS's allow this, so I have another solution.

In every OS that I have worked with (Sorry Mac, you have not won me over yet) you can take a screen shot of the bug. Linux has that available as Accessories > Take Screenshot. Windows (XP, Vista) is gonna send you through a process.

Screen Shot in Win Platform

  1. Open Paint.
  2. Clear your desktop so the Bug is on top
  3. Press and Hold Ctrl then press Prnt Scrn. Ok, you can let go now.
  4. In Paint, you can now Paste your screen.

Screen shots will help the developers get a clear shot of the bug with no questions and no mistakes. Please make sure you have all of the bug, from Traceback to the first line.

Fin.