Map Labels
For Modders
NOTE: Code for Static Labels XML has changed with v4 onward. View attachment Map Labels Static Example.zip reflects these changes, as does the LabelsToXML() function. Any XML for static labels created for previous versions of Map Labels will no longer work. I know this is inconvenient, but the changes were necessary. I plan on having full backwards compatibility in future updates.
There are many features here for modders. If your mod uses worldbuilder maps, you can hand-place your own feature labels (ex. add accurate feature names to a real-world map or create immersion in a fantasy map). If your mod has custom civs and uses randomly generated maps, through XML you can replace the default cultures with your own cultures, assign cultures to your civs, and provide your own lists of place names for the Dynamic Label Generator to choose from.
You are welcome to use my code in any way you want in your own mod (though be warned I am a novice programmer, so it may be messy!). In general, though, I would recommend keeping this mod as a separate dependency so players can keep it up to date with any new features/bug fixes (this will be easier once it's uploaded to Steam Workshop). Either way, it needs to load before yours, so changes you make to tables can be applied.
ML_Options Table
This table currently contains some global parameters and debugging options.
Assign Static Labels to a Custom Map
See example mod:
View attachment Map Labels Static Example.zip.
In Game (aka the easy way)
Make sure debug mode is enabled before starting.
1. Open your map in game with the Map Labels mod loaded.
(If you're using debug menu to reveal map so you can place labels, either change Options.XML 'DrawLabelsInFog' to 1 or type into Lua console:
g.Options.DrawLabelsInFog=1)
2. Add all labels to the map and format them through Label Display and Label Appearance in the Options menu.
3. Open FireTuner and open ML_Main context.
4. In the input box, type:
Code:
LabelsToXML(sTxtKeyPrefix, sLang)
Both arguments are optional; sTxtKeyPrefix is the prefix you want to add to the TXT_KEY names (e.g. giving the string "ML" will start all TXT_KEY names with "TXT_KEY_ML_"); sLang can be, for example, "en_US" (and defaults to "en_US" if not given)
5. Open the Lua.log file in \Documents\My Games\Sid Meier's Civilization 5\Logs\ (recommend using a program other than default notepad as it may not handle the length of the file well; Notepad++ works)
6. Scroll to the bottom of Lua.log and copy everything between the ****'s to a new XML file in your ModBuddy project (during my tests, this does not appear in FireTuner--maybe the string is too long for it)
(Note:won't work with special characters, so you'd have to add them manually in XML)
7. In ModBuddy, Project Options, Association, make sure Map Labels (ID: e576894a-ed2b-4033-be14-ed1c8ceb81d3) is listed as a Dependency or Reference.
Manually (aka the hard way)
Create your own XML file and update the ML_Labels_Static and ML_Options tables manually. You can get a plot's X,Y coordinates by mousing over it in WorldBuilder or Civ V (if debug mode enabled). Make sure you set the ML_Options MapType value to STATIC.
Customize Dynamic Labels Generator Labels
Attached Excel 2010 spreadsheet
View attachment DLG.zip will automatically generate XML from a list of labels.
You can delete from and add your own entries to the following tables. If you want your mod to work without error if Map Labels is not loaded, I'd recommend using SQL to add "CREATE TABLE IF NOT EXISTS" for the tables you're updating.
Code:
ML_Labels_Dynamic (ID INTEGER PRIMARY KEY AUTOINCREMENT, Name TEXT, MainType TEXT default "FEATURE", SubType TEXT, CultureType TEXT)
MainType --> SubType
REGION --> REGION, OCEAN, ISLAND
FEATURE --> MOUNTAIN, FOREST, LAKE, RIVER, DESERT
PLAYER --> PLAYER
BATTLE --> BATTLE, RAZED
CultureType is from ML_Cultures table
ML_CultureGroups (ID INTEGER PRIMARY KEY AUTOINCREMENT, Type TEXT, Description TEXT)
You can create new culture groups
ML_Cultures (ID INTEGER PRIMARY KEY AUTOINCREMENT, Type TEXT, 'Group' TEXT, Description TEXT, SuggestedCivs TEXT);
Group is from ML_CultureGroups and is required for Culture to show up in ingame Choose Culture popup
[INDENT]CULTURE_GROUP_ASIAN
CULTURE_GROUP_EUROPEAN
CULTURE_GROUP_AMERICAN
CULTURE_GROUP_PACIFIC
CULTURE_GROUP_MIDEASTERN
CULTURE_GROUP_AFRICAN[/INDENT]
SuggestCivs is optional, shows up as tooltip ingame in Choose Culture popup
ML_CivCultures (ID INTEGER PRIMARY KEY AUTOINCREMENT, CivType TEXT, CultureType TEXT, CultureEra TEXT DEFAULT 'ANY')
CivType is from Civilizations table Type column
CultureType is from ML_Cultures table
CultureEra is 'ANY', 'ANCIENT' or 'MODERN'; for most uses should be 'ANY'; Cultures from CultureEra ANCIENT or MODERN will show up as defaults in Choose Culture popup (used for civs that have different place names in different eras, usually as a result of colonialism)
trade: backwards compatible through v4)
