Civ5 Modding Tutorials: Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
No edit summary
m (Grammar)
 
(25 intermediate revisions by 2 users not shown)
Line 3: Line 3:
:If you have no idea about modding and what are Lua and Xml, you should give a look at [http://www.weplayciv.com/forums/entry.php?15-Dale-s-Mod-Blog-Civ5-Modding-Explained Civ5 Modding Explained].
:If you have no idea about modding and what are Lua and Xml, you should give a look at [http://www.weplayciv.com/forums/entry.php?15-Dale-s-Mod-Blog-Civ5-Modding-Explained Civ5 Modding Explained].
'''Read the guide.'''  
'''Read the guide.'''  
:The best introduction to civ5 modding is still the '''[http://forums.civfanatics.com/showthread.php?t=385009 Kael's Guide]'''. However it was written a long time ago and some informations are obsolete or missing.  
:The best introduction to civ5 modding is still the '''[http://forums.civfanatics.com/showthread.php?t=385009 Kael's Guide]'''. However it was written a long time ago and some information is obsolete or missing.  
'''Import your files into VFS.'''  
'''Import your files into VFS.'''  
:The main change is about the [[VFS (Civ5)|VFS]] (Virtual File System). Basically you should include your textures, UI and lua files into the VFS. In ModBuddy, select those files, hit F4 to open the properties window, check "import into VFS". Forgetting this is a common cause of troubles for beginners.
:The main change since Kael wrote his guide is about the [[VFS (Civ5)|VFS]] (Virtual File System). Forgetting to import files into the VFS is the common source of problems for beginners.  
'''Get the right tools for the job!'''  
'''Get the right tools for the job.'''  
:See [[Civ5 Useful Programs]]. You should have installed the SDK of course, but it is also strongly recommended that you get a tool to search in all civ5 files at once, to compensate for the lack of documentation. You may also need additional softwares to extract and read the textures and such.
:See [[Civ5 Useful Programs]]. You should have installed the SDK of course, but it is also strongly recommended that you get a tool to search in all civ5 files at once, to compensate for the lack of documentation. You may also need additional softwares to extract and read the textures, test and debug your mod, etc.
'''Modify your ini files'''
'''Modify your ini files.'''
:In config.ini, set ''LoggingEnabled'', ''EnableLuaDebugLibrary'' and ''DebugPanel'' to 1. In usersettings.ini, set ''DebugMode'' to 1.
:See [[Debugging (Civ5)#Configuration|Debugging#Configuration]].




= Tutorials =
= Tutorials =
See also the [http://forums.civfanatics.com/forumdisplay.php?f=394&order=desc&page=2 Modding tutorials section] on the forums.
See also the [http://forums.civfanatics.com/forumdisplay.php?f=394&order=desc&page=2 Modding tutorials section] on the forums.<br/>
Also note that the [[Civ5 XML Reference|XML]] and [[Lua and UI Reference|Lua]] sections each contain specific tutorials, articles and extensive documentation.


== Common tasks ==
 
=== General ===
* [[Modding Limits and Issues (Civ5)|Modding Limits and Issues]]
* [http://forums.civfanatics.com/showthread.php?t=459392 Create and use DDS textures]
* [http://forums.civfanatics.com/showthread.php?t=449431 Adding custom data and using them in Lua]
* [http://wiki.2kgames.com/civ5/index.php/Mods:LocalizationSyntax Localization Syntax]
* [[Localization Tutorial (Civ5)|Localization Tutorial]]
* [[Debugging (Civ5)|Debugging]]
 
=== Common tasks ===
* [http://forums.civfanatics.com/showthread.php?t=391823 New Leaders (2D images)]
* [http://forums.civfanatics.com/showthread.php?t=391823 New Leaders (2D images)]
* [http://forums.civfanatics.com/showthread.php?t=389782 New Resources]
* [http://forums.civfanatics.com/showthread.php?t=389782 New Resources]
* [http://forums.civfanatics.com/showthread.php?t=474309 New Resources (with 3D textures)]
* [http://forums.civfanatics.com/showthread.php?t=470290 New Buildings]
* [http://forums.civfanatics.com/showthread.php?t=470290 New Buildings]
* [http://forums.civfanatics.com/showthread.php?t=406877 New Specialists]
* [http://forums.civfanatics.com/showthread.php?t=406877 New Specialists]
Line 23: Line 34:




== Background ==
=== Specific topics ===
* [http://forums.civfanatics.com/showthread.php?t=461552 UI Tutorial]
* [http://forums.civfanatics.com/showthread.php?t=394056 Converting civ4 units for civ5: 1. importing the mesh and creating the unit]
* [http://forums.civfanatics.com/showthread.php?t=463429 Deleting data rows]
* [http://forums.civfanatics.com/showthread.php?t=396911 Converting civ4 units for civ5: 2. using civ5 animations]
* [http://forums.civfanatics.com/showthread.php?t=449431 Adding data rows to use in Lua]
* [http://forums.civfanatics.com/showthread.php?t=444883 Importing civ5 units into Blender]
* [http://forums.civfanatics.com/showthread.php?t=459392 Create and use DDS textures]
* [http://forums.civfanatics.com/showthread.php?t=405148 Civilization-specific techs]
 
 
== Specific topics ==
* [http://forums.civfanatics.com/showthread.php?t=468374 Culture buildings - vanilla and G&K cross compatibility]
* [http://forums.civfanatics.com/showthread.php?t=468374 Culture buildings - vanilla and G&K cross compatibility]
* [http://forums.civfanatics.com/showthread.php?t=394056 Import civ4 units into civ5]
* [http://forums.civfanatics.com/showthread.php?t=479294 Adding a City State]
* [http://forums.civfanatics.com/showthread.php?t=405148 Locking techs on a civilization basis]
* [[Text icons and markups (Civ5)|Text icons and markups]]
* [http://forums.civfanatics.com/showthread.php?p=11575962 Register a mod in the diplo corner menu]
* [[VFS (Civ5)|VFS]]




== Lua-specific resources ==
[[Category:Civ5 Tutorials]]
* [http://www.lua.org/pil/index.html Lua manual]
* [http://www.lua.org/manual/5.1/ Lua reference]

Latest revision as of 18:42, 2 August 2013

Getting started

Get a tour.

If you have no idea about modding and what are Lua and Xml, you should give a look at Civ5 Modding Explained.

Read the guide.

The best introduction to civ5 modding is still the Kael's Guide. However it was written a long time ago and some information is obsolete or missing.

Import your files into VFS.

The main change since Kael wrote his guide is about the VFS (Virtual File System). Forgetting to import files into the VFS is the common source of problems for beginners.

Get the right tools for the job.

See Civ5 Useful Programs. You should have installed the SDK of course, but it is also strongly recommended that you get a tool to search in all civ5 files at once, to compensate for the lack of documentation. You may also need additional softwares to extract and read the textures, test and debug your mod, etc.

Modify your ini files.

See Debugging#Configuration.


Tutorials

See also the Modding tutorials section on the forums.
Also note that the XML and Lua sections each contain specific tutorials, articles and extensive documentation.


General

Common tasks


Specific topics