1<?xml version='1.0'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<refentry id="bi2cf.6">
5<refentryinfo>
6  <date>Jan 30 2003</date>
7  <author>
8    <firstname>Florian</firstname>
9    <surname>Dietrich</surname>
10    <address><email>n8flo@yahoo.de</email></address>
11  </author>
12</refentryinfo>
13
14<refmeta>
15  <refentrytitle>bi2cf</refentrytitle>
16  <manvolnum>6</manvolnum>
17</refmeta>
18
19<refnamediv>
20  <refname>bi2cf</refname>
21  <refpurpose>a map conversion tool for Crimson Fields</refpurpose>
22</refnamediv>
23
24<refsynopsisdiv>
25  <cmdsynopsis>
26    <command>bi2cf</command>
27    <arg choice="plain"><replaceable>mapname</replaceable></arg>
28    <arg choice="opt">-p 1|2</arg>
29    <arg choice="opt">-f b|1|2|h</arg>
30    <arg choice="opt">-l</arg>
31    <arg choice="opt">-t <replaceable>mapname</replaceable></arg>
32    <arg choice="opt">-i <replaceable>mapinfo</replaceable></arg>
33    <arg choice="opt">-o <replaceable>outfile</replaceable></arg>
34    <arg choice="opt">-d <replaceable>mapdir</replaceable></arg>
35    <arg choice="opt">-O <replaceable>destdir</replaceable></arg>
36    <arg choice="opt">-q</arg>
37  </cmdsynopsis>
38
39  <cmdsynopsis>
40    <command>bi2cf</command>
41    <group choice="req">
42      <arg choice="plain">-h</arg>
43      <arg choice="plain">-v</arg>
44    </group>
45  </cmdsynopsis>
46</refsynopsisdiv>
47
48<refsect1><title>Description</title>
49  <para><command>bi2cf</command> is a map conversion tool for Crimson
50  Fields. It takes the data files of maps from Battle Isle, Battle Isle
51  Data Disk 1 or 2, or History Line 1914-1918 and converts them into map
52  sources usable with the
53  <citerefentry><refentrytitle>cfed</refentrytitle><manvolnum>6</manvolnum></citerefentry>
54  map compiler for Crimson Fields. <command>bi2cf</command> can handle
55  both uncompressed maps and levels crunched with TPWM.</para>
56
57  <para>For some units and tiles there are no corresponding counterparts
58  in Crimson Fields. These cases are mapped to similar ones if available.
59  As a result some maps will not be as balanced as the originals, others
60  may be unwinnable, and still others may even fail to compile. If this
61  happens the map in question needs to be adjusted manually.</para>
62</refsect1>
63
64<refsect1><title>Options</title>
65  <variablelist>
66    <varlistentry>
67      <term><option>-d</option> <replaceable>mapdir</replaceable></term>
68      <listitem>
69        <para>Set the location of the Battle Isle map files.</para>
70      </listitem>
71    </varlistentry>
72
73    <varlistentry>
74      <term><option>-f</option> b|1|2|h</term>
75      <listitem>
76        <para>Force map type to Battle Isle / BI Data Disk 1 / BI Data
77        Disk 2 / History Line, respectively. Use this option when map
78        format autodetection does not work correctly. Maps from BI Data
79        Disk 1 will always be detected as standard Battle Isle maps, so
80        you have to use <option>-f 1</option> in that case.</para>
81      </listitem>
82    </varlistentry>
83
84    <varlistentry>
85      <term><option>-h</option></term>
86      <listitem>
87        <para>Print a usage message on standard output and exit.</para>
88      </listitem>
89    </varlistentry>
90
91    <varlistentry>
92      <term><option>-i</option> <replaceable>mapinfo</replaceable></term>
93      <listitem>
94        <para>Set map info message.</para>
95      </listitem>
96    </varlistentry>
97
98    <varlistentry>
99      <term><option>-l</option></term>
100      <listitem>
101        <para>Skip last row and column of the map. This is necessary for
102        maps from the PC version of Battle Isle.</para>
103      </listitem>
104    </varlistentry>
105
106    <varlistentry>
107      <term><option>-o</option> <replaceable>outfile</replaceable></term>
108      <listitem>
109        <para>Write map to file <replaceable>outfile</replaceable>.
110        Default file name is <filename>mapname.src</filename>.</para>
111      </listitem>
112    </varlistentry>
113
114    <varlistentry>
115      <term><option>-O</option> <replaceable>destdir</replaceable></term>
116      <listitem>
117        <para>Set target directory for the converted map. This setting
118        is ignored if a map name was given using the <option>-t</option>
119        option.</para>
120      </listitem>
121    </varlistentry>
122
123    <varlistentry>
124      <term><option>-p</option> 1|2</term>
125      <listitem>
126        <para>Set default number of players for this map.</para>
127      </listitem>
128    </varlistentry>
129
130    <varlistentry>
131      <term><option>-q</option></term>
132      <listitem>
133        <para>Run quietly. Don't print processing information on
134        standard output.</para>
135      </listitem>
136    </varlistentry>
137
138    <varlistentry>
139      <term><option>-t</option> <replaceable>mapname</replaceable></term>
140      <listitem>
141        <para>Set title and file name for the converted map. Default is
142        <filename>maptype-mapname</filename>.</para>
143      </listitem>
144    </varlistentry>
145
146    <varlistentry>
147      <term><option>-v</option></term>
148      <listitem>
149        <para>Print version information on standard output and exit.
150        </para>
151      </listitem>
152    </varlistentry>
153  </variablelist>
154</refsect1>
155
156<refsect1><title>See Also</title>
157  <para>
158    <citerefentry><refentrytitle>cfed</refentrytitle><manvolnum>6</manvolnum></citerefentry>,
159    <citerefentry><refentrytitle>crimson</refentrytitle><manvolnum>6</manvolnum></citerefentry>
160  </para>
161</refsect1>
162
163<refsect1><title>Copyright</title>
164  <para>Copyright &copy; 2002 Florian Dietrich</para>
165  <para>This software is distributed under the terms of the
166  <ulink url="http://www.gnu.org/copyleft/gpl.html">GNU General Public
167  License</ulink> (GPL).</para>
168</refsect1>
169</refentry>
170
171