share/hedgewars/Data/Names/README.md
author Wuzzy <Wuzzy2@mail.ru>
Wed, 16 Jan 2019 06:24:50 +0100
changeset 14609 ce315bb8b59d
parent 12635 11f5fe0407e5
child 14844 e239378a9400
permissions -rw-r--r--
ASA cosmos: Minor cinematic tweaks for meteorite cut scene
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12511
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     1
# Hedgewars random name lists
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     2
The directory Data/Names contains random hog and team names and
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
hat sets for themed teams.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
In this file I'll explain the format of each of the files:
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
## `<Hat>.cfg`
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
Hat configuration file.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
     9
This file lists the random name list (without file name suffix), e.g.:
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
    generic
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    12
    nordic
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    13
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
and so on. Each list name must exist in this directory. When choosing
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
a random name for this hat, it will first randomly choose one of the
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
name lists, then choose a random name within that list.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    18
`<Hat>` must be the name of a hat (without file name suffix) for which
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    19
to apply the random names, e.g. “Santa”.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    20
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    21
If a hat does not have a config file, it will use the generic name list.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
## `<name>.txt` =
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
This is a list of random hedgehog names, one name per line.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
`<name>` is an identifier of your choice (except “types”).
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    26
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
## `generic.txt` ==
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    28
Works exactly like `<name>.txt`, but this file is also used as default for all
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    29
hats without a .cfg file.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    30
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    31
This file must be present at all costs!
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    32
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    33
## `types.txt` =
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    34
This contains themed team names and hat sets.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    35
It works like this:
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    36
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    37
For each team:
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    38
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    39
* First comes a list of possible team names for a team type.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    40
* Then comes a separator line with 5 equals signs (“=====”).
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    41
* Then comes a list of hat names with out file name suffix.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    42
* Each hog of this team gets a random hat of this list. Repeat a hat name to
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    43
  jack up its probability.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    44
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    45
Each team is again separated by a separator line.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    46
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    47
At the end of the final team, this line must be written (without the spaces):
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    48
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    49
    *END*
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    50
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    51
Everything after that will be ignored.
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    52
12635
11f5fe0407e5 Use generic team names for non-themed random teams; add a bunch of more random team names
Wuzzy <almikes@aol.com>
parents: 12511
diff changeset
    53
The first team entry is special: The team names of this entry are considered
11f5fe0407e5 Use generic team names for non-themed random teams; add a bunch of more random team names
Wuzzy <almikes@aol.com>
parents: 12511
diff changeset
    54
to be generic and fit (more or less) and don't have any particular theme.
11f5fe0407e5 Use generic team names for non-themed random teams; add a bunch of more random team names
Wuzzy <almikes@aol.com>
parents: 12511
diff changeset
    55
12511
9a762e1729c6 Write documentation to explain those files in Data/Names
Wuzzy <almikes@aol.com>
parents:
diff changeset
    56
This file must be present at all costs!