Skip to content

Commit

Permalink
Generate the quickstart guide and add it to the app bundle.
Browse files Browse the repository at this point in the history
  • Loading branch information
dak180 committed Jan 5, 2012
1 parent 6093506 commit 932d452
Show file tree
Hide file tree
Showing 71 changed files with 999 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Expand Up @@ -91,6 +91,10 @@ win32/__BUILD_CONFIG.USER
/doc/quickstartguide.html
/doc/quickstartguide.pdf
/doc/warzone2100.6
/doc/events.tex
/doc/functions.tex
/doc/globals.tex
/doc/objects.tex

# Generated executables:
/build_tools/autorevision/autorevision
Expand Down
1 change: 1 addition & 0 deletions macosx/Resources/.gitignore
@@ -0,0 +1 @@
!*.pdf
Binary file not shown.
9 changes: 9 additions & 0 deletions macosx/Resources/WarzoneHelp/ar01s01.html
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>1. Introduction</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="up" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="prev" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="next" href="ar01s02.html" title="2. Interface" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s02.html">Next</a></td></tr></table><hr /></div><div class="section" title="1. Introduction"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>1. Introduction</h2></div></div></div><p>This guide will help you get started playing Warzone 2100.</p><p>The Warzone 2100 Project has its website at <span class="inlinemediaobject"><img src="images/www.png" alt="URL" /></span>
<a class="ulink" href="http://wz2100.net" target="_top">http://wz2100.net</a>.</p><p>If you want to talk to other Warzone 2100 players, visit the forum at
<span class="inlinemediaobject"><img src="images/www.png" alt="URL" /></span> <a class="ulink" href="http://forums.wz2100.net" target="_top">http://forums.wz2100.net</a></p><p>Or you can fire up an IRC client and connect to the channels #warzone2100 and
#warzone2100-games on the Freenode network.</p><p>If you’re interested in developing Warzone 2100, the Project is always looking
for help. Go to <span class="inlinemediaobject"><img src="images/www.png" alt="URL" /></span> <a class="ulink" href="http://developer.wz2100.net" target="_top">http://developer.wz2100.net</a></p><p>If you want more information about Warzone 2100, including mod information,
individual component statistics, and more, go to <span class="inlinemediaobject"><img src="images/www.png" alt="URL" /></span>
<a class="ulink" href="http://guide.wz2100.net" target="_top">http://guide.wz2100.net</a></p><p>Enjoy Warzone 2100!</p><div class="informalfigure"><div class="mediaobject" align="center"><img src="images/logo.png" align="middle" alt="images/logo.png" /></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
16 changes: 16 additions & 0 deletions macosx/Resources/WarzoneHelp/ar01s02.html
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>2. Interface</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="up" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="prev" href="ar01s01.html" title="1. Introduction" /><link rel="next" href="ar01s03.html" title="3. Controlling the Camera" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ar01s01.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr></table><hr /></div><div class="section" title="2. Interface"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_interface"></a>2. Interface</h2></div></div></div><p>The interface can be turned on or off with Tab.</p><p><span class="inlinemediaobject"><img src="images/interface.jpg" alt="images/interface.jpg" /></span></p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="emphasis"><em>Messages (top)</em></span>: The message bank. This keeps all the last few messages
given to you by the game. To see more of your most recent messages, press the
`/~ key (this is the backtick/tilde key; usually found between Esc and Tab).
</li><li class="listitem">
<span class="emphasis"><em>Time remaining (top right)</em></span>: The time limit. This is only seen during
Campaign. If this goes down to zero, you lose!
</li><li class="listitem">
<span class="emphasis"><em>Command panel (bottom left)</em></span>: The <a class="link" href="ar01s08.html" title="8. Command Panel">command panel</a>.
</li><li class="listitem">
<span class="emphasis"><em>Power (bottom)</em></span>: The <a class="link" href="ar01s05.html" title="5. Power">power bar</a>.
</li><li class="listitem">
<span class="emphasis"><em>Map (bottom right)</em></span>: The <a class="link" href="ar01s04.html" title="4. Minimap">minimap</a>.
</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s01.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
24 changes: 24 additions & 0 deletions macosx/Resources/WarzoneHelp/ar01s03.html
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>3. Controlling the Camera</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="up" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="prev" href="ar01s02.html" title="2. Interface" /><link rel="next" href="ar01s04.html" title="4. Minimap" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ar01s02.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr></table><hr /></div><div class="section" title="3. Controlling the Camera"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_controlling_the_camera"></a>3. Controlling the Camera</h2></div></div></div><p title="What is the Camera?"><strong>What is the Camera? </strong>When Warzone was released in 1999, it was one of the first real-time strategy
games to be in 3D. Now, most real-time strategies are in 3D, but, if you’re not
used to the new trend, let us help you along.</p><div class="itemizedlist" title="Basic Controls"><p class="title"><strong>Basic Controls</strong></p><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="emphasis"><em>Moving</em></span>: To move where you’re looking at, move the mouse to the edge of the
window/screen, or use the arrow keys.
</li><li class="listitem">
<span class="emphasis"><em>Rotating</em></span>: To rotate the view, hold down the right mouse button, and move
the mouse in any direction. (The view can also be rotated using 8 and 2
(up/down), or 4 and 6 (left/right) on the numeric keypad.)
</li><li class="listitem">
<span class="emphasis"><em>Zooming</em></span>: To zoom in or out, use the + or - keys on the numeric keypad, or
use the mouse wheel.
</li></ul></div><div class="itemizedlist" title="Advanced Controls"><p class="title"><strong>Advanced Controls</strong></p><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="emphasis"><em>Reset view to north</em></span>: If your camera angle feels unnatural, pressing
Backspace will reset your view to the north.
</li><li class="listitem">
<span class="emphasis"><em>Unit Tracking</em></span>: Press Spacebar when units are selected, and the camera will
follow them. Press Spacebar again to stop Unit Tracking.
</li><li class="listitem">
<span class="emphasis"><em>Jump to base</em></span>: Press B to center the view at your Command Center. Useful if
you need to get back to base quickly.
</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s02.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
37 changes: 37 additions & 0 deletions macosx/Resources/WarzoneHelp/ar01s04.html
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>4. Minimap</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="up" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="prev" href="ar01s03.html" title="3. Controlling the Camera" /><link rel="next" href="ar01s05.html" title="5. Power" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ar01s03.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s05.html">Next</a></td></tr></table><hr /></div><div class="section" title="4. Minimap"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_minimap"></a>4. Minimap</h2></div></div></div><p>The minimap is a very useful tool on the Warzone battlefield. It helps you keep
track of your units and structures, your opponents units and structures (within
range), and the map itself. Orders can be issued over the minimap, and it can
be used to jump to part of the map very quickly.</p><p>The minimap is given after you build a Command Center.</p><p><span class="inlinemediaobject"><img src="images/minimap.jpg" alt="images/minimap.jpg" /></span></p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="emphasis"><em>Faint-white trapezoid</em></span>: This is a visual representation of your camera on
the radar. The large end points towards where you’re looking. The small end is
where the camera is.
</li><li class="listitem">
<span class="emphasis"><em>Transparent areas</em></span>: Unexplored - will peel away as you send units into them.
These areas are black on the screen.
</li><li class="listitem">
<span class="emphasis"><em>Green area</em></span>: Units or structures that belong to the green player (in this
case, us).
</li><li class="listitem">
<span class="emphasis"><em>Yellow/gray/black/red/blue/cyan/magenta area</em></span>: Units or structures that
belong to the yellow/gray/black/red/blue/cyan/magenta player (not pictured).
</li><li class="listitem">
<span class="emphasis"><em>Red/white flashing area</em></span>: Units or structures belonging to you that are
under attack.
</li><li class="listitem">
<span class="emphasis"><em>Green pulse</em></span>: Artifact. Needed to research technologies in Campaign. In
Skirmish/Multiplayer, can be found by destroying enemy base structures.
</li><li class="listitem">
<span class="emphasis"><em>Red pulse</em></span>: An enemy base or other point of interest. Only used in Campaign.
</li><li class="listitem">
<span class="emphasis"><em>Blue pulse</em></span>: A free <a class="link" href="ar01s05.html" title="5. Power">oil resource</a>.
</li></ul></div><div class="itemizedlist" title="Controls"><p class="title"><strong>Controls</strong></p><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="emphasis"><em>Moving the camera</em></span>: Right-click anywhere on the minimap to move the camera.
</li><li class="listitem">
<span class="emphasis"><em>Giving orders</em></span>: If you have units selected, click anywhere on the radar, and
the units will carry out that order.
</li><li class="listitem">
<span class="emphasis"><em>Zooming in and out</em></span>: Hover your mouse over the minimap and move the mouse
wheel up or down.
</li></ul></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s03.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
21 changes: 21 additions & 0 deletions macosx/Resources/WarzoneHelp/ar01s05.html
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>5. Power</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="up" href="index.html" title="Warzone 2100 Quick Start Guide" /><link rel="prev" href="ar01s04.html" title="4. Minimap" /><link rel="next" href="ar01s06.html" title="6. Ordering Units" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ar01s04.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="ar01s06.html">Next</a></td></tr></table><hr /></div><div class="section" title="5. Power"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_power"></a>5. Power</h2></div></div></div><p><span class="inlinemediaobject"><img src="images/powerbar.jpg" alt="images/powerbar.jpg" /></span></p><p><span class="emphasis"><em>The power bar</em></span></p><p><span class="inlinemediaobject"><img src="images/oilresource.jpg" alt="images/oilresource.jpg" /></span></p><p><span class="emphasis"><em>A spare oil resource, and a derrick hard at work</em></span></p><p>In real life, money is power, but in Warzone, power is money. You spend power
to build structures, manufacture units, and research upgrades/new technology.</p><div class="section" title="5.1. Getting Power"><div class="titlepage"><div><div><h3 class="title"><a id="_getting_power"></a>5.1. Getting Power</h3></div></div></div><p>So how do you get power? Power is generated by Oil Derricks. However, you must
have at least one Power Generator for every four Oil Derricks.</p><p>Oil derricks must be built on oil resources, but the generator can be anywhere
on the map. Keep in mind that additional generators beyond one for every four
derricks will provide no benefit. Also note that building heaps of power
generators won’t do anything at all until you have at least one oil derrick for
each.</p></div><div class="section" title="5.2. Pricing"><div class="titlepage"><div><div><h3 class="title"><a id="_pricing"></a>5.2. Pricing</h3></div></div></div><p>Icons in the Manufacture, Build, and Research menus will have yellow bars in
them representing their price:</p><p><span class="inlinemediaobject"><img src="images/cheapweapon.png" alt="images/cheapweapon.png" /></span> <span class="emphasis"><em>Inexpensive weapon</em></span></p><p><span class="inlinemediaobject"><img src="images/expensiveweapon.png" alt="images/expensiveweapon.png" /></span> <span class="emphasis"><em>Expensive weapon</em></span></p><p>When you place your mouse over an icon, the power bar will have a green
section, representing its price. If you cannot afford it, the power bar will
instead turn red.</p><p>The amount of power you have is shown on the very left of the power bar. If you
place your mouse over an icon, if you have enough power to get it, the number
will show the amount of power it will cost. If you can’t afford it, the number
will show the amount of power you need to be able to afford it.</p><p>Power is drawn as soon as the icon is clicked. Providing you have sufficient
power for the activity, the initial progress bar fills quickly with green
(slower with more costly actions) and the construction or research begins. A
yellow progress bar then charts the progress achieved by the current activity.</p></div><div class="section" title="5.3. Upgrades"><div class="titlepage"><div><div><h3 class="title"><a id="_upgrades"></a>5.3. Upgrades</h3></div></div></div><p><span class="inlinemediaobject"><img src="images/powerupgrade.png" alt="images/powerupgrade.png" /></span></p><p>Power Generators can have a Power Module built on top of them to squeeze out
more power. Power Modules need to be researched before you can build them.
There are also several researchable upgrades available which increase the
amount of power you receive.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s04.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="ar01s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>

0 comments on commit 932d452

Please sign in to comment.