Welcome to the Bug Report Category!

Found a bug in Stonehearth? Help us fix it by telling us everything you know about it!

##Bug Report Guidelines

1) Check the other posts in the category to see if the bug has already been reported:

If it has been, open that thread and add whatever details that haven’t already been described.

If you have experienced the bug as well, please like the original post to help Team Radiant notice that it’s a bug that’s happening a lot.

2) If it’s a new bug, open a new thread for the bug and include the following information:

A short title that briefly summarizes the bug for a quick read to get the idea. Prefix with Bug: so it's easy to search for all bugs at once. (ex. Bug: Every Morning, People Heads Are Replaced With Rabbit Heads)

Describe the problem in detail. Exactly how did you get it to happen? Does it happen all the time, or only rarely? Add *anything* you think might be important to the bug report.

Steps to reproduce:
Distill what you did into as many steps as necessary. The more steps describing the bug the better. This is the most important part of the reporting process, as bugs that can't be reliable reproduced are exceptionally more difficult to resolve. It may seem silly, but don't assume we know exactly how you did what you did. :) 

Expected Results:
What you thought would happen or what you might have expected to happen is not what was actually intended to happen (and then it's a slightly different bug, of expectation.)

Actual Results:
If significantly different from the summary, what actually did happen.

Anything that didn't fit above

Short description of each attachment if necessary. 

Versions and Mods:
What version of the game are you running? Did you install any 3rd party mods or make any mods yourself? If so, list them here too. Does the bug still happen if you remove all the mods?

System Information:
What system are you using? Especially for performance/graphics issues, note your OS, CPU, Memory, Graphics Card, and any other details you think might be relevant. 

3) Discussion in a separate linked thread, please:

If you’d like to discuss a bug (ie, how you feel about it, how you think it reflects on the implementation of the game, how it changes the current gameplay balance etc) make a separate thread and link it to the description thread.

That way, while debugging, Team Radiant can get to the facts that will help us narrow down the relevant code-area as fast as possible, and look at the discussion section separately. Clean descriptive bugs will definitely be easier to address than vague ones!

Bus Report Status

As bugs are submitted, discussed and addressed, they will move through various stages. Moderators will apply tags to each report, and this list will explain what they mean:

No tags :arrow_right: The initial bug report submission.

Topic-centric tags (ie. #building, #crafting, #ai) :arrow_right: Initial moderator tagging.

#confirmed_by_users tag added :arrow_right: One or more forum members have replied in the thread with the same bug, and has been confirmed to not be an isolated incident.

#acknowledged_by_devs tag added :arrow_right: The bug has been acknowledged by Radiant, and they have added it to the running list of issues to resolve.

#fixed_for_next_build tag added :arrow_right: The bug has been fixed by Radiant, and the fix will be in the next released build.

#fixed_for_next_alpha::tag tag added :arrow_right: The bug has been fixed by Radiant, and the fix will be in the next alpha. This tag is used when a bug is fixed but development has already started on the next alpha.

#resolved tag added :arrow_right: The bug has been resolved and the build with the fix has been released.

#not_a_bug tag added :arrow_right: The reported issue was deemed to not be a bug, but perhaps a misunderstood, intended experience.

#not_reproducible tag added :arrow_right: The reported issue may be a bug, but the developers were not able to recreate the issue in their testing, and thus cannot fix the error.

#no_longer_applicable tag added :arrow_right: The reported issue may have been a bug, but the feature and/or code reported is no longer in use, and thus the bug report is no longer applicable.

#duplicate tag added :arrow_right: The reported issue is the same as a previously reported bug, and the topics have been merged.


Example bug report

Bug : Opening crafting window from carpenter “craft” icon does nothing

I was trying to open the carpenter’s craft window in order to tell him to create 2 new tables. When the unit was selected, his unit info UI appeared but clicking the saw icon beside his name did not bring up the screen that would let me select what I wanted him to create. Clicking on the icon didn’t produce an error, it simply failed to generate any reaction from the unit (as if the command wasn’t being registered).

Steps to reproduce:

  1. Select Stendor Markon (the carpenter)
  2. Once selected, click the saw icon from his unit frame
  3. Watch as it looks like the action is registered (quick animation), but the screen never comes up

Expected Results:
I expected the carpenter UI screen to appear.

Actual Results:
The UI screen is not appearing, though it looks like the button click was picked up.

It may be nothing, but I also noticed that when the saw icon was selected, the unit would start a walking animation each time, but it would end abruptly.

I’ve attached my most recent save file, with the unit in question standing near the carpenter’s workbench.

bug-report-sample-attachment.txt (27 Bytes)

Versions and Mods:
I’m running Stonehearth v0.1.45 and have no additional mods running during this save game.

System Information:
Windows 7 Enterprise 64 | AMD dual core proc | 4GB system memory | nVidia 9500 GT

Bug report template

Feel free to copy/paste this template into your own reports… thanks!



Steps to reproduce:

Expected Results:

Actual Results:



Versions and Mods:

System Information:

Alternatives to uploading bug report files

While the discourse will allow users to upload files of the following types (.jpg, .jpeg, .png, .gif, .txt, .csv, .log, .obj, .qmo, .doc, .docx, .pdf, .xml, .evtx), some of you may prefer to directly copy/paste error messages and other system details associated with your report.

Here are a number of free sites that offer this feature:

Locating system information

This will allow you to share details like OS, system memory, processor and more.

Method #1

  1. Start > Run (or win+R)
  2. Type “msinfo32”

Method #2: Windows XP and Vista

  1. Click “Start” on the Taskbar
  2. Go to “All Programs”
  3. Go to “Accessories”
  4. Go to “System Tools”
  5. Click “System Information”

Method #3: Windows 7

  1. Click “Start” on the Taskbar
  2. Click on Control Panel
  3. Click on System
1 Like

Collecting DirectX Diagnostic details

The DirectX Diagnostic Tool is designed to help you troubleshoot DirectX-related issues and gives detailed information regarding your computers graphics, sound and other devices related to gaming.

  1. From your desktop, press the Windows key and the R key to open the Run window.

  2. In the “Open:” field of the Run window, type “DXDIAG.”

  3. Click OK or press the Enter key to open the DirectX Diagnostic Tool (if prompted to check if your drivers are digitally signed, click Yes).

  4. In the DirectX Diagnostic Tool window, click the “Save All Information…” button.

  5. In the “Save As” window, the DirectX information will be saved as a text (.txt) file. Designate where the file will be saved (such as the Desktop or other easily accessible location) and then click on the “Save” button.

Capturing event logs

Event logs are special files that record significant events on your computer, such as when a program encounters an error.

Windows 7 (source)

  1. Open the Control Panel from the Start Menu.

  2. Open Administrative Tools in the Control Panel.

    Note: If Administrative Tools is not available, change View by to Large icons at the top right of the Control Panel.

  3. Open Event Viewer in the Administrative Tools window.

  4. Expand Windows Logs and then select System or any of the other logs Windows 7 collects. Double-click one of the logged events in the top center pane of the Event Viewer to see details about the event.

  5. The Event Properties window shows details about the selected event.

Windows 8 (source)

  1. From the Start screen of Windows, type Computer.

  2. Right-click the Computer app. Additional options will appear at the bottom of the screen.

  3. At the bottom of the screen, click Manage.

  4. In the Computer Management window, click the arrow next to Event Viewer.

  5. Click the arrow next to Windows Logs.

  6. Right-click Application and select Save All Events As…

  7. Save the .evtx file to your Desktop with the name Application.

  8. Right-click System and select Save All Events As…

  9. Save the .evtx file to your Desktop with the name System.

  10. Close the Computer Management window.