== User Guide ==
Note: Before using the generator, you must first start the game, then exit, with any mods you wish to use enabled. If you do not do this, you may get an error about a missing setup.log file.

== The Data Tab ==
- Install Directory: This is where the game is installed. It will probably be something like this: C:\Program Files (x86)\Steam\SteamApps\common
- Allows and Gains Scripts: These allow you to select which scripts to use in the generated titles to control creation conditions and the like. There are only one of each by default.
- Mods: Use this to check which mods you wish to use in the game. Not all mods will appear in this list; only those that modify data this generator uses.
- Rule Sets: These contain rules concerning how history is generated. 
	- VanillaRuleSet: This one contains the basic rules that should work with any mod, and should be checked unless you have a replacement.
	- Keep867Republics, Keep1066Republics: Tells the history generator to leave the vanilla republics untouched in the 867 or 1066 start. Requires VanillaRuleSet to be enabled.
	- HIPRuleSet: Changes some default rules for compatibility with the Historical Immersion Project Mod. Requires VanillaRuleSet to be enabled.

- Mod Name: The name that will appear in the launcher.
- Output Log: Enabling this will cause a debug log to be saved when the program closes, and also prevents the log from being limited in size.
              If you have an issue with the generator, enable this option, repeat what caused the problem, and upload the log to somewhere like Pastebin.

== The Title Generation / Titles Tab ==
- Short Names: Causes the names of titles to be in the style "British Empire" instead of "Empire of Britain".
- Title Creation: Controls what level of titles are generated.
	- Duchies: Duchy level titles will be generated from all valid County level titles.
	- Kingdoms: Same, but for Kingdoms. Will also generated Kingdom level titles from generated Duchy level titles.
	- Empires: Again, same as Kingdoms.

- Culture Restrictions:
	- None: No restrictions on which characters may create the title.
	- Culture: Only characters of the same culture may create the title.
	- Culture Group: Only characters of the same culture group may create the title.
- Religion Restrictions: Same as cultures, but for religions.

- Counties, Duchies, Empires: How many titles of the given tier a character must hold to create a generated title of a higher tier. E.g. How many duchies to create a generated kingdom.

- Replace De Jure on Creation: This allows a generated title to skip the De Jure drift when it is first created.

== The Title Generation / History Tab ==
- History Modification:
	- None: History will be left untouched.
	- Clear: Title history for the given level and above will be cleared. Useful if you just want to clear the map of all kingdoms and empires.
	- Generate: Will randomly generate a new starting condition for the game.

== Generate Options ==
- Creation Type: Allows you to choose between varying levels of independent realms, or a full generation.
	- Counts, Dukes, Kings, Emperors: New holders and vassals will be generated for each De Jure title of the given level.
	- Full History: Will create new realms, and "grow" them until the map is filled.

- Start Date: This is the year you intend to start playing. If you do not set this correctly, the map may be empty when you try to start.
- Seed: When enabled, allows you to specify the seed used for the random number generator, allowing you to recreate a previous generation. Is automatically set to the last used seed.

- Culture Generation: If enabled, the generator will randomly generate new cultures and culture groups, and fill the map with them. Can result in between 6 and 64 cultures.
					  The names of characters are also randomly generated from the data in the "namedata" folder.
	- Groups, Min and Max: The minimum and maximum number of culture groups to generate. The actual value will be between those you select. Maximum is 8, minimum is 3.
	- Cultures, Min and Max: The same but for cultures. Maximum is 8, minimum is 2.

- Realms, Min and Max: The number of realms to create. Can be anywhere between 2 and 2000. The generator will only generate as many realms as can fit in the map.
- Realms, Make Kingdoms: If enabled, realms that are large enough will be "promoted" to kingdoms. Others will be left as dukes or counts.

- Theocracies, Min and Max: How many of the above realms to convert into theocracies. Can be between 0 and 50.
- Republics, Min and Max: How many republics to generate. Can be between 0 and 50. Generated republics will be limited in size, but can expand along the coast.

There are many extra options to control the above within the rule sets, such as spouse chance, republic expansion limits, laws, religious and cultural gender limits, specified in the rule sets.
The VanillaRuleSet file in /scripts/rules is commented, which can be changed. Just make a copy, and make the changes there.