Author: cazfi
Date: Fri Oct  7 14:02:02 2016
New Revision: 34035

Documented use of nations override -directory.

See patch #7565


Modified: trunk/doc/README.nations
--- trunk/doc/README.nations    (original)
+++ trunk/doc/README.nations    Fri Oct  7 14:02:02 2016
@@ -14,6 +14,36 @@
+Local Nation files:
+Starting from freeciv-2.6, to most supplied rulesets nations can be
+added locally without need to modify freeciv distribution files.
+This section discuss the way there local override files work. Later
+sections assume that nation is being added to main freeciv distribution,
+even if only to locally modified copy.
+Freeciv search data files from several directories in priority order.
+Local nations overrides mechanism uses this to include files from
+user data directory, ~/.freeciv/<freeciv version>/override/,
+e.g., ~/.freeciv/2.6/override/
+Freeciv distribution has empty versions of those files in a lower priority
+directory. Once user adds the file, it gets used instead of the empty
+  Ruleset sections for nations that user wants to add. This can of course
+  use *include directives so that individual nations are in separate files.
+  See below sections for the format of the nation rulesets.
+  Spec files for flag graphics to add. See below sections for the format
+  of spec files and graphics files.
 How to add a Nation:
@@ -36,12 +66,12 @@
   This lists all nation files. Add your nation
   (data/nation/<nationname>.ruleset) to this list.
   This is the flags directory. You will have to add a flag-file
   (see below) for your nation to work (see below).
   You can add starting position for your nation on a scenario map.
@@ -49,16 +79,16 @@
 files will also have to be edited. Unless you know what you're doing you
 shouldn't need to worry about this.
   Another list of nation files - add your nation (<nationname>.ruleset)
   to this list.
   Another list of flag files - add your flag to this list.
   Here is yet another list of nations files; again add your nation
   (data/nation/<nationname>.ruleset) to it.

Freeciv-commits mailing list

Reply via email to