<?xml version="1.0" encoding="iso-8859-1"?>
<html>
<head>
<meta name="generator"
content="HTML Tidy for Linux/x86 (vers 1st July 2002), see www.w3.org" />
<title>The Colossus Battlelands Randomizer</title>
<!-- $Id: BattlelandsRandomizer.html 3658 2009-02-27 11:56:51Z dolbeau $ -->
</head>
<body>
<h1 align="center">The Colossus Battlelands Randomizer</h1>
<div class="p">
<h2>
<a id="tth_sEc1" name="tth_sEc1">1</a>
BattlelandsRandomizer</h2>
</div>
<div class="p">BattlelandsRandomizer is a (very crude) tool to randomly
create Battlelands for use with the "
<a href="http://colossus.sf.net">Colossus</a>
" Game. It has the same requirements as Colossus itself, see
<a href="README.html">Colossus README</a>
and
<a href="build.html">Colossus build-HOWTO</a>
.</div>
<div class="p">To create the program, just type "make tools" or
"ant tools". See
<a href="build.html">Building Colossus</a>
for more details. This should create all the tools for Colossus, including
BattlelandsRandomizer.</div>
<div class="p">BattlelandsRandomizer uses an input file that describes the
properties of the future Battleland, and generates one random Battleland.
At the moment, it's a purely static, text-based process.</div>
<div class="p">The Randomizer used can also be accessed from inside
<a href="BattlelandsBuilder.html">BattlelandsBuilder</a>
, in a much more user-friendly way. An input file (described below) is
still needed.</div>
<div class="p">Examples of random input files can be found in the
"Random" subdirectory.</div>
<div class="p">Properties are lines of one of the three forms:</div>
<div class="p">
<ol type="1">
<li>
<tt>AREA <list_of_hex> HAZARDS <list_of_hazards></tt>
</li>
<li>
<tt>LABEL <label> = <list_of_hex></tt>
</li>
<li>
<tt>PAIR <pair_of_hazard> HEXSIDES <list_of_hexsides
></tt>
</li>
</ol>
</div>
<div class="p">where</div>
<div class="p">
<ul>
<li>
<tt>AREA</tt>
,
<tt>HAZARDS</tt>
,
<tt>PAIR</tt>
,
<tt>HEXSIDES</tt>
and
<tt>LABEL</tt>
are the strings literals ; = is the character literal
'='.</li>
<li><list_of_hex> is a list of hex from the following available
forms:
<ul>
<li>
<tt>"(" <number>, <number >")"</tt>
</li>
<li>
<tt>"(" <range>, <range>")"</tt>
</li>
<li>
<tt>"(" <number>, <range>")"</tt>
</li>
<li>
<tt>"(" <range>, <number>")"</tt>
</li>
<li>
<tt><hex_label></tt>
</li>
<li>
<tt>"(" <label>")"</tt>
</li>
<li>
<tt>SOMEOF"(" <number>, <list_of_hex
>")"</tt>
</li>
<li>
<tt>SURROUNDINGSOF"(" <list_of_hex
>")"</tt>
</li>
<li>
<tt>SUBSTRACT"(" <list_of_hex>, <list_of_hex
>")"</tt>
</li>
</ul>
where <number> is a number between 0 and 5, and <range> is
of the form <number>- <number> i.e. a range of number
between 0 and 5. <hex_label> is simply the label displayed on the
Battlemap (F4, C3,...) <label> is a label defined previously with
a
<tt>LABEL</tt>
statement (see below)</li>
<li style="list-style: none">
<div class="p">There are some predefined labels available, including
:
<ul>
<li>"inside" representing everything but the most outside
Hex.</li>
<li>"leftdefenseentry", "upperdefenseentry" and
"lowerdefenseentry", the 3 lines of 3 hexagons
representing the defense entry lines (left, upper-right, and
lower-right respectively).</li>
<li>"anywhere" representing the whole Battlelands.</li>
<li>"leftover" : special label representing all hexes
that were in the most recent
<tt>AREA</tt>
statement, but didn't receive a Hazard.</li>
<li>"usedup" : special label representing all hexes that
were in the most recent
<tt>AREA</tt>
statement, and did receive a Hazard.</li>
</ul>
</div>
<div class="p">
<tt>SOMEOF</tt>
is a literal string ; result is a list of <number> hexes taken
randomly from the <list_of_hex> in parameter.</div>
<div class="p">
<tt>SURROUNDINGSOF</tt>
is a literal string ; result is the list of hexes adjacent to any
hex(es) in the <list_of_hex> in parameter. Note that all hexes
present in the <list_of_hex> are excluded from the
result.</div>
<div class="p">
<tt>SUBSTRACT</tt>
is a literal string ; result is the list of hexes that are in the
first list but not in the second.</div>
</li>
<li><list_of_hazards> is a list of Hazard from the following
available forms:
<ul>
<li>
<tt><hazard_letter>(, <probability>)?(, <elevation
>)?</tt>
</li>
<li>
<tt><hazard_letter>(, <probability>)?(,
<probability_elevation_0>, <probability_elevation_1>,
<probability_elevation_2>)?</tt>
</li>
</ul>
</li>
<li style="list-style: none">
<div class="p">where <hazard_letter> is a letter representing a
Hazard ('r' for Brush, and so on, see BattleHex.java),
<probability> is a float number representing the percentile of
chance of the hazard being present (a numerical point _must_ be
present for all probability), <elevation> is a hard-coded
elevation (integer between 0 and 2), and the three
<probability_elevation_X> are the odds of the hazard being at
elevation 0, 1 and 2 respectively (it's better is the sum is
100., but they will be normalized to percentile values). Only the
<hazard_letter> is mandatory, the other parts are optionals.
But if those other parts are present, they must respect the order
above (first probability if present, the either the elevation or the
elevation probabilities).</div>
</li>
<li><label> is a lowercase-only string, that act afterwards as it
was the list of Hex on the right side of the '='
character.</li>
<li><list_of_hexsides> is alist of <hexside_letter>,
<hexside_probability></li>
<li><pair_of_hazard> is a pair of "("
<hazard_letter>, <elevation>")". Elevation can be
0, 1, 2 or the character literal *, which means 'any
elevation'. For all hexside between such a pair of hazard, all
hexside from the <list_of_hexside> will be tried in order, until
either one is present, or all have been tried (in which case no hexside
will be used between the two hazards). Not that the default Hazard, the
plains (character 'p'), can be used.</li>
</ul>
</div>
<div class="p">BattlelandsRandomizer will then, for each
<tt>AREA</tt>
, try to put the Hazard in any one of the Hexes in the
<tt>AREA</tt>
. A Hex will not receive two hazards, but if a Hex is present multiple
times in the same
<tt>AREA</tt>
, it may receive one Hazard per occurence of the Hex. In this case, only
the last Hazard is used.</div>
<div class="p">
<tt>AERA</tt>
s are processed in order, so an Hex that appears in multiple
<tt>AREAS</tt>
may also receive multiple Hazards. In this case only the last Hazard is
used.</div>
<div class="p">Note that all hexsides use the same
<tt>PAIR</tt>
-defined probability. Only the last
<tt>PAIR</tt>
statement is used for a given pair. For this purpose, all elevations
including * are different. The more specific statement will be used (i.e.
(s,0)(p,0) will be used instead of (s,*)(p,*) for the hexside between a
0-height Sand and a 0-height Plains).</div>
<div class="p">Finally, you can give the random maps a title and a subtitle
<ul><tt>TITLE <map_title></tt></ul>
<ul><tt>SUBTITLE <map_subtitle></tt></ul></div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c2689b4ec379fa0c27c46f80bcedfcf3
>
files
>
6
