API Docs?

[Devcon]

Just starting out with modding civ and I was wondering if there was any API documentation anywhere other than the startup projects.

Is there no official doc references?
I have seen people piecemeal the modinfo schema but is that consolidated anywhere or is it only spread across the Modding Tutorials & Reference thread?

How am I suppose to know what xml tags exist and how to use them?

 

[Gleb Bazov]

GameEffects.xml catalogues the core, hardcoded items:

<Row Kind="KIND_COLLECTION"/>
<Row Kind="KIND_EFFECT"/>
<Row Kind="KIND_REQUIREMENT"/>
<Row Kind="KIND_REQUIREMENTSET"/>

From there, everything else that is creative is an application of these building blocks. Dynamic/Core Modifiers, also hardcoded, in essence, are described by the Core Effects and the Collections to which the latter apply. Requirements are used to circumscribe the application of the Modifiers and RequirementSets are the basis on which the Requirements equation is solved. Of course, there is also the myriad of Resources, Tags, Classes, and so forth, but most of these tables are modifiable even at the XML level, as far as I understand. All the tables comprising the current set of the particular game environment can be reviewed through the DebugGameplay cache. At the same time, there is a plethora of undocumented and obscure mechanics and relationships. UnitCommands are pretty much sealed from the XML approach, but you may be luckier through LUA. Things like planting forests and removing features/improvements appear to be integral hardcoded elements of the build charges mechanic, for example.

I don't know of any official API documentation, but the following tutorials are very good, though your level may well be too advanced to benefit from them. I don't know. Here are the links:

https://forums.civfanatics.com/threads/tutorial-modding-with-sqllite-studio-pc.608352/

https://forums.civfanatics.com/threads/civ6-modinfo-schema.606784/

Highly recommended: https://nycholusv.com/guides/using-modifiers/chapter-1/ & https://nycholusv.com/guides/using-modifiers/chapter-2/

(FOR LUA: https://forums.civfanatics.com/threads/lua-objects.601146/ & https://forums.civfanatics.com/threads/current-status-of-lua-modding.603706/)