Civilization Modding Wiki - User contributions [en]

Basic DLL tasks

2014-02-25T22:38:12Z

Ls612: minor fixes.

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you are knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavor to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.

'''CvGame:''' This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.

'''CvMap:''' This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.

'''CvPlot:''' This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.

'''CvPlayer:''' This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.

'''CvCity:''' This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.

'''CvUnit:''' This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with the data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Basic DLL tasks

2014-02-25T22:37:08Z

Ls612: /* Basic Civ 5 DLL Architecture */

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you are knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavour to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.

'''CvGame:''' This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.

'''CvMap:''' This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.

'''CvPlot:''' This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.

'''CvPlayer:''' This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.

'''CvCity:''' This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.

'''CvUnit:''' This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See
CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with teh data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Basic DLL tasks

2014-02-25T22:36:56Z

Ls612: /* Basic Civ 5 DLL Architecture */

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you are knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavour to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.
'''CvGame:''' This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.

'''CvMap:''' This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.

'''CvPlot:''' This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.

'''CvPlayer:''' This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.

'''CvCity:''' This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.

'''CvUnit:''' This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See
CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with teh data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Basic DLL tasks

2014-02-25T22:36:24Z

Ls612: fixed formatting

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you are knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavour to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.
'''CvGame:''' This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.

'''CvMap:''' This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.

'''CvPlot:''' This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.

'''CvPlayer:''' This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.

'''CvCity:''' This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.
'''
CvUnit:''' This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See
CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with teh data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Basic DLL tasks

2014-02-25T22:35:22Z

Ls612: Added info about Civ 5 DLL architecture

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you are knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavour to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.
CvGame: This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.
CvMap: This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.
CvPlot: This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.
CvPlayer: This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.
CvCity: This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.
CvUnit: This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with teh data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Basic DLL tasks

2014-02-21T00:09:48Z

Ls612: /* Compiling the DLL */

Civ5 DLL Reference

2014-02-20T21:37:30Z

Ls612:

= Tutorials =
* [http://forums.civfanatics.com/showthread.php?t=479374 Compiling the DLL]
* [[Basic DLL tasks]]

= Reference =
Under construction

Civ5 DLL Reference

2014-02-20T21:37:13Z

Ls612:

= Tutorials =
* [http://forums.civfanatics.com/showthread.php?t=479374 Compiling the DLL]
[[Basic DLL tasks]]

= Reference =
Under construction

Basic DLL tasks

2014-02-20T21:36:05Z

Ls612: Created page with "=Basic DLL Tasks= The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to ..."

User:Test2

2013-10-27T20:32:09Z

Ls612:

Please don't delete this account, I'm using it to test some stuff.

-ls612

What do you want to test? Btw, 4 times the ~ sets a time stamp with your name, that might be useful ;). [[User:The J|The J]] ([[User talk:The J|talk]]) 15:24, 27 October 2013 (UTC)

I was testing some things with external links, currently the functionality is still there, but I want to keep this test account around to test it after ainwood adds the restrictions. I'm pretty sure I can't properly test it with mine as it has elevated privleges. [[User:Ls612|Ls612]] ([[User talk:Ls612|talk]]) 20:32, 27 October 2013 (UTC)

User:Test2

2013-10-27T15:14:55Z

Ls612: Created page with "Please don't delete this account, I'm using it to test some stuff. -ls612"

Please don't delete this account, I'm using it to test some stuff.

-ls612

Main Page

2013-10-22T22:34:03Z

Ls612: Registration notice removed now that site is working properly

{| width="100%" style="background: transparent;"
|width="100%" valign="top" style="border: 1px solid #999999; padding: .5em 1em; margin: 1em; background-color: #E5EEFF;"|
<big>'''Welcome to Civilization Modding Wiki'''</big>

We are pleased to announce the creation of the Civilization modding wiki here on [http://www.civfanatics.com/ CivFanatics]. The goal of this wiki is to be a reliable and comprehensive reference for all things related to Civilization modding, such as tutorials and XML reference. If you'd like to contribute, feel free to [[Special:UserLogin|register]] and start writing.

== What can you do to help ==
* Help convert existing tutorials and guides from our tutorial forums
* Add new page(s) or edit existing page(s)
* Correct spelling and grammatical errors
* Post suggestions and ideas about the wiki in [http://forums.civfanatics.com/forumdisplay.php?f=19 Site Feedback] forum
|}

----

{| width="100%" style="background: transparent;"
|class="MainPageLeft" width="50%" rowspan="2" valign="top" style="border: 1px solid #FF8A8A; padding: .5em 1em; margin: 1em; background-color: #f0f0ff;"|

==''Civilization V''==
* [[Civ5 Modding Tutorials|Modding Tutorials]]
* [[Civ5 XML Reference|XML/SQL Reference]]
* [[Lua and UI Reference]]
* [[Civ5 DLL Reference|DLL Reference]]
* [[Civ5 Useful Programs|Useful Programs]]

|width="50%" valign="top" style="border: 1px solid #6BDB6B; padding: .5em 1em; margin: 1em; background-color: #f0fff0;"|

==''Civilization IV''==
* [[Civ4 Modding Tutorials|Modding Tutorials]]
* [[Civ4 XML Reference|XML Reference]]
* [[Civ4 SDK|SDK Guide]]
* [[Civ4 Python|Python Reference]]
* [[Civ4 World Builder|World Builder]]
* [[Civ4 Useful Programs|Useful Programs]]
|}

{| width="100%" style="background: transparent;"
|class="MainPageLeft" width="50%" rowspan="2" valign="top" style="border: 1px solid #FF8A8A; padding: .5em 1em; margin: 1em; background-color: #f0f0ff;"|

==''Civilization III''==
* [[Civ3 Modding Tutorials|Modding Tutorials]]
* [[Civ3 Modding Resources|Modding Resources]]
* [[Civ3 Modding Tools|Modding Tools]]
* [[Civ3 Editor Guide|Editor Guide]]
* [[Civ3 Expanded Editor Guide|Expanded Editor Guide]]
* [[Civ III Civilopedia Database|Civilopedia Database]]

|width="50%" valign="top" style="border: 1px solid #6BDB6B; padding: .5em 1em; margin: 1em; background-color: #f0fff0;"|

==''Civilization II''==
* Civilization II information can be found at the [http://sleague.civfanatics.com/index.php/Category:Tips Civilization II Scenario League].

|}

----

{| width="100%" style="background: transparent;"
|width="100%" valign="top" style="border: 1px solid #837e8c; padding: .5em 1em; margin: 1em; background-color: #efe5ff;"|

==''Quick Links''==
* [http://wiki.2kgames.com/civ5/index.php/Main_Page 2K Civ5 Wiki]
* [http://www.civfanatics.com/ CivFanatics]
* [http://forums.civfanatics.com/ CivFanatics Forums]
* [http://forums.civfanatics.com/downloads.php File Download Database]
* [http://forums.civfanatics.com/showthread.php?t=452157 File Host List]
* [http://meta.wikimedia.org/wiki/Help:Contents MediaWiki User Guide]
|}

__NOTOC__

Civ5 Useful Programs

2013-08-06T14:17:38Z

Ls612: Updated useful programs for 2013

This page includes information on the Civ5 Modding Tools as well as links to other useful programs.

= SDK =
'''World Builder'''
:The stand-alone world builder allows users to create and modify maps and scenarios for Civilization V.

'''Mod Buddy'''
:An editor (IDE) for the XML and Lua elements of the game and allows for the creation, packaging, and uploading of mods. To use it, you have to install the [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=DFBA7AC4-5366-456E-ABD6-0E3E6BA83B7C&displaylang=enMicrosoft Visual Studio 2010 Shell (Isolated) Redistributable Package]. ModBuddy will prompt you to install this if you don't have it already
:[http://forums.civfanatics.com/showthread.php?t=387554 Installing ModBuddy Extensions]

'''Nexus'''
:A collection of tools to to work with the art in Civilization V.
:[http://forums.civfanatics.com/showthread.php?t=386972 Initial Look at Nexus, 3D Unit Art, and Reskinning]
:Note that Photoshop templates for icons are also bundled in the SDK, under the ''Art'' folder (in ''Programs Files/Steam/...'').

'''FireTuner'''
:An advanced debugging terminal. It displays the lua output, provides an interactive console and can be simply extended with custom controls and tables.
:Do not forget to modify your *.ini files, see [[Debugging (Civ5)#Configuration|Debugging#Configuration]].
:[http://forums.civfanatics.com/showthread.php?t=399821 Simple Tuner Modifications]

= Digging the source code and the data tables =
Since the documentation is sparse, you need a tool to quickly inspect the civ5 source and data files and search in all of them at once. See also [http://forums.civfanatics.com/showthread.php?t=475076 this comparison of search tools].

'''Notepad++'''
:A great and renowned text editor with a "search in all files" feature (hit ctrl + shift + f). Used by many developers around the world. [http://sourceforge.net/projects/notepad-plus/ Download].

'''Visual C++ 2010 Express'''
:This is Microsoft's free C/C++ IDE, which is needed in order to compile the DLL. It includes code editing, autocompletion, compilation, and debugging and can be downloaded [https://www.microsoft.com/visualstudio/eng/downloads#d-2010-express here]. NOTE: any more modern version of Visual Studio should work so long as you have VC++ 2010 installed as well.

= Browsing the art assets =
'''Dragon unpacker'''
:Can extract the Firaxis packages (.fpk files). [http://sourceforge.net/projects/dragonunpacker/ Download].

'''DDS Unpacker'''
:Some DDS files have been compressed even further and look messed up if you open them in an image viewer. This tool rebuilds them. [http://forums.civfanatics.com/showthread.php?t=389316 Download].

'''XnView'''
:An images browser to get a quick look at all the DDS files to spot the one you're looking for. [http://www.xnview.com/en/download.html Download].

'''FireTuner: Textures Viewer'''
:A FireTuner panel to browse most of the game's textures. [http://forums.2kgames.com/showthread.php?118165-MOD-LiveTuner-Texture-Viewer Download].

'''FireTuner: Icons Viewer'''
:A FireTuner panel to browse the game's icons. [http://forums.2kgames.com/showthread.php?118055-MOD-LiveTuner-Icon-Viewer Download].

= Creating Art Assets =
'''NVidia Texture Tools for Photoshop'''
:A Photoshop plugin to save textures under the DDS format. [http://developer.nvidia.com/content/nvidia-texture-tools-adobe-photoshop Download]

'''Paint.net'''
:An easy-to-use and moderately powerful open-source image editor for Windows that natively supports the DDS format. [http://www.getpaint.net/ Download]

'''GIMP'''
:A free & open source image editing and manipulation tool. Very useful for creating 2d assets (icons). A windows installer version can be downloaded [http://www.gimp.org/downloads/ here].

'''Nexus Buddy 2'''
:Created by a member of the CFC community, this tool makes it much easier to work with 3d assets, especially for things other than units. You can download the latest version from the forums [http://forums.civfanatics.com/showthread.php?t=496855 here], and it is actively updated by its author.

= Testing and debugging =

=== SQLite tools ===
Anytime it starts a game, Civilization V saves a SQLite snapshot of the database, including the changes made by mods, under ''Civ5DebugDatabase.db''.

'''SQLite Manager'''
:NOTE: This is at the moment not compatible with the latest version of Firefox. The latest version it is compatible with is 19.0.
A Firefox plug-in, slightly more powerful than the previous tool. [https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager/ Download]

'''SQLiteSpy'''
:A Windows software to inspect the SQLite files. [http://www.yunqa.de/delphi/doku.php/products/sqlitespy/index Download]

'''SQLite Browser'''
:A Windows software to inspect the SQLite files. [http://sqlitebrowser.sourceforge.net/screenshots.html Download]

=== Cheating tools and game inspectors ===
'''In-game Editor (IGE)'''
:Add or remove units, cities, resources, change the terrain, trigger wars, etc. Convenient to quickly test your mod. [http://forums.civfanatics.com/showthread.php?t=436912 Download] (also on the Steam Workshop).

'''FireTuner: Techs and policies panel'''
:A FireTuner panel to list, grant and revoke techs and policies. [http://forums.2kgames.com/showthread.php?108533-MOD-LiveTuner-Tech-and-Policy-Panels Download].

[[Category:Civ5]]

Civ5 Useful Programs

2013-08-06T14:11:55Z

Ls612: Note about compatibility

This page includes information on the Civ5 Modding Tools as well as links to other useful programs.

= SDK =
'''World Builder'''
:The stand-alone world builder allows users to create and modify maps and scenarios for Civilization V.

'''Mod Buddy'''
:An editor (IDE) for the XML and Lua elements of the game and allows for the creation, packaging, and uploading of mods. To use it, you have to install the [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=DFBA7AC4-5366-456E-ABD6-0E3E6BA83B7C&displaylang=enMicrosoft Visual Studio 2010 Shell (Isolated) Redistributable Package].
:[http://forums.civfanatics.com/showthread.php?t=387554 Installing ModBuddy Extensions]

'''Nexus'''
:A collection of tools to to work with the art in Civilization V.
:[http://forums.civfanatics.com/showthread.php?t=386972 Initial Look at Nexus, 3D Unit Art, and Reskinning]
:Note that Photoshop templates for icons are also bundled in the SDK, under the ''Art'' folder (in ''Programs Files/Steam/...'').

'''FireTuner'''
:An advanced debugging terminal. It displays the lua output, provides an interactive console and can be simply extended with custom controls and tables.
:Do not forget to modify your *.ini files, see [[Debugging (Civ5)#Configuration|Debugging#Configuration]].
:[http://forums.civfanatics.com/showthread.php?t=399821 Simple Tuner Modifications]

= Digging the source code and the data tables =
Since the documentation is sparse, you need a tool to quickly inspect the civ5 source and data files and search in all of them at once. See also [http://forums.civfanatics.com/showthread.php?t=475076 this comparison of search tools].

'''Notepad++'''
:A great and renowned text editor with a "search in all files" feature (hit ctrl + shift + f). Used by many developers around the world. [http://sourceforge.net/projects/notepad-plus/ Download].

'''Visual C++ 2010 Express'''
:This is Microsoft's free C/C++ IDE, which is needed in order to compile the DLL. It includes code editing, autocompletion, compilation, and debugging and can be downloaded [https://www.microsoft.com/visualstudio/eng/downloads#d-2010-express here].

= Browsing the art assets =
'''Dragon unpacker'''
:Can extract the Firaxis packages (.fpk files). [http://sourceforge.net/projects/dragonunpacker/ Download].

'''DDS Unpacker'''
:Some DDS files have been compressed even further and look messed up if you open them in an image viewer. This tool rebuilds them. [http://forums.civfanatics.com/showthread.php?t=389316 Download].

'''XnView'''
:An images browser to get a quick look at all the DDS files to spot the one you're looking for. [http://www.xnview.com/en/download.html Download].

'''FireTuner: Textures Viewer'''
:A FireTuner panel to browse most of the game's textures. [http://forums.2kgames.com/showthread.php?118165-MOD-LiveTuner-Texture-Viewer Download].

'''FireTuner: Icons Viewer'''
:A FireTuner panel to browse the game's icons. [http://forums.2kgames.com/showthread.php?118055-MOD-LiveTuner-Icon-Viewer Download].

= Creating textures =
'''NVidia Texture Tools for Photoshop'''
:A Photoshop plugin to save textures under the DDS format. [http://developer.nvidia.com/content/nvidia-texture-tools-adobe-photoshop Download]

'''Paint.net'''
:An easy-to-use and moderately powerful open-source image editor for Windows that natively supports the DDS format. [http://www.getpaint.net/ Download]

= Testing and debugging =

=== SQLite tools ===
Anytime it starts a game, Civilization V saves a SQLite snapshot of the database, including the changes made by mods, under ''Civ5DebugDatabase.db''.

'''SQLite Manager'''
:NOTE: This is at the moment not compatible with the latest version of Firefox. The latest version it is compatible with is 19.0.
A Firefox plug-in, slightly more powerful than the previous tool. [https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager/ Download]

'''SQLiteSpy'''
:A Windows software to inspect the SQLite files. [http://www.yunqa.de/delphi/doku.php/products/sqlitespy/index Download]

'''SQLite Browser'''
:A Windows software to inspect the SQLite files. [http://sqlitebrowser.sourceforge.net/screenshots.html Download]

=== Cheating tools and game inspectors ===
'''In-game Editor (IGE)'''
:Add or remove units, cities, resources, change the terrain, trigger wars, etc. Convenient to quickly test your mod. [http://forums.civfanatics.com/showthread.php?t=436912 Download] (also on the Steam Workshop).

'''FireTuner: Techs and policies panel'''
:A FireTuner panel to list, grant and revoke techs and policies. [http://forums.2kgames.com/showthread.php?108533-MOD-LiveTuner-Tech-and-Policy-Panels Download].

[[Category:Civ5]]

Civ5 Useful Programs

2013-08-06T14:09:46Z

Ls612: Added VC2010 links

This page includes information on the Civ5 Modding Tools as well as links to other useful programs.

= SDK =
'''World Builder'''
:The stand-alone world builder allows users to create and modify maps and scenarios for Civilization V.

'''Mod Buddy'''
:An editor (IDE) for the XML and Lua elements of the game and allows for the creation, packaging, and uploading of mods. To use it, you have to install the [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=DFBA7AC4-5366-456E-ABD6-0E3E6BA83B7C&displaylang=enMicrosoft Visual Studio 2010 Shell (Isolated) Redistributable Package].
:[http://forums.civfanatics.com/showthread.php?t=387554 Installing ModBuddy Extensions]

'''Nexus'''
:A collection of tools to to work with the art in Civilization V.
:[http://forums.civfanatics.com/showthread.php?t=386972 Initial Look at Nexus, 3D Unit Art, and Reskinning]
:Note that Photoshop templates for icons are also bundled in the SDK, under the ''Art'' folder (in ''Programs Files/Steam/...'').

'''FireTuner'''
:An advanced debugging terminal. It displays the lua output, provides an interactive console and can be simply extended with custom controls and tables.
:Do not forget to modify your *.ini files, see [[Debugging (Civ5)#Configuration|Debugging#Configuration]].
:[http://forums.civfanatics.com/showthread.php?t=399821 Simple Tuner Modifications]

= Digging the source code and the data tables =
Since the documentation is sparse, you need a tool to quickly inspect the civ5 source and data files and search in all of them at once. See also [http://forums.civfanatics.com/showthread.php?t=475076 this comparison of search tools].

'''Notepad++'''
:A great and renowned text editor with a "search in all files" feature (hit ctrl + shift + f). Used by many developers around the world. [http://sourceforge.net/projects/notepad-plus/ Download].

'''Visual C++ 2010 Express'''
:This is Microsoft's free C/C++ IDE, which is needed in order to compile the DLL. It includes code editing, autocompletion, compilation, and debugging and can be downloaded [https://www.microsoft.com/visualstudio/eng/downloads#d-2010-express here].

= Browsing the art assets =
'''Dragon unpacker'''
:Can extract the Firaxis packages (.fpk files). [http://sourceforge.net/projects/dragonunpacker/ Download].

'''DDS Unpacker'''
:Some DDS files have been compressed even further and look messed up if you open them in an image viewer. This tool rebuilds them. [http://forums.civfanatics.com/showthread.php?t=389316 Download].

'''XnView'''
:An images browser to get a quick look at all the DDS files to spot the one you're looking for. [http://www.xnview.com/en/download.html Download].

'''FireTuner: Textures Viewer'''
:A FireTuner panel to browse most of the game's textures. [http://forums.2kgames.com/showthread.php?118165-MOD-LiveTuner-Texture-Viewer Download].

'''FireTuner: Icons Viewer'''
:A FireTuner panel to browse the game's icons. [http://forums.2kgames.com/showthread.php?118055-MOD-LiveTuner-Icon-Viewer Download].

= Creating textures =
'''NVidia Texture Tools for Photoshop'''
:A Photoshop plugin to save textures under the DDS format. [http://developer.nvidia.com/content/nvidia-texture-tools-adobe-photoshop Download]

'''Paint.net'''
:An easy-to-use and moderately powerful open-source image editor for Windows that natively supports the DDS format. [http://www.getpaint.net/ Download]

= Testing and debugging =

=== SQLite tools ===
Anytime it starts a game, Civilization V saves a SQLite snapshot of the database, including the changes made by mods, under ''Civ5DebugDatabase.db''.

'''SQLite Manager'''
:A Firefox plug-in, slightly more powerful than the previous tool. [https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager/ Download]

'''SQLiteSpy'''
:A Windows software to inspect the SQLite files. [http://www.yunqa.de/delphi/doku.php/products/sqlitespy/index Download]

'''SQLite Browser'''
:A Windows software to inspect the SQLite files. [http://sqlitebrowser.sourceforge.net/screenshots.html Download]

=== Cheating tools and game inspectors ===
'''In-game Editor (IGE)'''
:Add or remove units, cities, resources, change the terrain, trigger wars, etc. Convenient to quickly test your mod. [http://forums.civfanatics.com/showthread.php?t=436912 Download] (also on the Steam Workshop).

'''FireTuner: Techs and policies panel'''
:A FireTuner panel to list, grant and revoke techs and policies. [http://forums.2kgames.com/showthread.php?108533-MOD-LiveTuner-Tech-and-Policy-Panels Download].

[[Category:Civ5]]

Main Page

2013-07-27T15:55:11Z

Ls612: We can get new users again!

{| width="100%" style="background: transparent;"
|width="100%" valign="top" style="border: 1px solid #999999; padding: .5em 1em; margin: 1em; background-color: #E5EEFF;"|
<big>'''Welcome to Civilization Modding Wiki'''</big>

We are pleased to announce the creation of the Civilization modding wiki here on [http://www.civfanatics.com/ CivFanatics]. The goal of this wiki is to be a reliable and comprehensive reference for all things related to Civilization modding, such as tutorials and XML reference. If you'd like to contribute, feel free to [[Special:UserLogin|register]] and start writing. ATTENTION: Registration of new users is now re-enabled.

== What can you do to help ==
* Help convert existing tutorials and guides from our tutorial forums
* Add new page(s) or edit existing page(s)
* Correct spelling and grammatical errors
* Post suggestions and ideas about the wiki in [http://forums.civfanatics.com/forumdisplay.php?f=19 Site Feedback] forum
|}

----

{| width="100%" style="background: transparent;"
|class="MainPageLeft" width="50%" rowspan="2" valign="top" style="border: 1px solid #FF8A8A; padding: .5em 1em; margin: 1em; background-color: #f0f0ff;"|

==''Civilization V''==
* [[Civ5 Modding Tutorials|Modding Tutorials]]
* [[Civ5 XML Reference|XML/SQL Reference]]
* [[Lua and UI Reference]]
* [[Civ5 DLL Reference|DLL Reference]]
* [[Civ5 Useful Programs|Useful Programs]]

|width="50%" valign="top" style="border: 1px solid #6BDB6B; padding: .5em 1em; margin: 1em; background-color: #f0fff0;"|

==''Civilization IV''==
* [[Civ4 Modding Tutorials|Modding Tutorials]]
* [[Civ4 XML Reference|XML Reference]]
* [[Civ4 SDK|SDK Guide]]
* [[Civ4 Python|Python Reference]]
* [[Civ4 World Builder|World Builder]]
* [[Civ4 Useful Programs|Useful Programs]]
|}

{| width="100%" style="background: transparent;"
|class="MainPageLeft" width="50%" rowspan="2" valign="top" style="border: 1px solid #FF8A8A; padding: .5em 1em; margin: 1em; background-color: #f0f0ff;"|

==''Civilization III''==
* [[Civ3 Modding Tutorials|Modding Tutorials]]
* [[Civ3 Modding Resources|Modding Resources]]
* [[Civ3 Modding Tools|Modding Tools]]
* [[Civ3 Editor Guide|Editor Guide]]
* [[Civ3 Expanded Editor Guide|Expanded Editor Guide]]
* [[Civ III Civilopedia Database|Civilopedia Database]]

|width="50%" valign="top" style="border: 1px solid #6BDB6B; padding: .5em 1em; margin: 1em; background-color: #f0fff0;"|

==''Civilization II''==
* Civilization II information can be found at the [http://sleague.civfanatics.com/index.php/Category:Tips Civilization II Scenario League].

|}

----

{| width="100%" style="background: transparent;"
|width="100%" valign="top" style="border: 1px solid #837e8c; padding: .5em 1em; margin: 1em; background-color: #efe5ff;"|

==''Quick Links''==
* [http://wiki.2kgames.com/civ5/index.php/Main_Page 2K Civ5 Wiki]
* [http://www.civfanatics.com/ CivFanatics]
* [http://forums.civfanatics.com/ CivFanatics Forums]
* [http://forums.civfanatics.com/downloads.php File Download Database]
* [http://forums.civfanatics.com/showthread.php?t=452157 File Host List]
* [http://meta.wikimedia.org/wiki/Help:Contents MediaWiki User Guide]
|}

__NOTOC__

Civ4 Useful Programs

2013-05-28T21:47:49Z

Ls612: Added a link to the Gamefont Editor utility by Asaf

This page provides links to programs that are useful and help with modding Civilization IV.

== Essential Programs for nearly all aspects of Modding==
* A text editor, such as [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++], [http://www.gnu.org/software/emacs/ emacs], [http://www.vim.org/ vim], or even WordPad and Notpad (which come with Windows)
** Vim and Emacs are good for hardcore programming - Notepad++ is good for just about anything.
* A diff/merge tool, such as [http://winmerge.org/downloads/ WinMerge] or [http://www.scootersoftware.com/ Beyond Compare]
** Vim, Emacs, and some other text editors contain merge/diff tools in themselves.

== Map/Scenario (WorldBuilder-like) Programs ==
* [[MapView | MapView 2.0]] or [http://forums.civfanatics.com/showthread.php?t=305168 official thread]
* [http://forums.civfanatics.com/showthread.php?t=271351 Civ4 Map Maker]
* [http://forums.civfanatics.com/showthread.php?t=300571 Civ 4 Map Editor]
* [http://forums.civfanatics.com/showthread.php?t=144414 Civ4 Save/Scenario/Map Editor]

== XML Programs ==
While there are some XML editing tools for civ4, none are necessary. In fact, most experienced modders prefer the directness of a text editor like [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++]; however if you are having difficulty understanding and editing the XML you should consider using the user created tools below.
* [http://forums.civfanatics.com/showthread.php?t=270586 Civ4 XML Editor]
* [http://forums.civfanatics.com/showthread.php?t=276286 Civ4 File Checker] (checks your XML for errors; recommended for everyone)
* [http://www.symbolclick.com/ XML Marker]

== Python Programs ==
You will need a text editor like [http://notepad-plus.sourceforge.net/uk/site.htm Notepad++] to modify python.
* [http://civ4bug.sourceforge.net/PythonAPI/index.html Civilization4 Python API Reference Guide]: is an invaluable reference guide listing the various calls and functions available to the modder in python.
* [http://www.python.org/ Python IDLE]: is an advanced python tool designed for python programming in general; it's usefulness as a tool to utilize for scripting in Civ4 is questionable; in fact if you need to use IDLE to implement and test your civ4 python code, the functionality of your code would probably be better served in the SDK; as Civ4's implementation of python can be very slow and should be limited to simple scripting and interface functions.

== Graphics Programs ==
* [http://www.blender.org/ Blender]
* [http://forums.civfanatics.com/showthread.php?t=135740 BMP To WorldBuilderSave Converter]
* [http://www.softpedia.com/get/Multimedia/Graphic/Graphic-Editors/DXTBmp.shtml DXTBmp]
* [http://www.gimp.org/ GIMP]
* [http://nifelheim.dyndns.org/~cocidius/dds/ GIMP DDS Plugin]
* [http://www.turbosquid.com/gmax Gmax]
* [http://niftools.sourceforge.net/wiki/NifTools NifTools]
* [http://forums.civfanatics.com/showthread.php?t=429541 GameFont.tga Editor Utility]

== SDK Programs ==
* [[How_to_Install_the_SDK|Guide to installing the SDK]] (It is highly recommended you read this before starting SDK work on Civ4)
* Compilers:
** [http://www.microsoft.com/express/download/link Visual Studio 2008 Express] (recommended method)
** [http://www.codeblocks.org/ CodeBlocks] (obsolete in many ways; cannot create a debug dll)
*Libraries:
** [http://kael.civfanatics.net/files/PSDK-x86.exe Microsoft Platform SDK]
** [http://kael.civfanatics.net/files/msvcrt.lib msvcrt.lib]
** [http://kael.civfanatics.net/files/msvcrtd.lib msvcrtd.lib]
** [http://kael.civfanatics.net/files/msvcprt.lib msvcprt.lib]
** [http://kael.civfanatics.net/files/VCToolkitSetup.exe VC++ Toolkit 2003]

== Misc Programs ==
* [http://forums.civfanatics.com/showpost.php?p=3247291&postcount=1 PakBuild]
* [http://forums.civfanatics.com/showthread.php?t=276286 Civchecker]
* [http://www.sadmansoftware.com/search/index.html SadMan Search]
* [http://forums.civfanatics.com/showpost.php?p=7280262&postcount=1 NSIS Installer Program]
* [http://www.7-zip.org 7-zip]

[[Category:Civilization 4]]

User:Ls612

2013-05-12T16:03:25Z

Ls612: Protected "User:Ls612": Don't want people defacing an admin user page ([edit=sysop] (indefinite) [move=sysop] (indefinite))

I help keep this place spam-free and orderly.

If you are seeing this page the server is working, yay.

User:Ls612

2013-05-12T16:02:48Z

Ls612: Created page with "I help keep this place spam-free and orderly. If you are seeing this page the server is working, yay."

I help keep this place spam-free and orderly.

If you are seeing this page the server is working, yay.

Civ4 World Builder

2013-04-22T21:47:29Z

Ls612: Added new Worldbuilder modcomp

== Tutorials and Reference ==
* [http://forums.civfanatics.com/showthread.php?t=135669 In-Depth Look at the .WorldBuilderSave File]
* [http://forums.civfanatics.com/showthread.php?t=176397 Map Making for Mods]
* [http://forums.civfanatics.com/showthread.php?t=314321 How to Add Rivers]
* [http://forums.civfanatics.com/showthread.php?t=132800 Civ 4 World Builder Manual]
* [http://forums.civfanatics.com/showthread.php?t=374496 Modding maps with a Text Editor]

== The WBS File ==

The parts of the .WorldBuilderSave (WBS) files.

=== BeginGame ===
This section describes to the Civ4 engine the game setup parameters. Specifically they refer to the options you choose when starting a new game from the menu. Below is a list of ALL possible variables. The values they can have are listed on their individual pages.

* [[Tutorial]]
* [[Era]]
* [[Speed]]
* [[Calendar]]
* [[Option]]
* [[MPOption]]
* [[ForceControl]]
* [[Victory]]
* [[GameTurn]]
* [[MaxTurns]]
* [[MaxCityElimination]]
* [[TargetScore]]
* [[StartYear]]
* [[Description]]
* [[ModPath]]

=== BeginTeam ===
This section of the WBS file describes each ''team'' (not just the player) in the scenario. In Single Player games you can even create teams. Please note: every player ''MUST'' be part of a team, even if there is only one player in the team.

* [[Tech]]
* [[ContactWithTeam]]
* [[AtWar]]
* [[PermanentWarPeace]]
* [[OpenBordersWithTeam]]
* [[DefensivePactWithTeam]]
* [[ProjectType]]
* [[RevealMap]]

=== BeginPlayer ===
This section defines all the player settings for the game. These settings will allow you to change all behavior for the players. Note that you must have a BeginPlayer section for every player in the game/scenario.

* [[CivDesc]]
* [[CivShortDesc]]
* [[LeaderName]]
* [[CivAdjective]]
* [[FlagDecal]]
* [[WhiteFlag]]
* [[LeaderType]]
* [[CivType]]
* [[Team]]
* [[Handicap]]
* [[Color]]
* [[ArtStyle]]
* [[PlayableCiv]]
* [[MinorNationStatus]]
* [[StartingGold]]
* [[StartingX]]
* [[StartingY]]
* [[StateReligion]]
* [[StartingEra]]
* [[CivicOption, Civic]]
* [[AttitudePlayer, AttitudeExtra]]
* [[CityList]]

=== BeginMap ===
This section describes the map settings to the Civilization IV engine. Here you can define several different things about the map and how it plays.

* [[grid width]]
* [[grid height]]
* [[top latitude]]
* [[bottom latitude]]
* [[wrap X]]
* [[wrap Y]]
* [[world size]]
* [[climate]]
* [[sealevel]]
* [[num plots written]]

=== BeginPlot ===
This section will fill in the last section of the WorldBuilderSsave file: the Plots section. Each plot on the map will have its own BeginPlot/EndPlot section. This is the largest section of the WorldBuilderSave file, for there is a BeginPlot/EndPlot section for every tile on the map.

* [[x, y]]
* [[Landmark]]
* [[ScriptData]]
* [[isNOfRiver, isWOfRiver]]
* [[RiverNSDirection, RiverWEDirection]]
* [[StartingPlot]]
* [[BonusType]]
* [[ImprovementType]]
* [[FeatureType, FeatureVariety]]
* [[RouteType]]
* [[TerrainType]]
* [[PlotType]]
* [[BeginUnit]]
* [[BeginCity]]
* [[TeamReveal]]

----
Original descriptions of BeginGame, BeginTeam, BeginPlayer, BeginMap, and BeginPlot sections, along with descriptions on all pages linked to from here by Dale on [http://apolyton.net/forums/showthread.php?t=141567 Apolyton Civilization Site] and [http://forums.civfanatics.com/showthread.php?t=135669 Civilization Fanatics Center] from his "In depth look at the WBS file" thread.

= Alternatives =
There're some applications on the market that try to replicate the functionality of the World Builder. Some applications will automatically generate scenarios or will allow you to edit or create existing ones.
You can find a list of those tools in the Map/Scenario (WorldBuilder-like) Programs section on the Wiki page about [[Civ4_Useful_Programs|Useful Civ4 Programs]]. It's also an good idea to have a look at the [http://forums.civfanatics.com/forumdisplay.php?f=176 Civ4 - Utility Programs] subforum at Civfanatics.com.

As of April of 2013, there is also a mod component called [http://forums.civfanatics.com/showthread.php?t=491837 Platy World Builder] which greatly expands the functionality of the ingame Worldbuilder
{{Civ4_World_Builder}}
[[Category:Civilization 4]]

Civ4GameSpeedInfo

2013-04-22T21:33:48Z

Ls612: Filling out tags that have "unknown" for description

The '''Civ4GameSpeedInfo''' file defines the games speeds available in the game.

All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values.

<font color=red>This page is missing information.
Do not remove this notice until it is complete.</font>

==Tags==
===Headers===

These tags typically bracket other tags, sometimes the entire file, and are generally used to specify more than one piece of data.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!GameSpeedInfo
|Main bracket for each entry
|-
!Type
|Name used in other files
|}

===Text===

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!Description
|Name displayed in game
|-
!Help
|Hover text when selected in game
|}

===Integers===

All of these tags have a numerical value. Though it sometimes can be negative, it usually is not.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!iGrowthPercent
|Percent of growth threshold needed
|-
!iTrainPercent
|Percent of unit cost needed
|-
!iConstructPercent
|Percent of building cost needed
|-
!iCreatePercent
|Percent of project cost needed
|-
!iResearchPercent
|Percent of research cost needed
|-
!iBuildPercent
|Percent of cost to complete worker action needed
|-
!iImprovementPercent
|Percent of improvement cost needed
|-
!iGreatPeoplePercent
|Great people threshold percent
|-
!iCulturePercent
|Culture threshold percent
|-
!iAnarchyPercent
|Anarchy length percent
|-
!iBarbPercent
|Percentage rate of barbarian spawning
|-
!iFeatureProductionPercent
|Percent of time it takes for forests and jungles to grow
|-
!iUnitDiscoverPercent
|Percent of research from great person
|-
!iUnitHurryPercent
|Percent of production from great engineer
|-
!iUnitTradePercent
|Percent of gold from great merchant
|-
!iUnitGreatWorkPercent
|Percent of culture from great artist
|-
!iGoldenAgePercent
|Percent of length for golden age
|-
!iHurryPercent
|Amount of production from hurrying a building/unit
|-
!iHurryConscriptAngerPercent
|Percent of time it takes for slavery anger to go away
|-
!iInflationPercent
|Percent of inflation rate
|-
!iInflationOffset
|Number of turns that pass before Inflation begins
|-
!iVictoryDelayPercent
|Percent of space ship travel time
|}

===Lists (Multi-line)===

All List tags consist of an opening/closing tag, which is shown here, and then each entry within it is another tag with the same name as the parent tag, minus the "s" (i.e. singular, rather than plural).

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!GameTurnInfos
|Paired lists that set how the game turns progress with respect to the default calendar. iMonthIncrement sets how many months each turn lasts. iTurnsPerIncrement sets how many turns exist for a given month increment.
<GameTurnInfo>
<iMonthIncrement>180</iMonthIncrement>
<iTurnsPerIncrement>100</iTurnsPerIncrement>
</GameTurnInfo>
|}

==Example==

In the following example of code, please note that there is a specific order of all of the tags. You ''must'' list the tags in this order for the game to properly interpret your file.

<GameSpeedInfo>
<Type>GAMESPEED_MARATHON</Type>
<Description>TXT_KEY_GAMESPEED_MARATHON</Description>
<Help>TXT_KEY_GAMESPEED_MARATHON_HELP</Help>
<iGrowthPercent>300</iGrowthPercent>
<iTrainPercent>200</iTrainPercent>
<iConstructPercent>300</iConstructPercent>
<iCreatePercent>300</iCreatePercent>
<iResearchPercent>300</iResearchPercent>
<iBuildPercent>300</iBuildPercent>
<iImprovementPercent>300</iImprovementPercent>
<iGreatPeoplePercent>300</iGreatPeoplePercent>
<iCulturePercent>300</iCulturePercent>
<iAnarchyPercent>200</iAnarchyPercent>
<iBarbPercent>400</iBarbPercent>
<iFeatureProductionPercent>300</iFeatureProductionPercent>
<iUnitDiscoverPercent>300</iUnitDiscoverPercent>
<iUnitHurryPercent>300</iUnitHurryPercent>
<iUnitTradePercent>300</iUnitTradePercent>
<iUnitGreatWorkPercent>300</iUnitGreatWorkPercent>
<iGoldenAgePercent>200</iGoldenAgePercent>
<iHurryPercent>33</iHurryPercent>
<iHurryConscriptAngerPercent>300</iHurryConscriptAngerPercent>
<iInflationPercent>10</iInflationPercent>
<iInflationOffset>-270</iInflationOffset>
<iVictoryDelayPercent>300</iVictoryDelayPercent>
<GameTurnInfos>
<GameTurnInfo>
<iMonthIncrement>180</iMonthIncrement>
<iTurnsPerIncrement>100</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>120</iMonthIncrement>
<iTurnsPerIncrement>300</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>60</iMonthIncrement>
<iTurnsPerIncrement>170</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>24</iMonthIncrement>
<iTurnsPerIncrement>201</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>12</iMonthIncrement>
<iTurnsPerIncrement>129</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>6</iMonthIncrement>
<iTurnsPerIncrement>180</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>3</iMonthIncrement>
<iTurnsPerIncrement>264</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>1</iMonthIncrement>
<iTurnsPerIncrement>156</iTurnsPerIncrement>
</GameTurnInfo>
</GameTurnInfos>
</GameSpeedInfo>

{{Civ4_XML_Files}}

Civ4GameSpeedInfo

2013-04-22T21:33:02Z

Ls612: /* Text */

The '''Civ4GameSpeedInfo''' file defines the games speeds available in the game.

All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values.

<font color=red>This page is missing information.
Do not remove this notice until it is complete.</font>

==Tags==
===Headers===

These tags typically bracket other tags, sometimes the entire file, and are generally used to specify more than one piece of data.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!GameSpeedInfo
|Main bracket for each entry
|-
!Type
|Name used in other files
|}

===Text===

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!Description
|Name displayed in game
|-
!Help
|Hover text when selected in game
|}

===Integers===

All of these tags have a numerical value. Though it sometimes can be negative, it usually is not.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!iGrowthPercent
|Percent of growth threshold needed
|-
!iTrainPercent
|Percent of unit cost needed
|-
!iConstructPercent
|Percent of building cost needed
|-
!iCreatePercent
|Percent of project cost needed
|-
!iResearchPercent
|Percent of research cost needed
|-
!iBuildPercent
|Percent of cost to complete worker action needed
|-
!iImprovementPercent
|Percent of improvement cost needed
|-
!iGreatPeoplePercent
|Great people threshold percent
|-
!iCulturePercent
|Culture threshold percent
|-
!iAnarchyPercent
|Anarchy length percent
|-
!iBarbPercent
|Percentage rate of barbarian spawning
|-
!iFeatureProductionPercent
|Percent of time it takes for forests and jungles to grow
|-
!iUnitDiscoverPercent
|Percent of research from great person
|-
!iUnitHurryPercent
|Percent of production from great engineer
|-
!iUnitTradePercent
|Percent of gold from great merchant
|-
!iUnitGreatWorkPercent
|Percent of culture from great artist
|-
!iGoldenAgePercent
|Percent of length for golden age
|-
!iHurryPercent
|Amount of production from hurrying a building/unit
|-
!iHurryConscriptAngerPercent
|Percent of time it takes for slavery anger to go away
|-
!iInflationPercent
|Percent of inflation rate
|-
!iInflationOffset
|Unknown
|-
!iVictoryDelayPercent
|Percent of space ship travel time
|}

===Lists (Multi-line)===

All List tags consist of an opening/closing tag, which is shown here, and then each entry within it is another tag with the same name as the parent tag, minus the "s" (i.e. singular, rather than plural).

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!GameTurnInfos
|Paired lists that set how the game turns progress with respect to the default calendar. iMonthIncrement sets how many months each turn lasts. iTurnsPerIncrement sets how many turns exist for a given month increment.
<GameTurnInfo>
<iMonthIncrement>180</iMonthIncrement>
<iTurnsPerIncrement>100</iTurnsPerIncrement>
</GameTurnInfo>
|}

==Example==

In the following example of code, please note that there is a specific order of all of the tags. You ''must'' list the tags in this order for the game to properly interpret your file.

<GameSpeedInfo>
<Type>GAMESPEED_MARATHON</Type>
<Description>TXT_KEY_GAMESPEED_MARATHON</Description>
<Help>TXT_KEY_GAMESPEED_MARATHON_HELP</Help>
<iGrowthPercent>300</iGrowthPercent>
<iTrainPercent>200</iTrainPercent>
<iConstructPercent>300</iConstructPercent>
<iCreatePercent>300</iCreatePercent>
<iResearchPercent>300</iResearchPercent>
<iBuildPercent>300</iBuildPercent>
<iImprovementPercent>300</iImprovementPercent>
<iGreatPeoplePercent>300</iGreatPeoplePercent>
<iCulturePercent>300</iCulturePercent>
<iAnarchyPercent>200</iAnarchyPercent>
<iBarbPercent>400</iBarbPercent>
<iFeatureProductionPercent>300</iFeatureProductionPercent>
<iUnitDiscoverPercent>300</iUnitDiscoverPercent>
<iUnitHurryPercent>300</iUnitHurryPercent>
<iUnitTradePercent>300</iUnitTradePercent>
<iUnitGreatWorkPercent>300</iUnitGreatWorkPercent>
<iGoldenAgePercent>200</iGoldenAgePercent>
<iHurryPercent>33</iHurryPercent>
<iHurryConscriptAngerPercent>300</iHurryConscriptAngerPercent>
<iInflationPercent>10</iInflationPercent>
<iInflationOffset>-270</iInflationOffset>
<iVictoryDelayPercent>300</iVictoryDelayPercent>
<GameTurnInfos>
<GameTurnInfo>
<iMonthIncrement>180</iMonthIncrement>
<iTurnsPerIncrement>100</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>120</iMonthIncrement>
<iTurnsPerIncrement>300</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>60</iMonthIncrement>
<iTurnsPerIncrement>170</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>24</iMonthIncrement>
<iTurnsPerIncrement>201</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>12</iMonthIncrement>
<iTurnsPerIncrement>129</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>6</iMonthIncrement>
<iTurnsPerIncrement>180</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>3</iMonthIncrement>
<iTurnsPerIncrement>264</iTurnsPerIncrement>
</GameTurnInfo>
<GameTurnInfo>
<iMonthIncrement>1</iMonthIncrement>
<iTurnsPerIncrement>156</iTurnsPerIncrement>
</GameTurnInfo>
</GameTurnInfos>
</GameSpeedInfo>

{{Civ4_XML_Files}}