# HG changeset patch
# User Wuzzy <almikes@aol.com>
# Date 1506196823 -7200
# Node ID 9a762e1729c6fe54f65cd1d9888dc4c8a90fcf03
# Parent  82c75a317d48ce46ae087797fd5e442c4fe67d54
Write documentation to explain those files in Data/Names

diff -r 82c75a317d48 -r 9a762e1729c6 share/hedgewars/Data/Names/Hat.cfg
--- a/share/hedgewars/Data/Names/Hat.cfg	Sat Sep 23 21:05:57 2017 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-generic
diff -r 82c75a317d48 -r 9a762e1729c6 share/hedgewars/Data/Names/README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/share/hedgewars/Data/Names/README.md	Sat Sep 23 22:00:23 2017 +0200
@@ -0,0 +1,53 @@
+# Hedgewars random name lists
+The directory Data/Names contains random hog and team names and
+hat sets for themed teams.
+
+In this file I'll explain the format of each of the files:
+
+## `<Hat>.cfg`
+Hat configuration file.
+This file lists the random name list (without file name suffix), e.g.:
+
+    generic
+    nordic
+
+and so on. Each list name must exist in this directory. When choosing
+a random name for this hat, it will first randomly choose one of the
+name lists, then choose a random name within that list.
+
+`<Hat>` must be the name of a hat (without file name suffix) for which
+to apply the random names, e.g. “Santa”.
+
+If a hat does not have a config file, it will use the generic name list.
+
+## `<name>.txt` =
+This is a list of random hedgehog names, one name per line.
+`<name>` is an identifier of your choice (except “types”).
+
+## `generic.txt` ==
+Works exactly like `<name>.txt`, but this file is also used as default for all
+hats without a .cfg file.
+
+This file must be present at all costs!
+
+## `types.txt` =
+This contains themed team names and hat sets.
+It works like this:
+
+For each team:
+
+* First comes a list of possible team names for a team type.
+* Then comes a separator line with 5 equals signs (“=====”).
+* Then comes a list of hat names with out file name suffix.
+* Each hog of this team gets a random hat of this list. Repeat a hat name to
+  jack up its probability.
+
+Each team is again separated by a separator line.
+
+At the end of the final team, this line must be written (without the spaces):
+
+    *END*
+
+Everything after that will be ignored.
+
+This file must be present at all costs!