-- README
-- Author: lilgamefreek
-- DateCreated: 4/10/2015 12:51:57 AM
--------------------------------------------------------------

USAGE IN YOUR MOD:

This mod should be extremely easy to use. All that is needed is to copy the two files in the folder 
"modular_building_quests" and include them in your ModBuddy project. Then take the following steps for 
each file.

BuildingChoiceTemplateQuest.lua:
	1.) Right-click your project
	2.) Select "properties"
	3.) In the window that appears, go to "Content"
	4.) Select "Add"
	5.) Fill out the form and press "OK" when complete.
		- For "File", use "BuildingChoiceTemplateQuest.lua" from the dropdown
		- For "Type", manually enter "Quest" exactly, without the quotes.
		- For "Name", enter "BuildingChoiceTemplateQuest" exactly, without the quotes.
		- Fill in what you like for "Description"

BuildingQuestTable.sql
	1.) Right-click your project
	2.) Select "properties"
	3.) In the window that appears, go to "Actions"
	4.) Select "Add"
	5.) Fill out the form and press "OK" when complete.
		- For "Event", use "OnModActivated"
		- For "Action", use "UpdateDatabase"
		- For "File" select "BuildingQuestTable.sql" from the dropdown.
	6.) IMPORTANT: Once you've added this mod action, ensure that it is the first action performed
	on mod activation. Do this by using the "Move Up" button with your created action selected
	while in the "Actions" menu. This will not affect your mod's performance.

IMPORTANT: You should not need to modify either of these two files in any other way to start adding your
custom building quests. Feel free to modify this but if you do, do not claim compatibility with other
mods that use this without testing first.

When adding a new building quest, you should only add it to the table "BuildingChoiceQuests" through a 
seperate file. Refer to the included example.xml.

Notes on Behaviour:
	- 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
	overwrite the information in the original game. This is an easy way to modify quests for vanilla
	buildings if necessary.
	- 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.
	- Also included are two new Game Defines in the "Defines" table, "QUEST_BUILDING_CHOICE_TIGGER_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.