Difference between revisions of "Reporting Bugs"
Jump to navigation
Jump to search
GoogleFrog (talk | contribs) (Created page with "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 obser...") |
GoogleFrog (talk | contribs) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| 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. | + | # 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. |
# 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. | ||
| − | # | + | # In the main menu click Help, then click Report A Bug. |
# 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. |
| − | # Tell someone about this bug, perhaps in #support in Discord or on the forum. Paste | + | # 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. |
| + | 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. | ||
Latest revision as of 00:00, 23 March 2024
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.
- If the bug is a crash to desktop then skip to step 6, otherwise continue.
- Navigate back to the main menu of the lobby.
- In the main menu click Help, then click Report A Bug.
- Describe the bug, give the bug a title, and click Submit.
- Click 'Ok' on the Automated crash report dialogue that appears.
- Check the bug report tracker found 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.
- 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.
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:
Describe steps to reproduce the bug. Attaching images or linking a video is very helpful.
Reporting Desync[edit]
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
ClientGameStatefile 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
demos/. The file name contains the name of the map. - Your
infolog.txtfile, if the desync happened since the last time the ZK menu was opened. Older logs are found inlog/. - The two path cache files matching the map name, found in
cache/105dev-BAR105/paths/.
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.
