Can we get a tutorial for submitting CTD bug reports to Github?

[JamesNinelives]

I keep hearing how important it is, but as a first-time user it requires significantly more steps than just 'do the thing'.

I've created an account for myself using the same username as the civ forums so I'm easy to identify and use an email that I actually check sometimes so that people can contact me via it if they need to. Confirmed my account via my email, went back to Civfanatics and found a recent post by Gazebo, clicked on the link in Gazebo's signature that he talked about recently and navigated to the relevant error page. Maybe that seems like it should be obvious and easy for everyone but for me it's not.

Now I'm at the stage of commenting (I assume that's what I'm supposed to do?) with the details following the format posted by the person who created the thread. I know how to look up my modlist and copy it down. Now to submit supporting evidence.

And it's telling me that my file type is not supported. OK, I can do problem solving. I don't know what all file format jargon is but OP posted zipped files, so I'll use that program I downloaded ages ago to try zipping it. File type still not accepted. Guess I must have the wrong one?

This is the point that I really start to get frustrated. Because identifying and downloading a program I'm not familiar with and installing it on my computer is something that causes me a lot of anxiety. I want to help, but it seems to be a lot more complicated than how it's been described to me.

Moreover, I see that the report requests log files that I have to go through a seperate process to active before playing the game in order to get them. What's the protocol here? Is it rude to submit my report without either of the supporting documents? Can I save what I've written and come back to it (and if so which button do I press), or should I put in into a word document and save it to my PC?

I've been on Civfanatics for few months now and that took some time to adjust in itself. Yes, I have a mental illness (social and generalized anxiety) but I consider myself fairly intelligent and motivated. I'm fairly young, know how to use a file system, a web browser, and a few other tools. But I'm not a programmer. I had never even heard of the website Github before now.

Given how many people are active in discussion for this beta vs. the number of reports submitted I have to wonder if I'm not the only one. There are people in our community for who are still new to this website, people for whom English is their 3rd language, and probably other stuff like not having a lot of time, had a stressful day at work, a slow computer or internet connection and whatever that I don't even know about.

If we want people to submit bug reports so badly, can we get a little more guidance than just 'submit a bug report'? Maybe sticky it at the top of the sub so it's easy to find.

 

[tu_79]

ZIP files should be accepted. Just try with Windows own compressing tool. Right click on the folder you want to compress, then select Sent to --> Compressed folder. That should work.

 

[JamesNinelives]

ZIP files should be accepted. Just try with Windows own compressing tool. Right click on the folder you want to compress, then select Sent to --> Compressed folder. That should work.

Thank you. I will try.

Edit: To be clear, I did not know how to do this. Thank you for specific instructions.

 

[andersw]

You need to know
What version you are using.

Where to find the files, they are usually as follows:
Save file: (find the one needed dont grab the entire folder)
\Documents\My Games\Sid Meier's Civilization 5\ModdedSaves\single
Log files:
NOTE logs must be turned on (I forgot where)
\Documents\My Games\Sid Meier's Civilization 5\Logs
Crash dump:
C:\Program Files (x86)\Steam\steamapps\common\Sid Meier's Civilization V\CvMiniDump.dmp

If things are installed in non standard folders you need to know where (you made that choice right?).
Compress files with Zip for smaller size.
Github supports drag and drop from filemanager -> browser.

 

[JamesNinelives]

Thank you also!

It worked (mostly). I think there are two issues open for the same thing and I posted in the wrong one. Hopefully it is possible to merge them?

Also, I went to where the crash dumps should be and it's empty. The other stuff is in the normal folders so I'm not sure what is going on.

 

[Recursive]

I keep hearing how important it is, but as a first-time user it requires significantly more steps than just 'do the thing'.

I've created an account for myself using the same username as the civ forums so I'm easy to identify and use an email that I actually check sometimes so that people can contact me via it if they need to. Confirmed my account via my email, went back to Civfanatics and found a recent post by Gazebo, clicked on the link in Gazebo's signature that he talked about recently and navigated to the relevant error page. Maybe that seems like it should be obvious and easy for everyone but for me it's not.

Now I'm at the stage of commenting (I assume that's what I'm supposed to do?) with the details following the format posted by the person who created the thread. I know how to look up my modlist and copy it down. Now to submit supporting evidence.

And it's telling me that my file type is not supported. OK, I can do problem solving. I don't know what all file format jargon is but OP posted zipped files, so I'll use that program I downloaded ages ago to try zipping it. File type still not accepted. Guess I must have the wrong one?

This is the point that I really start to get frustrated. Because identifying and downloading a program I'm not familiar with and installing it on my computer is something that causes me a lot of anxiety. I want to help, but it seems to be a lot more complicated than how it's been described to me.

Moreover, I see that the report requests log files that I have to go through a seperate process to active before playing the game in order to get them. What's the protocol here? Is it rude to submit my report without either of the supporting documents? Can I save what I've written and come back to it (and if so which button do I press), or should I put in into a word document and save it to my PC?

I've been on Civfanatics for few months now and that took some time to adjust in itself. Yes, I have a mental illness (social and generalized anxiety) but I consider myself fairly intelligent and motivated. I'm fairly young, know how to use a file system, a web browser, and a few other tools. But I'm not a programmer. I had never even heard of the website Github before now.

Given how many people are active in discussion for this beta vs. the number of reports submitted I have to wonder if I'm not the only one. There are people in our community for who are still new to this website, people for whom English is their 3rd language, and probably other stuff like not having a lot of time, had a stressful day at work, a slow computer or internet connection and whatever that I don't even know about.

If we want people to submit bug reports so badly, can we get a little more guidance than just 'submit a bug report'? Maybe sticky it at the top of the sub so it's easy to find.

1 - Create an account on Github.

2 - To open a new bug/issue report, go to this page: https://github.com/LoneGazebo/Community-Patch-DLL/issues/new

3 - List what version you're playing (if you're using a hotfixed version, or modified local files such as a replacement DLL, be sure to note it).

4 - If you're using mods other than VP, list which ones you're using in the report.

5 - Describe the bug or issue in as much detail as possible. If the problem is something such as a simple typo, missing piece of information, or wrong number, a description (possibly with screenshots) will usually suffice.

6 - To assist the developers in solving your bug/issue, you can attach screenshots of the problem (these can be uploaded directly, no need for .zip files). You can also include instructions on how to replicate the problem, if you know how to replicate it.

For game crashes, AI bug reports or more complicated issues, additional steps are required:

7 - If you've enabled logging (which you should if you plan on submitting any reports), your logs on Windows should be found at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\Logs.

(Note: If you haven't enabled logging, but you have a save file one turn before the issue occurred, and the issue can be replicated: you can enable logging, load the save, repeat the issue, and logs should appear.)

8 - Create a .zip file for your logs by right clicking the Logs folder and selecting Send to > Compressed (zipped) folder.

9 - Add at least one save file to the zipped Logs folder (or if you choose, you can upload it in a separate zipped folder; doesn't matter).

You should ideally select a save file one turn before the bug or issue occurred. If you feel other save files would be useful in diagnosing the problem, feel free to attach more.

To make sure you have an autosave for every turn, it is advisable to change 'Turns Between Autosaves' to 1 and 'Max Autosaves Kept' to 999 in the game's Options (accessible via the Main Menu).

Save files on Windows can be found at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\ModdedSaves\single.

Autosaves can be found one subfolder deeper, at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\ModdedSaves\single\auto.

10 - In the case of a game crash (also called a CTD - crash to desktop) you need to add an additional file in zipped form, the CvMiniDump crash report which contains details on why the game crashed.

Occasionally the game can crash without generating a crash report. If there is no crash report, note this fact in your issue report (rather than leaving it blank).

The CvMiniDump.dmp file can be found if the game has crashed on Windows in the
C:\Program Files\Steam\steamapps\common/Sid Meier's Civilization V folder.

(Note: on some systems Steam may be in the C:\Program Files (x86) folder.)

11 - Upload your files and submit the issue.

Instructions to enable logging:

These are the complete instructions to enable detailed logging of numerous game events. It is highly recommended to enable logging in case you plan on submitting any issue reports.

1. Locate the config.ini file (usually in the "C:\Users\{username}\Documents\My Games\Sid Meier's Civilization 5" sub-directory)
2. Using a plain text editor (such as Notepad) open it
3. Search for the text "ValidateGameDatabase" (it's near the top)
4. Change it to
   

   ; Validates the game database whenever it is changed.
   ValidateGameDatabase = 1

5. Search for the text "LoggingEnabled" (it's just over half way down)
6. Change it to
   

   ; Enable the logging system
   LoggingEnabled = 1

7. Search for the text "MessageLog"
8. Change it to
   

   ; Enable message logging
   MessageLog = 1

9. Search for the text "AILog"
10. Change it to
    

    ; Enable AI logging
    AILog = 1

11. Search for the text "AIPerfLog"
12. Change it to
    

    ; Enable AI performance logging
    AIPerfLog = 1

13. Search for the text "BuilderAILog"
14. Change it to
    

    ; Enable Builder AI logging
    BuilderAILog = 1

15. Search for the text "PlayerAndCityAILogSplit"
16. Change it to
    

    ; Split AI Logging into separate files for each Player & City
    PlayerAndCityAILogSplit = 1

17. Save your changes!

The log files will now (usually) be written to "C:\Users\{username}\Documents\My Games\Sid Meier's Civilization 5\Logs".

You only need to do this once, unless you delete the config.ini file or uninstall the game (or install it to a new OS, etc), you do not need to do this every version.

Note to Others Reading This
Feel free to repost and/or sticky this information if it is useful.

Credit goes to whoward's original post and the posters in his thread for the logging instructions.

 

[JamesNinelives]

1 - Create an account on Github.

2 - To open a new bug/issue report, go to this page: https://github.com/LoneGazebo/Community-Patch-DLL/issues/new

3 - List what version you're playing (if you're using a hotfixed version, or modified local files such as a replacement DLL, be sure to note it).

4 - If you're using mods other than VP, list which ones you're using in the report.

5 - Describe the bug or issue in as much detail as possible. If the problem is something such as a simple typo, missing piece of information, or wrong number, a description (possibly with screenshots) will usually suffice.

6 - To assist the developers in solving your bug/issue, you can attach screenshots of the problem (these can be uploaded directly, no need for .zip files). You can also include instructions on how to replicate the problem, if you know how to replicate it.

For AI bug reports or more complicated issues, additional steps are required:

7 - If you've enabled logging (which you should if you plan on submitting any reports), your logs on Windows should be found at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\Logs.

(Note: If you haven't enabled logging, but you have a save file one turn before the issue occurred, and the issue can be replicated: you can enable logging, load the save, repeat the issue, and logs should appear.)

8 - Create a .zip file for your logs by right clicking the Logs folder and selecting Send to > Compressed (zipped) folder.

9 - Add at least one save file to the zipped Logs folder (or if you choose, you can upload it in a separate zipped folder; doesn't matter).

You should ideally select a save file one turn before the bug or issue occurred. If you feel other save files would be useful in diagnosing the problem, feel free to attach more.

To make sure you have an autosave for every turn, it is advisable to change 'Turns Between Autosaves' to 1 and 'Max Autosaves Kept' to 999 in the game's Options (accessible via the Main Menu).

Save files on Windows can be found at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\ModdedSaves\single.

Autosaves can be found one subfolder deeper, at C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\ModdedSaves\single\auto.

10 - In the case of a game crash (also called a CTD - crash to desktop) you need to add an additional file in zipped form, the CvMiniDump crash report which contains details on why the game crashed.

Occasionally the game can crash without generating a crash report. If there is no crash report, note this fact in your issue report (rather than leaving it blank).

The CvMiniDump.dmp file can be found if the game has crashed on Windows in the
C:\Program Files\Steam\steamapps\common/Sid Meier's Civilization V folder.

(Note: on some systems Steam may be in the C:\Program Files (x86) folder.)

11 - Upload your files and submit the issue.

Instructions to enable logging:

These are the complete instructions to enable detailed logging of numerous game events. It is highly recommended to enable logging in case you plan on submitting any issue reports.

1. Locate the config.ini file (usually in the "C:\Users\{username}\Documents\My Games\Sid Meier's Civilization 5" sub-directory)
2. Using a plain text editor (such as Notepad) open it
3. Search for the text "ValidateGameDatabase" (it's near the top)
4. Change it to
   

   ; Validates the game database whenever it is changed.
   ValidateGameDatabase = 1

5. Search for the text "LoggingEnabled" (it's just over half way down)
6. Change it to
   

   ; Enable the logging system
   LoggingEnabled = 1

7. Search for the text "MessageLog"
8. Change it to
   

   ; Enable message logging
   MessageLog = 1

9. Search for the text "AILog"
10. Change it to
    

    ; Enable AI logging
    AILog = 1

11. Search for the text "AIPerfLog"
12. Change it to
    

    ; Enable AI performance logging
    AIPerfLog = 1

13. Search for the text "BuilderAILog"
14. Change it to
    

    ; Enable Builder AI logging
    BuilderAILog = 1

15. Search for the text "PlayerAndCityAILogSplit"
16. Change it to
    

    ; Split AI Logging into separate files for each Player & City
    PlayerAndCityAILogSplit = 1

17. Save your changes!

The log files will now (usually) be written to "C:\Users\{username}\Documents\My Games\Sid Meier's Civilization 5\Logs".

You only need to do this once, unless you delete the config.ini file or uninstall the game (or install it to a new OS, etc), you do not need to do this every version.

Note to Others Reading This
Feel free to repost and/or sticky this information if it is useful.

Credit goes to whoward's original post and the posters in his thread for the logging instructions.

Thank you! This is perfect .

 

[azum4roll]

If you use modpacks like me the save files should be in another folder (since you didn't enter the MODS menu).

 

[JamesNinelives]

If you use modpacks like me the save files should be in another folder (since you didn't enter the MODS menu).

I don't use modpacks myself. If I understand correctly I think modpack saves should be in the same place as non-modded saves, which is:

C:\Users\[user]\Documents\My Games\Sid Meier's Civilization 5\Saves\single.

Anyone feel free to correct me if that's wrong.

 

[Rekk]

1 - Create an account on Github.
...

Can you repost this to the bug reports sticky?

 

[Recursive]

Can you repost this to the bug reports sticky?

Maybe we should update the bug reports sticky...

 

[Rekk]

Maybe we should update the bug reports sticky...

I've asked, maybe you'll have better luck.