[eXML] Dissecting Resources

from Elemental Forums

I am at work with some spare time, so I am dissecting some of the XML and notating it along the way. 

There are some items within that I cannot determine their functionality or purpose.  Please feel free to correct any invalid information or add to the notes.  I will update this accordingly.  Please pardon the excessive carraige returns as this was done for clarity.

Code: xml
  1. <?xml version="1.0" encoding="utf-8"?>
  3. <!-- There are two files that are currently used for resources, CoreResources.xml and CoreWorldResources.xml. 
  4. This document attempts to dissect those files by notating their contents.
  6. In the case of these two resource types, it appears that "world resources" are considered raw, untapped
  7. resources that appearon the map while "resources" are considered accumulated/stored resources. -->
  9.  
  11. <!-- This entry is from CoreWorldResources.xml. -->
  12. <ResourceTypes>
  13. <!-- All resource objects <ResourceType> must belong to the object <ResourceTypes> -->
  15.  
  17.  <DataChecksum NoParse="1">
  18.   <Ignore>DispName</Ignore>
  19.   <Translate>DispName,Description</Translate>
  20.  </DataChecksum>
  21.  <!-- I am not sure of the necessity of this block in mods and how it pertains to the XML creation.
  22.    The NoParse value of 1 would indicate that this block should not be parsed as a resource.
  23.    Considering this is titled "DataChecksum," I assume this is used by Stardock for updates.-->
  25.  
  27.  <ResourceType InternalName="VentriOre">
  28.  <!-- <ResourceType is the object name.  "InternalName" defines the name of the resource for 
  29.    Elemental's internal usage. -->
  30.   
  31.   <DisplayName>Ventri Metal Deposit</DisplayName>
  32.   <!-- The name of the resource as it is displayed to the player. -->
  33.   
  34.   <Type>VentriIronOre</Type>
  35.   <!-- The name of the resource for our (the modders) reference.   For instance, in order to build
  36.     upon this resource, the Ventri Mine improvement must appropriately reference "VentriIronOre." -->
  37.   
  38.   <Description>Build a Mine here to produce Metal.</Description>
  39.   <!-- This is the brief flavor text of the resource. -->
  40.   
  41.   <LongDescription>Ventri Ore was has long thought to be gone from this world. Unlike the relatively more common iron ore, Ventri Ore provides twice as much usable metal.</LongDescription>
  42.   <!-- This is the verbose flavor text of the resource. -->
  43.   
  44.   <PreferredTerrain>Land</PreferredTerrain>
  45.   <!-- The terrain in which the resource is available, although this is not applied with 100% accuracy.
  46.        Available values are defined in TerrainTypes.xml, or with custom terrain types as appropriate.-->
  47.   
  48.   <NeedsToBeUnlocked>0</NeedsToBeUnlocked>
  49.   <!-- Whether the resource needs to be unlocked or not.
  50.        Available values:  0 (No), 1 (Yes) -->
  51.    
  52.   <HarvestType>Mining</HarvestType>
  53.   <!-- The type of harvesting required.  I believe that this is an internal reference for the
  54.     AI to reference.
  55.     Available values:  Mining, Farming, -->
  56.   <!-- Value list incomplete. -->
  57.   
  58.   <IconColor>0,0,0</IconColor>
  59.   <!-- The color that shades the icon. -->
  60.   
  61.   <Icon>Gfx//Icons//Icon_Metal.png</Icon>
  62.   <!-- The file name of the icon and its location.  Custom icons can be located in "mods//". -->
  63.   
  64.   <ClothIcon>gfx\\TacticalIcons\\Res_VentiOre1.png</ClothIcon>
  65.   <!-- The file name of the icon as represented on the cloth map.  Custom icons can be located in "mods//". -->
  66.   
  67.   <TileDesign>R_Venrti_01</TileDesign>
  68.   <!-- The name of the tile, as designed in the Tile editor and/or defined in the tile's XML. -->
  69.   
  70.   <ModelColor>32,0,0</ModelColor>
  71.   <!-- The color that shades the tile -->
  72.   
  73.   <Production>1.0</Production>
  74.   <!-- Undetermined.  The production multiplier.  -->
  75.   
  76.   <Worth>5</Worth>
  77.   <!-- Undetermined. Possibly an internal value used by the AI to determine priority and/or a player's
  78.     relative strength. -->
  79.   
  80.   <Global>0</Global>
  81.   <!-- Is this a global resource or a local resource?
  82.     Available values:  0 (Local), 1 (Global) -->
  83.    
  84.   <Rarity>60</Rarity>
  85.   <!-- Frequency that the resource appears on the map.  Functionality is undetermined at this time.-->
  86.   
  87.   <Stored>0</Stored>
  88.   <!-- Is this resource stored and accumulated?
  89.     Available values:  0 (No), 1 (Yes) -->
  90.    
  91.   <RummagedPerTurn>1.0</RummagedPerTurn>
  92.   <!-- Undetermined.  Potentially obsolete.  Artifact from previous mechanic.-->
  93.   
  94.   <Medallions InternalName="IronOre_Res_Medallions">
  95.    <All>Res_Ores_Plains.png</All>
  96.   </Medallions>
  97.   <!-- The graphical image that represents the resource.  These must be located in
  98.     gfx\\medallions. -->
  99.   
  100.   <OnSelectSFX>Click_IronOre_01</OnSelectSFX>
  101.   <!-- The sound effect that is played when the resource is clicked.  These must be
  102.     located in sfx. -->
  104.   <!-- Note that medallions in other objects do have full directory locations, so it is logical to assume
  105.     that medallions and sound effects can be placed in the mods folder and referenced accordingly. -->
  107. </ResourceTypes>
  109.  
  111. <!-- This entry is from CoreResources.xml. -->
  112. <!-- Only the differences and additional notes are annotated. -->
  113. <ResourceTypes>
  115.  <DataChecksum NoParse="1">
  116.   <Ignore>DispName</Ignore>
  117.   <Translate>DispName,Description</Translate>
  118.  </DataChecksum>
  120.  <ResourceType InternalName="GoldType01">
  121.   <DisplayName>Gildar</DisplayName>
  122.   <Type>Gold</Type>
  123.   <IconColor>0,0,0</IconColor>
  124.   <Icon>Gfx//Icons//Res_Icon_Gold.png</Icon>
  125.   <ClothIcon>gfx\\TacticalIcons\\MetalOre_1.png</ClothIcon>
  126.   
  127.   <ModelColor>0,0,0</ModelColor>
  128.   <!-- Not sure why this is included, as there is no associated tile/model for
  129.     stored resources. -->
  130.   
  131.   <Worth>1</Worth>
  132.   <Global>1</Global>
  133.   
  134.   <Rarity>0.0</Rarity>
  135.   <!-- Stored resources, logically, do not appear on the map, so would have a
  136.     rarity of 0. -->
  137.   
  138.   <Shared>0</Shared>
  139.   <!-- Undetermined. -->
  140.   
  141.   <TradedByCaravans>1</TradedByCaravans>
  142.   <!-- Does this resource get traded via a caravan route?
  143.     Available values:  0 (no), 1 (yes) -->
  144.    
  145.   <ShownInGlobalDisplay>1</ShownInGlobalDisplay>
  146.   <!-- Is this resource displayed in the UI at the top of the screen?
  147.     Available values:  0 (no), 1 (yes) -->
  148.   
  149.   <Medallions InternalName="Gold_Res_Medallions">
  150.    <All>Res_Ores_Plains.png</All>
  151.   </Medallions>
  152.  </ResourceType>
  153. </ResourceTypes>
  155.  
  157. <!-- Additional tags which are not referenced above: -->
  159.  
  161. <EnvironmentType>GrasslandEnvironment</EnvironmentType>
  162. <EnvironmentSpreadIntensity>100.0</EnvironmentSpreadIntensity>
  163. <EnvironmentSpreadRadius>3</EnvironmentSpreadRadius>
  165.  
  167. <!-- Note that these are reportedly not used at this time. -->

 

10,622 views 18 replies
Reply #1 from Elemental Forums Top

Additional notes:

Medallions and sound effects appear to be required to be located in their respective directories, although I have not attempted to override this with the mods directory locations.  I am also not quite sure why medallions require their own internal name.

Reply #2 from Elemental Forums Top


  
  <Type>VentriIronOre</Type>
  <!-- Undetermined. -->

End of quote

It's the type of a gameplay resource it provides - see Marble/Stone Pit and Old Forest both providing Materials.

   
  <HarvestType>Mining</HarvestType>
  <!-- The type of harvesting required.  I believe that this is an internal reference for the
    AI to reference.
    Available values:  Mining, Farming, -->
  <!-- Value list incomplete. -->

End of quote

 Nope. think Refined Farming and Refined Mining techs.

 
  <Production>1.0</Production>
  <!-- Undetermined.  The production multiplier.  -->
End of quote

That's a guess but I'd say it is a part of <Production> * <HarvestingImprovementOutput> = <ResourceOutputInTheGame> . there was some talk about Pumpkin Patches providing 0.6 output of Fertile Land with a Farm built on them

<Worth>5</Worth>
  <!-- Undetermined. Possibly an internal value used by the AI to determine priority and/or a player's
    relative strength. -->

End of quote

Diplomatic negotiations value?

     
  <Rarity>60</Rarity>
  <!-- Undetermined.  Frequency that the resource appears on the map. -->
 
End of quote

 You're right, it's a chance to spawn on an empty tile. And I don't know how it exactly works either or what the <min,max> range is.


<RummagedPerTurn>1.0</RummagedPerTurn>
<!-- Undetermined. -->

End of quote

There was once talk of a rummaging mechanic. In short if you didn't have a source of an unlocked resource your people were supposed to be able to find small amounts of it. That's a leftover from that. No idea if it works.
  

Sins of a Solar Empire II
Reply #3 from Elemental Forums Top

<PreferredTerrain> the value list is not complete, it can hold any Terrain value. It should also be noted that the value is not "forced", so for example a Warg resource tile with PreferredTerrain Swamp can spawn in other types of terrain.

Since the value is not forced, it is hard to determine if the tag even works, or has a purpose.

ResourceType also have 3 additional tags not included in your example

        <EnvironmentType>GrasslandEnvironment</EnvironmentType>
        <EnvironmentSpreadIntensity>100.0</EnvironmentSpreadIntensity>
        <EnvironmentSpreadRadius>3</EnvironmentSpreadRadius>

But they appear not to function as well

 

Reply #4 from Elemental Forums Top

Thank you for the updates.  I will notate the original accordingly.

Do you think that these explorations of the XML will be helpful to the general modding community and should I continue along this path?  I don't want to post excessively if the perception is that I am only doing this for myself.  The secondary motivation is for my own learning, but primarily, it is obviously very useful if the objects are mapped thoroughly.

Reply #5 from Elemental Forums Top

VentriIronOre

It's the type of a gameplay resource it provides - see Marble/Stone Pit and Old Forest both providing Materials.
End of quote

Except that Ventri Iron Ore (and Iron Ore) both produce "Metal."  This is handled with the improvement types.  This appears to be the name which we reference, as modders.

In CoreWorldResources: 

Code: xml
  1. &lt;Type&gt;VentriIronOre&lt;/Type&gt;

In the related (Ventri Mine) improvement type: 

Code: xml
  1. &lt;SupportedResourceType&gt;VentriIronOre&lt;/SupportedResourceType&gt;

Within the same improvement type, Metal is defined as the resource it provides:

Code: xml
  1.   &lt;GameModifier&gt;
  2.    &lt;ModType&gt;Resource&lt;/ModType&gt;
  3.    &lt;Attribute&gt;Metal&lt;/Attribute&gt;
  4.    &lt;Value&gt;3.0&lt;/Value&gt;
  5.    &lt;PerTurn&gt;1&lt;/PerTurn&gt;
  6.    &lt;ResourceShared&gt;1&lt;/ResourceShared&gt;
  7.   &lt;/GameModifier&gt;

 

Reply #6 from Elemental Forums Top

 
Code: xml
  1. &lt;HarvestType&gt;Mining&lt;/HarvestType&gt;
  2.   &lt;!-- The type of harvesting required.  I believe that this is an internal reference for the
  3.     AI to reference.
  4.     Available values:  Mining, Farming, --&gt;
  5.   &lt;!-- Value list incomplete. --&gt;

 Nope. think Refined Farming and Refined Mining techs.

End of quote

Please feel free to clarify.

Reply #7 from Elemental Forums Top

This is the correlating improvement to the above resources.

Code: xml
  1. &lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
  3. &lt;!-- Improvements are very detailed objects.  For this example, I am simply annotating the Ventri Mine --&gt;
  4. &lt;!-- as it directly reflects the resources examples above.  In time, they will have their own thread. --&gt;
  6. &lt;ImprovementTypes&gt;
  7. &lt;!-- All improvement objects &lt;ImprovementType&gt; must belong to the object &lt;ImprovementTypes&gt; --&gt;
  9.  &lt;DataChecksum NoParse="1"&gt;
  10.   &lt;Ignore&gt;DisplayName&lt;/Ignore&gt;
  11.   &lt;Translate&gt;DisplayName&lt;/Translate&gt;
  12.  &lt;/DataChecksum&gt;
  14.  &lt;ImprovementType InternalName="E_Ventri_Mine"&gt;
  15.  &lt;!-- ImprovementType is the object name.  "InternalName" defines the name of the resource for --&gt;
  16.  &lt;!-- Elemental's usage. --&gt;
  17.  
  18.   &lt;DisplayName&gt;Ventri Mine&lt;/DisplayName&gt;
  19.   &lt;!-- The name of the resource as it is displayed to the player. --&gt;
  20.  
  21.   &lt;Description&gt;Ventri Mines can be built on Ventri Iron Ore to produce 3 Metal.&lt;/Description&gt;
  22.   &lt;!-- This is the flavor text of the improvement. --&gt;
  23.   
  24.   &lt;TileDesign&gt;F_Venrti_Mine_01&lt;/TileDesign&gt;
  25.   &lt;!-- The name of the tile, as designed in the Tile editor and/or defined in the tile's XML. --&gt;
  27.   &lt;ConstructionTileDesign&gt;F_Venrti_Mine_Build_01&lt;/ConstructionTileDesign&gt;
  28.   &lt;!-- The name of the tile during construction, as designed in the Tile editor and/or defined --&gt;
  29.   &lt;!-- in the tile's XML. --&gt;
  30.   
  31.   &lt;SupportedTerrainType&gt;Land&lt;/SupportedTerrainType&gt;
  32.   &lt;SupportedTerrainType&gt;City&lt;/SupportedTerrainType&gt;
  33.   &lt;!-- The terrain where tile can be built. --&gt;
  34.   &lt;!-- I am not certain as to the relevance of this entry for the Ventri Mine, as this can only --&gt;
  35.   &lt;!-- be build on a Ventri Ore resource. --&gt;
  36.   
  37.   &lt;DrawnIcon&gt;Gfx/TacticalIcons/K_VentiMine1.png&lt;/DrawnIcon&gt;
  38.   &lt;!-- The image that appears on the cloth map. --&gt;
  39.   
  40.   &lt;DrawnIconConstruction&gt;Gfx/TacticalIcons/K_VentiMine1_C.png&lt;/DrawnIconConstruction&gt;
  41.   &lt;!-- The image that appears on the cloth map during construction. --&gt;
  43.  
  45.   &lt;Thumbnail&gt;Gfx/Medallions/F_Venrti_Mine_01_Thumb.png&lt;/Thumbnail&gt;
  46.   &lt;!-- The small image that is used to represent the improvement. --&gt;
  47.   
  48.   &lt;IgnoreDuplicateImpLimit&gt;true&lt;/IgnoreDuplicateImpLimit&gt;
  49.   &lt;!-- Undetermined if this is actually used.  Can more than one be constructed? --&gt;
  50.   &lt;!-- Available values:  True, False --&gt;
  51.   
  52.   &lt;Medallions InternalName=""&gt;
  53.    &lt;All&gt;Gfx/Medallions/F_Venrti_Mine_01_Thumb.png&lt;/All&gt;
  54.    &lt;Border_All&gt;&lt;/Border_All&gt;
  55.   &lt;/Medallions&gt;
  56.   &lt;!-- The graphical image that represents the improvement. --&gt;
  58.  
  60.   &lt;!-- Prerequisites --&gt;
  61.   &lt;RequiresCity&gt;True&lt;/RequiresCity&gt;
  62.   &lt;!-- Must this improvement be built within a city's zone of control? --&gt;
  63.   &lt;!-- Available values:  True, False. --&gt;
  64.   
  65.   &lt;RequiresResource&gt;True&lt;/RequiresResource&gt;
  66.   &lt;!-- Must this improvement be built upon a resource? --&gt;
  67.   &lt;!-- Available values:  True, False. --&gt;
  68.   
  69.   &lt;SupportedResourceType&gt;VentriIronOre&lt;/SupportedResourceType&gt;
  70.   &lt;!-- What is the resource that it can be built upon?  This value is the &lt;Type&gt; value which is --&gt;
  71.   &lt;!-- defined in the resource itself.  See above. --&gt;
  73.  
  75.   &lt;Prereq&gt;
  76.    &lt;Type&gt;Allegiance&lt;/Type&gt;
  77.    &lt;Attribute&gt;Empire&lt;/Attribute&gt;
  78.   &lt;/Prereq&gt;
  79.   &lt;!-- In this example, this requires an allegiance to the Empire faction in order to build this --&gt;
  80.   &lt;!-- improvement.  All &lt;Type&gt; tags will be referenced at a later date. --&gt;
  82.  
  84.   &lt;LaborToBuild&gt;5.0&lt;/LaborToBuild&gt;
  85.   &lt;!-- How many turns it takes to build the improvement. --&gt;
  87.  
  89.   &lt;GameModifier&gt;
  90.    &lt;ModType&gt;ConstructionResourceCost&lt;/ModType&gt;
  91.    &lt;Attribute&gt;Gold&lt;/Attribute&gt;
  92.    &lt;Value&gt;-40&lt;/Value&gt;
  93.   &lt;/GameModifier&gt;
  94.   &lt;!-- The cost of constructing the improvement. --&gt;
  95.   &lt;!-- Note that additional &lt;GameModifiers&gt; with the &lt;ModType&gt; of ContructionResourceCost can be --&gt;
  96.   &lt;!-- added as required.  --&gt;
  98.  
  100.   &lt;!-- Benefits --&gt;
  101.   &lt;GameModifier&gt;
  102.    &lt;ModType&gt;Resource&lt;/ModType&gt;
  103.    &lt;Attribute&gt;Metal&lt;/Attribute&gt;
  104.    &lt;Value&gt;3.0&lt;/Value&gt;
  105.    &lt;PerTurn&gt;1&lt;/PerTurn&gt;
  106.    &lt;ResourceShared&gt;1&lt;/ResourceShared&gt;
  107.   &lt;/GameModifier&gt;
  108.   &lt;!-- The benefits of constructing the improvement. --&gt;
  109.   &lt;!-- Note that additional &lt;GameModifiers&gt; with the &lt;ModType&gt; of Resource can be --&gt;
  110.   &lt;!-- added as required.  --&gt;  
  111.   
  112.     &lt;AIData AIPersonality="AI_General"&gt;
  113.       &lt;AITag&gt;Mining&lt;/AITag&gt;
  114.     &lt;/AIData&gt;
  115.  &lt;!-- How the AI references this improvement. --&gt;
  116.  
  117.  &lt;/ImprovementType&gt;
  119. &lt;/ImprovementTypes&gt;

Reply #8 from Elemental Forums Top

Excellent work with this list Jharii, well done here my friend.

 

Quoting Heavenfall, reply 3
<PreferredTerrain> the value list is not complete, it can hold any Terrain value. It should also be noted that the value is not "forced", so for example a Warg resource tile with PreferredTerrain Swamp can spawn in other types of terrain.

Since the value is not forced, it is hard to determine if the tag even works, or has a purpose.

ResourceType also have 3 additional tags not included in your example

        <EnvironmentType>GrasslandEnvironment</EnvironmentType>
        <EnvironmentSpreadIntensity>100.0</EnvironmentSpreadIntensity>
        <EnvironmentSpreadRadius>3</EnvironmentSpreadRadius>

But they appear not to function as well
End of Heavenfall's quote

I noticed this too. In fact there's a Lot of things that just don't seem to be hooked up or just flat out don't work. I'm not sure why either but it doesn't make much sense to me to have settings in the XML that don't change anything (at least not anything noticeable). This makes it a lot harder (for me at least) to know what's worth changing and what isn't. Especially when we try to change something expecting it to have a certain result and then nothing happens.

Dhuran and I also noticed there seems to be a lot of UN-Necessary steps when trying to Mod even simple things. Some things appear to be split up in the XML for no other reason than to have them split up when they could be condensed into one XML file. Some things seem to take way too many steps to accomplish when in other games that support XML editing don't require as many different references or steps to get a job done.

Hopefully some of the upcoming patches address the over complicated steps and narrow things down for us. Also having a list of what works and what doesn't or what isn't hooked up yet would be great. Somehow though I don't see Stardock coming forward with a list and saying "Here's a list of stuff that doesn't work yet so don't worry about changing it" but honestly that would be a Big Help.

 

Reply #9 from Elemental Forums Top

I noticed this too. In fact there's a Lot of things that just don't seem to be hooked up or just flat out don't work. I'm not sure why either but it doesn't make much sense to me to have settings in the XML that don't change anything (at least not anything noticeable). This makes it a lot harder (for me at least) to know what's worth changing and what isn't. Especially when we try to change something expecting it to have a certain result and then nothing happens.
End of quote

Thanks, Raven.  And this is EXACTLY why I am doing this.  Without Stardock's input, and us chomping at the bit to mod the game, it is very difficult to implement anything without pulling out some hair (fortunately for me, I shave my dome).  Pooling our resources (ugh, sorry) together should help alleviate these struggles.

In time, it would be worthwhile to have nice, clean templates of these objects so we can just plug them in and fill them out as needed.

Dhuran and I also noticed there seems to be a lot of UN-Necessary steps when trying to Mod even simple things. Some things appear to be split up in the XML for no other reason than to have them split up when they could be condensed into one XML file. Some things seem to take way too many steps to accomplish when in other games that support XML editing don't require as many different references or steps to get a job done.
End of quote

I noticed this as well.  I think I am going to attack this much differently than Stardock.  My intention is to have an XML file for each resource, improvement type, etc.  Essentially, each object "grouping" in the game.  So when I implement my clay and ceramic bits resources, quarry, kiln, and mint improvements, they will be kept in independant files.

  • SL_Resource_Clay.xml
  • SL_Resource_Ceramic_Bits.xml
  • SL_Improvement_Clay_Quarry.xml
  • SL_Improvement_Kiln.xml
  • SL_Improvement_Mint.xml

I (as well as you and everyone else) will know exactly what is contained within and the notes at the top of the file will describe the relationships.  If I ever have to adjust the output of the kiln for each race/faction, I know exactly where to go, and I don't need to open a dozen files to do so.

Reply #10 from Elemental Forums Top

Great Job.   Definitely interested in this.   I do think that we need some more information from stardock (the .xsd files would be great), so that we know what the valid values are for each field.  I have a feeling that we'll eventually have the full story, but right now they are still in "overdrive" trying to get promised features working.

 

In any case, keep it up, and thanks for sharing.

Reply #11 from Elemental Forums Top

Annotated Template:

Code: xml
  3. &lt;?xml version="1.0" encoding="utf-8"?&gt;
  5. &lt;!-- Resource Template --&gt;
  6. &lt;!-- There are essentially two types of resources in the game:  those that appear on the map and those --&gt;
  7. &lt;!-- that are generated from other sources, such as improvements.  This is a template for those resources. --&gt;
  9. &lt;ResourceTypes&gt;
  10.  &lt;DataChecksum NoParse="1"&gt;
  11.   &lt;Ignore&gt;DispName&lt;/Ignore&gt;
  12.   &lt;Translate&gt;DispName,Description&lt;/Translate&gt;
  13.  &lt;/DataChecksum&gt;
  15.  &lt;ResourceType InternalName=""&gt;
  16.  &lt;!-- InternalName requires a unique name for Elemental's internal usage. --&gt;
  17.   
  18.   &lt;!-- ************************************************************** --&gt;
  19.   &lt;!-- These are required in both map resources and stored resources. --&gt;
  20.   &lt;!-- ************************************************************** --&gt;
  21.   
  22.   &lt;Type&gt;&lt;/Type&gt;
  23.   &lt;!-- The name of the resource for you (the modder) to reference. --&gt;
  25.   &lt;DisplayName&gt;&lt;/DisplayName&gt;
  26.   &lt;!-- The name of the resource as it is displayed to the player. --&gt;
  27.   &lt;Description&gt;&lt;/Description&gt;
  28.   &lt;!-- This is the brief flavor text of the resource. --&gt;
  29.   &lt;LongDescription&gt;&lt;/LongDescription&gt;
  30.   &lt;!-- This is the verbose flavor text of the resource. --&gt;
  32.   &lt;IconColor&gt;&lt;/IconColor&gt;
  33.   &lt;!-- The color that shades the icon. (R,G,B) --&gt;
  34.   &lt;Icon&gt;//mods//gfx//&lt;/Icon&gt;
  35.   &lt;!-- The file name of the icon and its location.  Custom icons can be located in "mods//". --&gt;
  37.   &lt;Worth&gt;&lt;/Worth&gt;
  38.   &lt;!-- Undetermined. Possibly an internal value used by the AI to determine priority and/or a player's
  39.     relative strength. --&gt;
  40.   &lt;Global&gt;&lt;/Global&gt;
  41.   &lt;!-- Is this a global resource or a local resource? (0,1) --&gt;
  42.   &lt;Rarity&gt;&lt;/Rarity&gt;
  43.   &lt;!-- Unknown implementation.  Frequency that the resource appears on the map. --&gt;
  45.   &lt;Medallions InternalName=""&gt;
  46.    &lt;All&gt;//mods//gfx//&lt;/All&gt;
  47.   &lt;/Medallions&gt;
  48.   &lt;!-- The graphical image that represents the resource. --&gt;
  49.   
  50.   &lt;!-- * End universal resources.       ***************************** --&gt;
  52.   
  53.   &lt;!-- ************************************************************** --&gt;
  54.   &lt;!-- These are required for map resources.  Delete as required.     --&gt;
  55.   &lt;!-- ************************************************************** --&gt;
  56.   
  57.   &lt;PreferredTerrain&gt;&lt;/PreferredTerrain&gt;
  58.   &lt;!-- The terrain type which the resource appears on.  Not currently enforced. --&gt;
  59.   &lt;HarvestType&gt;&lt;/HarvestType&gt;
  60.   &lt;!-- Usage unknown.  Potential AI reference.--&gt;
  61.   &lt;NeedsToBeUnlocked&gt;&lt;/NeedsToBeUnlocked&gt;
  62.   &lt;!-- Usage unknown.  Whether the resource needs to be unlocked or not. (0/1) --&gt;
  63.   
  64.   &lt;ClothIcon&gt;//mods//gfx//&lt;/ClothIcon&gt;
  65.   &lt;!-- The file name of the icon as represented on the cloth map.  Custom icons can be located in "mods//". --&gt;
  66.  
  67.   &lt;TileDesign&gt;&lt;/TileDesign&gt;
  68.   &lt;!-- The name of the tile, as designed in the Tile editor and/or defined in the tile's XML. --&gt;
  69.   &lt;ModelColor&gt;&lt;/ModelColor&gt;
  70.   &lt;!-- The color that shades the tile (R,G,B) --&gt;
  71.   
  72.   &lt;Production&gt;&lt;/Production&gt;
  73.   &lt;!-- Undetermined.  The production multiplier.  --&gt;
  74.   &lt;Stored&gt;&lt;/Stored&gt;
  75.   &lt;!-- Is this resource stored and accumulated? (0,1) --&gt;
  77.   &lt;OnSelectSFX&gt;//mods/sfx//&lt;/OnSelectSFX&gt;
  78.   &lt;!-- The sound effect that is played when the resource is clicked. --&gt;
  79.   
  80.   &lt;!-- * End map resources.             ***************************** --&gt;
  82.   
  83.   &lt;!-- ************************************************************** --&gt;
  84.   &lt;!-- These are required for stored resources. Delete as required.   --&gt;
  85.   &lt;!-- ************************************************************** --&gt;
  86.   &lt;Shared&gt;&lt;/Shared&gt;
  87.   &lt;!-- Undetermined. --&gt;
  88.   &lt;TradedByCaravans&gt;&lt;/TradedByCaravans&gt;
  89.   &lt;!-- Does this resource get traded via a caravan route? (0,1) --&gt;
  90.   &lt;ShownInGlobalDisplay&gt;&lt;/ShownInGlobalDisplay&gt;
  91.   &lt;!-- Is this resource displayed in the UI at the top of the screen? (0,1) --&gt;
  93.   &lt;!-- * End stored resources.          ***************************** --&gt;
  95.   
  96.   &lt;!-- ************************************************************** --&gt;
  97.   &lt;!-- Unknown or obsolete. Delete as required.                       --&gt;
  98.   &lt;!-- ************************************************************** --&gt;
  99.   &lt;RummagedPerTurn&gt;&lt;/RummagedPerTurn&gt;
  100.   &lt;EnvironmentType&gt;&lt;/EnvironmentType&gt;
  101.   &lt;EnvironmentSpreadIntensity&gt;&lt;/EnvironmentSpreadIntensity&gt;
  102.   &lt;EnvironmentSpreadRadius&gt;&lt;/EnvironmentSpreadRadius&gt;
  104.   &lt;!-- * End obsolete tags.             ***************************** --&gt;
  105.   
  106.  &lt;/ResourceType&gt;
  107. &lt;/ResourceTypes&gt;

Reply #12 from Elemental Forums Top

Barebones template:

Code: xml
  3. &lt;?xml version="1.0" encoding="utf-8"?&gt;
  5. &lt;!-- Resource Template --&gt;
  6. &lt;!-- There are essentially two types of resources in the game:  those that appear on the map and those --&gt;
  7. &lt;!-- that are generated from other sources, such as improvements.  This is a template for those resources. --&gt;
  9. &lt;ResourceTypes&gt;
  10.  &lt;DataChecksum NoParse="1"&gt;
  11.   &lt;Ignore&gt;DispName&lt;/Ignore&gt;
  12.   &lt;Translate&gt;DispName,Description&lt;/Translate&gt;
  13.  &lt;/DataChecksum&gt;
  15.  &lt;ResourceType InternalName=""&gt;
  16.   
  17.   &lt;Type&gt;&lt;/Type&gt;
  19.   &lt;DisplayName&gt;&lt;/DisplayName&gt;
  20.   &lt;Description&gt;&lt;/Description&gt;
  21.   &lt;LongDescription&gt;&lt;/LongDescription&gt;
  23.   &lt;IconColor&gt;&lt;/IconColor&gt;
  24.   &lt;Icon&gt;//mods//gfx//&lt;/Icon&gt;
  26.   &lt;Worth&gt;&lt;/Worth&gt;
  27.   &lt;Global&gt;&lt;/Global&gt;
  28.   &lt;Rarity&gt;&lt;/Rarity&gt;
  30.   &lt;Medallions InternalName=""&gt;
  31.    &lt;All&gt;//mods//gfx//&lt;/All&gt;
  32.   &lt;/Medallions&gt;
  33.   
  34.   &lt;!-- These are required for map resources.  Delete as required.     --&gt;
  35.   
  36.   &lt;PreferredTerrain&gt;&lt;/PreferredTerrain&gt;
  37.   &lt;HarvestType&gt;&lt;/HarvestType&gt;
  38.   &lt;NeedsToBeUnlocked&gt;&lt;/NeedsToBeUnlocked&gt;
  39.   
  40.   &lt;ClothIcon&gt;//mods//gfx//&lt;/ClothIcon&gt;
  41.   &lt;TileDesign&gt;&lt;/TileDesign&gt;
  42.   &lt;ModelColor&gt;&lt;/ModelColor&gt;
  43.   
  44.   &lt;Production&gt;&lt;/Production&gt;
  45.   &lt;Stored&gt;&lt;/Stored&gt;
  47.   &lt;OnSelectSFX&gt;//mods/sfx//&lt;/OnSelectSFX&gt;
  49.   &lt;!-- These are required for stored resources. Delete as required.   --&gt;
  51.   &lt;Shared&gt;&lt;/Shared&gt;
  52.   &lt;TradedByCaravans&gt;&lt;/TradedByCaravans&gt;
  53.   &lt;ShownInGlobalDisplay&gt;&lt;/ShownInGlobalDisplay&gt;
  55.   &lt;!-- Unknown or obsolete. Delete as required.                       --&gt;
  56.   &lt;RummagedPerTurn&gt;&lt;/RummagedPerTurn&gt;
  57.   &lt;EnvironmentType&gt;&lt;/EnvironmentType&gt;
  58.   &lt;EnvironmentSpreadIntensity&gt;&lt;/EnvironmentSpreadIntensity&gt;
  59.   &lt;EnvironmentSpreadRadius&gt;&lt;/EnvironmentSpreadRadius&gt;
  61.  &lt;/ResourceType&gt;
  62. &lt;/ResourceTypes&gt;

Reply #13 from Elemental Forums Top

Frustratingly, setting a world resource type to <Rarity>0.0</Rarity> does not prevent it from being spawned during world creation.

Code: xml
  1. &lt;ResourceType InternalName="FertileLandType01"&gt;&lt;Rarity&gt;0.0&lt;/Rarity&gt;&lt;/ResourceType&gt;

More research to do...

Reply #14 from Elemental Forums Top

Only for new types of resources. If you're looking to remove the placing of a resource type, I don't think that's possible at the moment. First, <rarity> doesn't seem to overwrite properly. Second, there will still spawn certain resource nodes around the original starting point.

Reply #15 from Elemental Forums Top

That absolutely sucks.

Reply #16 from Elemental Forums Top

Quoting Jharii, reply 1
Additional notes:

Medallions and sound effects appear to be required to be located in their respective directories, although I have not attempted to override this with the mods directory locations.  I am also not quite sure why medallions require their own internal name.
End of Jharii's quote

 

 Here is an example of a medallion that is located in units\icons working in game (Notice the bottom right corner):

 

Jafar

 

I hope that helps!

 

 

Reply #17 from Elemental Forums Top

Quoting jshores, reply 16

Here is an example of a medallion that is located in units\icons working in game (Notice the bottom right corner):

I hope that helps!
End of jshores's quote

Thanks!  Yeah, I had already gotten the override to work in the mods directory.

Reply #18 from Elemental Forums Top

Quoting Jharii, reply 7
This is the correlating improvement to the above resources.


  <IgnoreDuplicateImpLimit>true</IgnoreDuplicateImpLimit>
  <!-- Undetermined if this is actually used.  Can more than one be constructed? -->
  <!-- Available values:  True, False -->

End of Jharii's quote

 

Yes, this is used. If you set that to false, and you happened to have two ventri ores in your city's influence, you'd only be able to build upon one of them. I've used this on city buildings, and can say that yes, it does work.