Modder Resource - Modular Building Quests

[lilgamefreek]

What is this Resource?

This mod is intended as a resource and guide for other content creators seeking to add Building Choice Quests to their own mods. Mods that seek to do so independently will encounter strong compatibility errors with other mods such that only one of the mod's quests will successfully be added and played with in-game. This system makes adding Building Choice Quests incredibly simple and in a way that ensures compatibility with other mods that use this system. As such this mod itself does not include any game-changing files.

What does this Include?

When downloaded, you'll find the following inside:
- Critical files to include in your mod.
- A README with detailed instructions on how to include the files.
- An example .xml that shows the structure necessary for creating your custom Building Choices. The example is fully formed and can be added to your mod for testing purposes.

Important Notes

- The system does NOT enforce one mod per building. If their are multiple mods including quests for the same building, then the last one loaded will be used. Refer to the Lua log to see how often building quests are being relplaced in this fashion.

- The system does not add the game's original quests to the table. If you do add it, it will ALWAYS overwrite the information from the original game. This is an easy way to modify quests for vanilla buildings if necessary.


- Also included are two new Game Defines in the "Defines" table, "QUEST_BUILDING_CHOICE_TRIGGER_BASE" and "QUEST_BUILDING_CHOICE_TRIGGER_INCREMENT". If you want to modify the chances of the game's quests triggering and still use this mod, feel free to modify these. They are set to the game's defaults of 5.

- This mod is designed to ease compatibility between different mods. It is vulnerable to game changes through official patches and DLC. Not to say your mod would NOT be vulnerable to the same kinds of changes if you don't use this compatibility add on (hint it totally will), but look for updates to this whenever a patch hits.

History

_________________________
initial upload (v1):
- Support for the Building Choice system as it now stands. Add custom building choices with two perk rewards for completing buildings.
_________________________
update (v2):
- Removed Unique constraint from BuildingChoiceQuests.BuildingType. In the case a building has two quests tied to it, the last one loaded by the game will be used. Modded quests are ALWAYS loaded after vanilla quests.
- Added two new Game Defines that affect the quest trigger chances.

External Links

CivFanatics download page
Steam Workshop link

 

[thecrazyscot]

Great resource, thanks for this!

 

[lilgamefreek]

Thanks! I hope people find this useful as Building Quests in vanilla are fairly painful to add into the game.

FYI, just released a little "hotfix" for people who plan to use this that should hopefully prevent any serious issues between multiple mods. I don't foresee myself making anymore changes to this until the next patch.

________________________
update (v2):
- Removed Unique constraint from BuildingChoiceQuests.BuildingType. In the case a building has two quests tied to it, the last one loaded by the game will be used. Modded quests are ALWAYS loaded after vanilla quests.
- Added two new Game Defines that affect the quest trigger chances.