share/hedgewars/Data/Names/README.md
changeset 12511 9a762e1729c6
child 12635 11f5fe0407e5
equal deleted inserted replaced
12510:82c75a317d48 12511:9a762e1729c6
       
     1 # Hedgewars random name lists
       
     2 The directory Data/Names contains random hog and team names and
       
     3 hat sets for themed teams.
       
     4 
       
     5 In this file I'll explain the format of each of the files:
       
     6 
       
     7 ## `<Hat>.cfg`
       
     8 Hat configuration file.
       
     9 This file lists the random name list (without file name suffix), e.g.:
       
    10 
       
    11     generic
       
    12     nordic
       
    13 
       
    14 and so on. Each list name must exist in this directory. When choosing
       
    15 a random name for this hat, it will first randomly choose one of the
       
    16 name lists, then choose a random name within that list.
       
    17 
       
    18 `<Hat>` must be the name of a hat (without file name suffix) for which
       
    19 to apply the random names, e.g. “Santa”.
       
    20 
       
    21 If a hat does not have a config file, it will use the generic name list.
       
    22 
       
    23 ## `<name>.txt` =
       
    24 This is a list of random hedgehog names, one name per line.
       
    25 `<name>` is an identifier of your choice (except “types”).
       
    26 
       
    27 ## `generic.txt` ==
       
    28 Works exactly like `<name>.txt`, but this file is also used as default for all
       
    29 hats without a .cfg file.
       
    30 
       
    31 This file must be present at all costs!
       
    32 
       
    33 ## `types.txt` =
       
    34 This contains themed team names and hat sets.
       
    35 It works like this:
       
    36 
       
    37 For each team:
       
    38 
       
    39 * First comes a list of possible team names for a team type.
       
    40 * Then comes a separator line with 5 equals signs (“=====”).
       
    41 * Then comes a list of hat names with out file name suffix.
       
    42 * Each hog of this team gets a random hat of this list. Repeat a hat name to
       
    43   jack up its probability.
       
    44 
       
    45 Each team is again separated by a separator line.
       
    46 
       
    47 At the end of the final team, this line must be written (without the spaces):
       
    48 
       
    49     *END*
       
    50 
       
    51 Everything after that will be ignored.
       
    52 
       
    53 This file must be present at all costs!