Difference between revisions of "How To Report a Bug in Overgrowth"
Silverfish (talk | contribs) (→General Information: Removed assumption that the bug is a crash) |
|||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | To report a bug you've found in Overgrowth, send an email to [mailto:[email protected] [email protected]]. To ensure that we get as much relevant information as possible, follow the instructions on this page. | |
== General Information == | == General Information == | ||
| − | To fix a bug, it's usually important that we are able to reproduce the problem | + | To fix a bug, it's usually important that we are able to reproduce the problem. To help us do that we appreciate the following information in your mail. |
| − | * What version of the game you're running, including where you downloaded the game and if you're running the | + | * What version of the game you're running, including where you downloaded the game and if you're running the stable release or some other test version. |
| − | * | + | * If the game crashed, what you were doing when it crashed, including how long the game had been running, what levels you've been playing and what in-game features have been used in the editor (if any). |
* What operating system you are running, and what version. | * What operating system you are running, and what version. | ||
== Files we are interested in == | == Files we are interested in == | ||
| − | While running, the game writes multiple files into a local cache directory, | + | While running, the game writes multiple files into a local cache directory, in those there is information that is useful to us when solving your issue. |
| − | Depending on your operating system (Windows, Linux or | + | Depending on your operating system (Windows, Linux or Mac) the local cache directory will be in a different place, following are the directories for the respective operating system. |
| − | * Mac: <code>Macintosh HD/Users/~/Library/Application Support/ | + | * Mac: <code>Macintosh HD/Users/~/Library/Application Support/Overgrowth/</code>. Where '~' is your username. |
* Windows: <code>My Documents\Wolfire\Overgrowth\</code> | * Windows: <code>My Documents\Wolfire\Overgrowth\</code> | ||
* Linux: <code>~/.local/share/Overgrowth/</code> | * Linux: <code>~/.local/share/Overgrowth/</code> | ||
| Line 21: | Line 21: | ||
In the cache directory there are primarily two files we are interested in. | In the cache directory there are primarily two files we are interested in. | ||
| − | * Data/hwreport.txt | + | * '''Data/hwreport.txt''' - Contains information about what hardware your computer contains. |
| − | * logfile.txt | + | * '''logfile.txt''' - Logfile of the games execution. |
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents. | If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents. | ||
| Line 32: | Line 32: | ||
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from. | We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from. | ||
| − | And finally, | + | And finally, thank you for taking the time to report bugs. It goes a long way to ensure Overgrowth is as stable as possible. |
| + | |||
| + | [[Category: Overgrowth]] | ||
Latest revision as of 06:58, 5 June 2018
To report a bug you've found in Overgrowth, send an email to [email protected]. To ensure that we get as much relevant information as possible, follow the instructions on this page.
General Information
To fix a bug, it's usually important that we are able to reproduce the problem. To help us do that we appreciate the following information in your mail.
- What version of the game you're running, including where you downloaded the game and if you're running the stable release or some other test version.
- If the game crashed, what you were doing when it crashed, including how long the game had been running, what levels you've been playing and what in-game features have been used in the editor (if any).
- What operating system you are running, and what version.
Files we are interested in
While running, the game writes multiple files into a local cache directory, in those there is information that is useful to us when solving your issue.
Depending on your operating system (Windows, Linux or Mac) the local cache directory will be in a different place, following are the directories for the respective operating system.
- Mac:
Macintosh HD/Users/~/Library/Application Support/Overgrowth/. Where '~' is your username. - Windows:
My Documents\Wolfire\Overgrowth\ - Linux:
~/.local/share/Overgrowth/
In the cache directory there are primarily two files we are interested in.
- Data/hwreport.txt - Contains information about what hardware your computer contains.
- logfile.txt - Logfile of the games execution.
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.
Finally
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.
And finally, thank you for taking the time to report bugs. It goes a long way to ensure Overgrowth is as stable as possible.
