Changes between Version 1 and Version 2 of ModdingResources

Timestamp:

Oct 28, 2017, 12:11:28 PM (7 years ago)

Author:

Nescio

Comment:

Started rewriting, expanding, and updating

ModdingResources

@@ -8 +8 @@
 
 **Please Note:** The process of adding a resource, although a lot easier than before, is still not very modder friendly, particularly in the later sections, and you may get errors that might seem confusing. Please visit the 0ad-dev irc channel if you have questions (and please stick around long enough for an answer).
+
+
+
+== Resources == #resourceTypes
+0 A.D. currently has several different types of resources:
+* four normal resources: food, wood, stone, and metal
+* a special resource: population
+* a local resource (affecting only individual units): experience
+* a fundamental resource: time (time can not be edited, neither in 0 A.D. nor outside)
+This page simply considers modifying normal resources and ignores all others.
+
+
+
+== How to edit an existing resource == #editResource
+=== Change a resource icon === #resourceIcon
+Suppose you want to replace the meat icon used by “food” with a different one (because you care about historical accuracy and realize most people living in Antiquity could not afford meat even a single day in the year; or because you are a vegetarian and are opposed to the use of meat as generic food; or because you simply like to know how to change an icon; or for any other reason), all you have to do is create or edit two images:
+* `food.png` (the convention is 64×64 pixels)
+* `food_small.png` (16×16 pixels)
+and place those in `art/textures/ui/session/icons/resources/`
+
+Then launch the game and admire your icon being used everywhere for food.
+
+=== Change a resource name or other aspects === #resourceData
+The resources themselves are defined each in a separate `{resource}.json` file in `simulation/data/resources/`
+
+
+
+== To remove a resource == #removeResource
+Substraction is the inverse of addition. To remove a resource, in short, follow the instructions to add a resource (below), but in reverse making sure to remove all reference to the resource.
+
 
 
@@ -124 +154 @@
 
 
-== To remove a resource == #removeResource
 
-In short, follow the instructions to add a resource, but in reverse making sure to remove all reference to the resource.
+== Summary == #summary
+In short, to add a resource you need at least to create:
+* `art/textures/ui/session/icons/resources/{newresource}.png`
+* `art/textures/ui/session/icons/resources/{newresource}_small.png`
+* `simulation/data/resources/{newresource}.json`
+and to edit:
+* `gui/common/setup_resources.xml`
+* `gui/session/selection_panels.js`
+* `gui/session/selection_panels_left/barter_panel.xml`
+* `gui/session/top_panel/resources.xml`
+* `simulation/templates/special/player.xml`
+* `simulation/templates/special/player_gaia.xml`
+* `simulation/templates/template_structure.xml`
+This sufficient for having, displaying, trading, bartering, and using a resource. 
+
+If you also want to make your resource gatherable, you'll need more icons, create templates, and edit AI files and maps; see the relevant sections (above).
+
 
 
@@ -132 +177 @@
 
 * The session gui is limited to displaying four resources (plus population count) in the top bar.
-* Unless the patch that relocate the Barter icons to the Trade Dialog is applied, the session gui is limited to displaying four resources for Barter purposes.
 * Modifying countless actor files to add animations and props is not very mod-friendly.
 * Modders may wish to restrict the ability to barter, trade, or tribute resources. This is not currently implemented, see #4370.