Editing Reporting Bugs

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
To do a basic bug report do the following:
 
To do a basic bug report do the following:
# Cause the bug to occur. This will often involve running a battle. If you can, put some unique sentence in the chat after you observe the bug, and tell people about this sentence later on.
+
# Cause the bug to occur. This will often involve running a battle. If you can, put some unique sentence in the chat after you observe the bug.
 
# If the bug is a crash to desktop then skip to step 6, otherwise continue.
 
# If the bug is a crash to desktop then skip to step 6, otherwise continue.
 
# Navigate back to the main menu of the lobby.
 
# Navigate back to the main menu of the lobby.
Line 6: Line 6:
 
# Describe the bug, give the bug a title, and click Submit.
 
# Describe the bug, give the bug a title, and click Submit.
 
# Click 'Ok' on the Automated crash report dialogue that appears.
 
# Click 'Ok' on the Automated crash report dialogue that appears.
# Check the bug report tracker found [https://github.com/ZeroK-RTS/CrashReports/issues here] and find your report. It should be at the top of the page and recent. If all the reports are too old, then try refreshing the page.
+
# Your web browser should open a web page with your bug report. Copy the link to this page.
# Tell someone about this bug, perhaps in #support in Discord or on the forum. Paste the bug report link from step 7 when you do so.
+
# Tell someone about this bug, perhaps in #support in Discord or on the forum. Paste you link when you do so.
Taking and attaching a screenshot is vital for visual bugs.
 
 
 
For crashes rather than bugs, skip straight to Step 7.
 
 
 
For a more advanced bug report create a GitHub account and open an issue on the appropriate issue tracker:
 
* [https://github.com/ZeroK-RTS/Zero-K Bugs in the game itself]
 
* [https://github.com/ZeroK-RTS/Chobby Bugs in the main menu]
 
* [https://github.com/ZeroK-RTS/Zero-K-Infrastructure Bugs on the website]
 
Describe steps to reproduce the bug. Attaching images or linking a video is very helpful.
 
 
 
= Reporting Desync =
 
 
 
Reports of desync are made much more useful with the inclusion of a few files. The player who desynced needs to supply these files so that they can be checked against normal files from another player. The files, relative to the root Zero-K folder (found in steamapps), are:
 
# The appropriate <code>ClientGameState</code> file in the root directory. These don't have a naming convention, but the first line of the file is the map name, and the file creation date should match the time of the desync.
 
# Your locally saved replay of the game, found in <code>demos/</code>. The file name contains the name of the map.
 
# Your<code>infolog.txt</code> file, if the desync happened since the last time the ZK menu was opened. Older logs are found in <code>log/</code>.
 
# The two path cache files matching the map name, found in <code>cache/105dev-BAR105/paths/</code>.
 
 
 
The battle link is also useful. This can be found under recent battles on your home page when logged in: https://zero-k.info/
 
 
 
Another great help is running the replay and reporting whether the game you see in the replay is the same as the one that happened the first time around.
 

Please note that all contributions to Zero-K are considered to be released under the Creative Commons Attribution-ShareAlike (see Zero-K:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)