-- Readme
-- Author: Typhlomence
-- DateCreated: 9/28/2015 12:50:08 AM
--------------------------------------------------------------

This mod adds a civilization based on WarioWare from the Super Mario Bros. franchise, with the greedy and cunning Wario as its leader. This civilization is designed around accruing large amounts of Gold by liberating art and artifacts belonging to other civilizations.

This mod requries Brave New World. It also includes compatibility with:
	- Ryoga's Unique Cultural Influence
	- JFD's Cultural Diversity (Western - this is chosen because it suits Wario more, even though WarioWare is Japanese)
	- JFD's Piety and Soverignty
	- Bingles' Civ IV Leader Traits (Creative, Financial)
	- JFD's Exploration Continued Expanded (Treasure Hunter gets Disease Immunity)
	- Hazel's Map Labels
	- Vicevirtuoso's Wish for the World
	- Sukritact's Modular City Info Stack
	- JFD's and Pouakai's Mercenaries
	- Ryoga's Strange Religions (changes religious preference to Objectivism)
	- JFD's Cities in Development
	- Ethnic Units (Japanese units)
Compatibility with Events and Decisions will come later, though you will get a custom Cultural Development event.

Mod options can be changed via the WarioOptions.sql file. You can choose an alternate leader icon for Wario, as well as enabling alternate colours for Egypt if you're having trouble distinguishing the two civilizations on the map.

UA: Get Rich Quick! - Every 50 Gold Per Turn increases the offensive Combat Strength of melee land units by 5% (maximum of 25%). Receive 2 Gold Per Turn for each foreign Great Work or Artifact you possess.

UU: Treasure Hunter - Replaces the Archaeologist. Can melee attack and gain extra Gold on destroying a unit or capturing a city. It also has a 50/50 chance of finding treasure after digging up an Antiquity Site, which gives a bonus of 50 Gold Per Turn for several turns (3 turns on Standard Speed). This is extended if more treasure is found while the bonus is in effect.

UB: Microgame Producer - Replaces the Stadium. Provides +2 Gold Per Turn for each building with an active Theming Bonus in the city.

Peace Diplomacy Track: Title Theme (Wario World)
War Diplomacy Track: Wario's Factory (Mario Sports Mix)

You can also download the following soundtrack packs for this civilization - either will work without the other should you not want to download both:
	Super Mario Bros. Super Soundtrack - Common soundtrack mod: https://mega.nz/#!yxgGUaIC!2qnEQ9TZEoVtddJqeUcMKbPjPV42Gryf3MDGTUVXV-Q
		- Code only link (to update without downloading all the music again): https://mega.nz/#!PwhygTAa!yYhR0qAeBjDIs1wxgpij_dxEkWe0NvVXlChFlisqaoc
	Super Mario Bros. Super Soundtrack - WarioWare soundtrack mod: https://mega.nz/#!z9pSBCII!wOXQWkA5DMLrhK5pJpRS30sYgXouhn_-34IYZKBU5Yg
		- Code only link: https://mega.nz/#!GxJkBBTS!houYcYr8DhOCzITzGL9BDwYzrTp2TbkglE6egROGuOs

Includes unique diplomacy responses for the following leaders:
	- Princess Peach and the Mushroom Kingdom (Nucleotyde)
	- Bowser and the Koopa Troop (Typhlomence)
	- Blanc of Lowee (Vice Virtuoso)
	- Nepgear of Planeptune (Vice Virtuoso)
	- The Broken Lords (Vice Virtuoso)
	- Scrooge McDuck (CleverAdvisor)
	- George Mainwaring of Walmington-on-Sea (Typhlomence)
	- Reimu Hakurei (BouncyMischa, not yet released)
	- Holo of the Wisewolves (DarkScythe)

Change Notes:
2 (04/02/2016)
	- Japanese soundtrack should correctly play if neither of the soundtrack mods are active
		- Also fixed the references on the soundtrack mods so that they should detect Wario properly - they only worked before since I had set the soundtrack tag to 'TYPH_WARIO' already!
	- Unique diplomacy
		- Added a host of new diplomacy lines for the new response types introduced in the Community Patch and Civ IV Diplomatic Features
		- Unique diplomacy responses now available
	- Mod support updated
		- Treasure Hunter's unit models should appear correctly depending on visual mods used (for example, it should only use Wario if Single Unit Graphics is enabled)
		- Some mod support seperated into multiple SQL files so that any issues with support for specific mods (caused when loaded alongside a mod civ with outdated support and the mod NOT active) do not prevent the parsing of the whole file
	- Fixes to various Lua code
		- Microgame Producer bonus should work correctly (due to me indexing the list incorrectly when making the building class list, only the last class in the list would work - Broadway with no other buildings added)
		- Notification for a Treasure Hunter finding treasure should now display, and an alert should appear if the Treasure Hunter does not find any treasure
		- Alert for Treasure Hunter GPT should display the correct amount of remaining turns
		- MCIS Lua fixed so that it shows correctly, and text updated to be more informative
		- GPT Combat Strength increase should be recalculated whenever Wario captures or loses a city, and should be applied to units constructed in the turn
		- Microgame Producer's Gold bonus should update after more actions during the player's turn. Because it is a GPT bonus, this is more visual than anything, but should let you at least trade with the extra GPT in deals before ending the turn (disabled in multiplayer since it is currently untested and may cause issues)

1 (26/12/2015)
	- Initial version

Notes:
	- The reason that the GPT Combat Strength increase only applies (genreally) when the turn is generated is that there is no foolproof way to ensure that they can be updated whenever GPT changes during the turn, especially in a way that ensures that the game doesn't desync. I feel the other times that it does apply (building a unit, losing/capturing a city, and finding treasure with a Treasure Hunter) should be good enough.

Known issues:
	- I'm not sure whether they'll appear by default either, but the unique promotions that make Wario's UA work may not appear in the Unit Panel depending on what mods you have loaded. However, they should still be in effect - the correct "Attack Bonus" should appear when the combat prediction pop-up is displayed.

Thanks to:
- SamBC and J_mie6 for their Icon Atlas templates, and DJSHenninger for his icon backgrounds;
- Tomatekh, whose Garamantes civilization I used as a reference for the invisible trait building;
- Deliverator, for his unit reskin and conversion tutorials;
- ViceVirtuoso for advice on the unique abilities;
- JFD for his MasterSupportFile.sql file for mod compatibility, and for general assistance with mod compatibility;
- bouncymischa for moral support :) ;
- Nintendo for creating the Super Mario Bros. universe and the Mario Wiki for all the information and images I used for making this mod.