Thalassicus
Bytes and Nibblers
1. Solving Bugs
2. Logging
3. Mod Compatibility
4. One-Click Shortcut
This is an incredibly helpful process that often reveals useful stuff about bugs. You simply need to enable logging, then post your log file after a problem occurs. The log will usually contain an error message.
If removing other mods solves the problem (#8 on the common checklist), you can optionally do a divide-and-conquer search to track down which mod is causing the issue. (Clear your cache at each step!)
I use a few windows tricks to automatically clear cache, logs, and start the game while skipping the launcher - all in one click. Here's how:
2. Logging
3. Mod Compatibility
4. One-Click Shortcut
--- 1. Solving Bugs ---
- Please try things on the Common Checklist.
- Visit the issue tracker on github. Check if there is an open or closed issue for the problem you encountered.
- If no issue exists, post a new issue (preferred) or start a thread here on the bug tracking forum. Please link to your lua.log file if one exists (see 2. Log below).
It usually takes some time to figure out solutions to tracked issues. 99% of bugs are caught and squashed before releasing the mod to the public. The remaining bugs which escape are typically hard to discover, and more challenging to fix when found.
This thread is for informational purposes. Please post bugs in new threads in the Bug Tracking Forum, not here. It's much easier to track problems when they are not mixed up together in one thread.
--- 2. Error Log ---
This is an incredibly helpful process that often reveals useful stuff about bugs. You simply need to enable logging, then post your log file after a problem occurs. The log will usually contain an error message.
- Open this file:
\Documents\My Games\Sid Meier's Civilization 5\config.ini
. - Set:
MessageLog = 1
LoggingEnabled = 1
EnableLuaDebugLibrary = 1
. - When you notice the problem occur, end your turn, then zip & attach this file to your post:
\Documents\My Games\Sid Meier's Civilization 5\Logs\Lua.log
. - You can optionally post your log to the project issue tracker. This usually gets a quicker response. To do so, change the file name to Lua.png and attach it to a new post here:
https://github.com/Thalassicus/cep-bnw/issues
. - Set the earlier values back to =0 after posting the log file.
--- 3. Mod Compatibility ---
If removing other mods solves the problem (#8 on the common checklist), you can optionally do a divide-and-conquer search to track down which mod is causing the issue. (Clear your cache at each step!)
- Move half the mods out of the mods folder and see if the problem happens.
- If the problem doesn't happen, move the current half out and stored half in.
- Whichever half causes the problem, then try only half of that half, and keep splitting the list in half until you have the 1 mod causing the bug. This very quickly isolates the mod causing a problem.
- In the Bug Tracking forum, post which mod you found causes the problem.
--- 4. One-Click Shortcut ---
I use a few windows tricks to automatically clear cache, logs, and start the game while skipping the launcher - all in one click. Here's how:
- Create a launcher-skipping shortcut.
- Create a .bat file to delete the folders.
- Create a shortcut to the .bat file.
- If you don't know your version of DirectX, click Start -> Run -> type "dxdiag" and hit enter to see it.
. - Go to this folder:
C:\Thalassicus\Documents\My Games\Sid Meier's Civilization 5\MODS
. - Create a shortcut in the MODS folder named "Civilization V (Leave Cache)" with a target pointed towards your game location, like below. Replace dx11 with whatever version of DirectX you use:
"C:\Games\Steam\steamapps\common\sid meier's civilization v\Launcher.exe" /dx11
. - Open Start -> Run -> "notepad.exe"
. - Copy this into the text file:
Code:@echo off rd /s /q "C:\Thalassicus\Documents\My Games\Sid Meier's Civilization 5\cache" rd /s /q "C:\Thalassicus\Documents\My Games\Sid Meier's Civilization 5\Logs" call "C:\Thalassicus\Documents\My Games\Sid Meier's Civilization 5\MODS\Civilization V (Leave Cache).lnk" @echo on
. - Change the "C:\Thalassicus" paths in the file above to the actual path of your Mods folder.
. - Save the file as "Civilization V.bat" to your MODS folder.
. - Create a second shortcut in the MODS folder named "Civilization V" with a target like this:
explorer "C:\Thalassicus\Documents\My Games\Sid Meier's Civilization 5\MODS\Civilization V.bat"
. - Drag-and-drop shortcut #2 ("Civilization V") to your taskbar.