This page is a part of the Civ5 Modding Tutorials.
Sid Meier's Civilization® V is the fifth offering in the multi-award winning Civilization strategy game series featuring the famous “just one more turn” addictive gameplay that has made it one of the greatest game series of all time. CIVILIZATION VI - Fun With FireTuner Just a demonstration of a few of the cool things you can do with FireTuner in Civilization 6. How to enable autoplay in Civilization 6. Civilization franchise, which has sold in over 35 million units worldwide, including more than 8 million units of Civilization V. Read Full Review. Sid Meier's Civilization was a watershed for the 4x genre before the genre even had its present name. While there had been earlier games that incorporated many of the features, such as conquest, tech trees, and city management, Sid Meier's landmark game brought them all together and with the necessary oomph and flair to appeal to a large demographic beyond just wargamers that. Sid Meier's Civilization® V is the fifth offering in the multi-award winning Civilization strategy game series featuring the famous “just one more turn” addictive gameplay that has made it one of the greatest game series of all time. Bounce us the max: Are you a pic spunky developer? Board publishing highborn Sid Meier's Refinement 5 SDK FireTuner (civ 5 cheats). Download sid meiers civilization 5 sdk torrents free, Wax Download via Bittorrent clients. Twisting in the multi-award victorious Civilisation turn.
- 2XML Debugging
- 3Lua Debugging
- Did you correctly import to the VFS the files that need to be?
- Did you correctly set up the actions and content tab in your project?
- Did you restart civ5 after you added new files?
Checking the logs
If you correctly set up your #Configuration, whenever you start a game, Civ5 saves some logs under My Games/Sid Medier's Civilization V/cache/Civ5DebugDatabase.db
.
- If there were errors with the XML formatting of your data files (wrong column names for example), they will logged in XML.log. Some of those errors may be fatal: in such a case no mod is loaded!
- If there were errors with the data integrity (missing foreign keys for example - types that reference rows from other tables), they will logged in database.log.
Using the snapshots
If you correctly set up your #Configuration, whenever you start a game, Civ5 saves a snapshot of the database under My Games/Sid Medier's Civilization V/cache/Civ5DebugDatabase.db
- This allows you to check how your XML and SQL files have been merged with the standard game data.
Using the Firetuner console
If you correctly set up your #Configuration, Civ5 will send all the Lua output to the Firetuner (and also to the Lua.log
file). This includes all the debugging output but also any error that may arise, with their calls stack traces.
Here we can see that a C/C++ code (the game engine) ran the main chunk called (the Lua file), which then called the function ScanAll on line 188, which then called dumpObj on line 95. And this one caused an error on line 41.
Note that paths are truncated in the provided example, which makes debugging harder sometimes. This happens when the file is in a context registered by the project's content tab. Here are the workarounds:
- Provide a custom stack trace, as explained in a further section.
- Register only a minimalist context, that will load additional contexts (through the UI LuaContext markup). Do not initiate any action from the root context, let the children context handle everything.
- Modifying your system paths is not recommended as it can cause incompatibilities with a few applications (old or badly written).
Print, assert and error
print(...)
can be used to print anything to the Firetuner output. This allows you to check the flow of a program, or the values of variables. Print calls tostring on every argument and displays them all on a single line with tabulations as separators between them. Nil values are not displayed, so it is advised you provide expressions such as: (expr or 'nil')
error(string message, int level = 1)
throws an error with the specified message. The execution is then halted and the hand returned to the game engine (or the current protected call if you did use pcall or xpcall). The level parameter controls the error position that will be reported. 1 for the line where error is located, 2 for the function call that contained an error, etc. 0 for no position.
assert(variant condition, string message = 'assertion failed')
can be used to assert the provided condition is neither nil nor false (everything else is evaluated to true in Lua). Otherwise, an error with the specified message is thrown. You can use them punctually, as a debugging technique. But they may also be used as a defensive programming technique similar to design-by-contract: the idea is that whenever your program's correctness relies on an assumption, you should explicitly check it. For example, if a function takes an array as an argument and assumes that it is not empty, you should add two conditions at the beginning: assert(type(t) 'table')
and assert(#t > 0)
. This makes the code more self-explanatory (implicit assumptions are now explicitly stated) and it allows you to catch bugs as soon as possible, which typically makes them easier to understand and fix.
The end users' feedback
Most of the time, when one of your user encounters an error with your mod, he just stops using it. A fraction of them will do the effort of reporting bugs but too often the informations they provide is unusable (from 'it doesn't work' to wrong reproduction steps 'play until turn 173 and wait for Mars being aligned with Venus'). The best way to increase the number of reports and their usefulness is to let your mod tell them the info it needs, as illustrated below.
Civ 5 Firetuner Download
The Lua introduction for confirmed developers describes a number of techniques you can use to achieve similar results. Here we present an implementation you can use to handle errors in the most dangerous parts of your code in order to present them to the user. The message will even include a full stack trace when available (you can provide your users a link to the #Configuration section and ask them to modify their config.ini).
The Civ5 Useful Programs page presents you a number of tools you can use to inspect or modify the game. This is especially useful if you want to quickly reproduce a bug or test something, or to understand what is happening.
- Let's say your mod adds a tech but you do not see in the techs panel. There is a FireTuner panel you can use to see a flat list of all the techs in-game.
- Let's say your mod adds a unit or a wonder, the IGE mod allows you to quickly create an unit or build that wonder (including the splash screen).
- Let's say your mod modifies the yields when the player acquire a specific tech. Once again IGE allows you to grant you that tech and see how the yields are modified.
Look for the following files under My Documents/My Games/Sid Meiers' Civilization V
and open them in a text editor like the notepad (not in a word processor).
- config.ini
- Set
EnableTuner
to 1. Civ5 will duplicate the Lua output to FireTuner this one is when present. - Set
LoggingEnabled
to 1. Civ5 will write log files under theLogs
folder. - Set
EnableLuaDebugLibrary
to 1. Civ5 will display stack traces on Lua errors and you will be able to use the debug object. - Set
DebugPanel
to 1. By pressing the ² key (may be ù or something else depending on your computer's language) during a game, Civ5 will display a debug panel.
- Set
- usersettings.ini
- Set
DebugMode
to 1. Needed to enable other features previously mentioned.
- Set