Start of manual updates for v0.4.

This commit is contained in:
Steve 2015-12-03 22:50:15 +00:00
parent 2bca049973
commit 7b366537be
7 changed files with 134 additions and 60 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 573 KiB

After

Width:  |  Height:  |  Size: 594 KiB

View File

@ -7,10 +7,10 @@ h3 {background-color:#47c; padding:0.25em; color:#fff; margin-top:3em; border: 1
h4 {background-color:#5ad; padding:0.25em; color:#fff; margin-top:3em; width: 50%; color:#000; border: 1px solid #fff;} h4 {background-color:#5ad; padding:0.25em; color:#fff; margin-top:3em; width: 50%; color:#000; border: 1px solid #fff;}
a {color: #0af; text-decoration: none;} a {color: #0af; text-decoration: none;}
a:hover {color: #0af; text-decoration: underline;} a:hover {color: #0af; text-decoration: underline;}
table.controls {border:1px solid #fff; padding: 0.5em; width:30em;} table.controls {border:1px solid #fff; padding: 0.5em; width:40em;}
table.controls td:first-child {width: 50%; color:#8cf;} table.controls td:first-child {width: 50%; color:#8cf;}
table.controls td:nth-child(2) {font-weight: bold;} table.controls td:nth-child(2) {font-weight: bold;}
img.screenshot {border: 1px #ccc solid; padding: 10px; width:800px;} img.screenshot {border: 1px #ccc solid; padding: 5px; width:800px; background-color:#000}
div.annotation {font-size: 12px; position:absolute; background-color:#08f; color:#fff; padding:3px; font-weight:bold; border:2px #fff solid; border-radius: 5px; text-align:center} div.annotation {font-size: 12px; position:absolute; background-color:#08f; color:#fff; padding:3px; font-weight:bold; border:2px #fff solid; border-radius: 5px; text-align:center}
span.highlight {font-weight:bold; color: #0bf;} span.highlight {font-weight:bold; color: #0bf;}
</style> </style>
@ -31,7 +31,7 @@ Table of Contents
</p> </p>
</div> </div>
<h3>Introduction</h3> <h3 class="section">Introduction</h3>
<p> <p>
The Battle for the Solar System - The Pandoran War is a 2D space shooter, based on the space opera novels by <a href="http://www.twitter.com/stephenjsweeney">Stephen J Sweeney</a>. This game is set during the seven year period between <a href="http://www.battleforthesolarsystem.com/books/thirdside/">THE THIRD SIDE</a> and <a href="http://www.battleforthesolarsystem.com/books/attribute/">THE ATTRIBUTE OF THE STRONG</a>, the second and third novels in the trilogy, respectively. The Battle for the Solar System - The Pandoran War is a 2D space shooter, based on the space opera novels by <a href="http://www.twitter.com/stephenjsweeney">Stephen J Sweeney</a>. This game is set during the seven year period between <a href="http://www.battleforthesolarsystem.com/books/thirdside/">THE THIRD SIDE</a> and <a href="http://www.battleforthesolarsystem.com/books/attribute/">THE ATTRIBUTE OF THE STRONG</a>, the second and third novels in the trilogy, respectively.
</p> </p>
@ -45,6 +45,9 @@ Note: this game is still under heavy development and will feature bugs, incomple
<p> <p>
Before plunging in to the game proper and tackling the missions, it is recommended that you take time to become comfortable with the game mechanics. Upon starting a new game, you will be presented with the galactic map, with <span class="highlight">Sol</span> being the selected star system. New players should take their time to work through the missions here, to ease themselves in to the game. Here, you engage in a free flight, to get used to the controls, face off against unarmed and weak opponents, and get to grips with the objective system. Before plunging in to the game proper and tackling the missions, it is recommended that you take time to become comfortable with the game mechanics. Upon starting a new game, you will be presented with the galactic map, with <span class="highlight">Sol</span> being the selected star system. New players should take their time to work through the missions here, to ease themselves in to the game. Here, you engage in a free flight, to get used to the controls, face off against unarmed and weak opponents, and get to grips with the objective system.
</p> </p>
<p>
Note that the primary control scheme for the game is mouse and keyboard. It is not recommended you attempt to play this game using a trackpad.
</p>
<h3>Title Screen</h3> <h3>Title Screen</h3>
<p> <p>
@ -60,108 +63,172 @@ This is the first screen that you will see upon starting the game. You may selec
<h3>Galactic Map</h3> <h3>Galactic Map</h3>
<p> <p>
This is the main mission select screen. Here, you can move around and select star systems in which to undertake missions. Star Systems that have missions will emit red circles at regular intervals. Yellow circles will be emitted by star systems that have no active missions, but still have challenges that can be attempted. Green circles will emit from system that have missions and challenges that are 100% completed. You may replay any of these missions, at any time. This is the main mission select screen. Here, you can move around and select star systems in which to undertake missions. Star Systems that have missions will emit red circles at regular intervals. Red arrows will also point in the direction of star systems that have missions, but are currently offscreen.
</p>
<p>
You can scroll around the galactic map by moving the mouse cursor away from the center of the screen. To stop scrolling, simply move the cursor back towards the middle. To access missions, simply click on a star system that is emitting red pulses.
</p> </p>
<div style='position:relative'> <div style='position:relative'>
<div class="annotation" style="left:65px; top:65px;">1</div> <div class="annotation" style="left:65px; top:65px;">1</div>
<div class="annotation" style="left:345px; top:35px;">2</div> <div class="annotation" style="left:400px; top:35px;">2</div>
<div class="annotation" style="left:475px; top:35px;">3</div> <div class="annotation" style="left:225px; top:125px;">3</div>
<div class="annotation" style="left:465px; top:170px;">4</div> <div class="annotation" style="left:550px; top:135px;">4</div>
<div class="annotation" style="left:365px; top:250px;">5</div> <div class="annotation" style="left:430px; top:235px;">5</div>
<div class="annotation" style="left:535px; top:435px;">6</div>
</div> </div>
<img src="galaxy.png" class="screenshot"> <img src="galaxy.png" class="screenshot">
<ol> <ol>
<li>Mission indicator arrow - points in the direction of star systems with missions that are currently off screen.</li> <li>Mission indicator arrow - points in the direction of star systems with missions that are currently off screen.</li>
<li>Number of completed and total missions.</li> <li>Number of completed and total missions.</li>
<li>Number of completed and total challenges.</li> <li>A star system:
<li>A star system.
<ol> <ol>
<li>Blue: CSN star system.</li> <li>Blue: CSN star system.</li>
<li>White: Independent star system.</li> <li>White: Independent star system.</li>
<li>Red: Pandoran-occupied star system.</li> <li>Red: Pandoran-occupied star system.</li>
</ol> </ol>
</li> </li>
<li>System select reticle.</li> <li>A star system with missions available.</li>
<li>Star system detail - shows details of the currently selected system.</li> <li>Mouse cursor.</li>
</ol> </ol>
<h4>Controls</h4> <h4>Controls</h4>
<table class="controls"> <table class="controls">
<tr><td>Arrow keys</td><td>Scroll galactic map</td></tr> <tr><td>Mouse cursor</td><td>Scroll galactic map</td></tr>
<tr><td>Return</td><td>Select Star System</td></tr> <tr><td>Left mouse button</td><td>Select highlighted star system</td></tr>
<tr><td>Escape</td><td>Menu</td></tr> <tr><td>Escape</td><td>Menu</td></tr>
</table> </table>
<h3>Star Systems</h3> <h3>Star Systems</h3>
<p> <p>
The Star System view shows a list of missions available for that star system. Missions must be played sequentially, with the next available mission being highlighted in yellow. The right-hand side of the star system view displays an overview of the mission, including the class of craft the player will be piloting, and the name of the pilot and their squadron. The Star System view shows a list of missions available for that star system. In many cases, missions are unlocked as the related or previous missions are completed. The right-hand side of the star system view displays an overview of the mission, including the class of craft the player will be piloting, and the name of the pilot (if applicable), and the squadron to which they belong. To play a mission, highlight it, and then click on "Start Mission".
</p> </p>
<div style='position:relative'> <div style='position:relative'>
<div class="annotation" style="left:465px; top:55px;">1</div> <div class="annotation" style="left:465px; top:55px;">1</div>
<div class="annotation" style="left:195px; top:355px;">2</div> <div class="annotation" style="left:240px; top:105px;">2</div>
<div class="annotation" style="left:240px; top:105px;">3</div> <div class="annotation" style="left:195px; top:355px;">3</div>
<div class="annotation" style="left:530px; top:215px;">4</div> <div class="annotation" style="left:530px; top:235px;">4</div>
</div> </div>
<img src="starsystem.png" class="screenshot"> <img src="starSystem.png" class="screenshot">
<ol> <ol>
<li>Star system name, and completed / total missions.</li> <li>Star system name.</li>
<li>Available mission list.</li> <li>
<li>Mission name (White: complete, Yellow: incomplete).</li> Available mission list.
<ol>Yellow: missions not completed.</ol>
<ol>White: missions completed.</ol>
</li>
<li>Start Mission button.</li>
<li>Mission detail.</li> <li>Mission detail.</li>
</ol> </ol>
<h4>Controls</h4> <h4>Controls</h4>
<table class="controls"> <table class="controls">
<tr><td>Arrow keys</td><td>Scroll galactic map</td></tr> <tr><td>Left mouse button</td><td>Select mission / start mission</td></tr>
<tr><td>Return</td><td>Select Star System</td></tr> <tr><td>Escape</td><td>Return to galactic map</td></tr>
<tr><td>Escape</td><td>Menu</td></tr>
</table> </table>
<h3>Missions</h3> <h3>Missions</h3>
<p> <p>
Each mission has various objectives that the player must finish in order to complete the mission successfully. The mission ends when the player either successfully completes all the objectives, or is killed. Note: there is no friendly fire between those on the same side (in other words, you need not worry about firing upon your team mates, or them hitting you - no damage will be taken). Each mission has various objectives that the player must finish in order to complete the mission successfully. The mission ends when the player either successfully completes all the objectives, or is killed (and is not in an Epic mission). Note: there is no friendly fire between those on the same side (in other words, you need not worry about firing upon your team mates, or them hitting you - no damage will be taken).
</p>
<p>
Mission objectives can be viewed at any time during play by pressing Tab. Objectives will need not be completed in order. It is also possible for an objective (and subsequently the entire mission) to be failed if they are not met: for example, failing to prevent the escape of a target, or the destruction of a vessel the player was charged with protecting.
</p>
<p>
The player controls their craft by using the mouse. The fighter will orientate itself in the direction of the mouse cursor. Pressing the right mouse button will cause the craft to accelerate in the direction it is facing. Note that it is possible to turn and face a direction, while retaining the present course. As such, the player is able to strafe. To brake, press S on the keyboard.
</p>
<p>
To fire the craft's guns (should it be equipped with some), press the left mouse button. The craft will fire in the direction of the mouse pointer. Missiles can be fired by pressing the middle button of the mouse. Unlike standard guns, missiles are limited, and also require a target to be fired at (see Combat for more information).
</p>
<p>
From time to time, message boxes will appear. These will carry important communication messages, progress updates, and chatter from your fellow pilots, regarding recent events. They're all worth paying attention to.
</p>
<p>
The
</p> </p>
<div style='position:relative'> <div style='position:relative'>
<div class="annotation" style="left:185px; top:10px;">1</div> <div class="annotation" style="left:430px; top:245px;">1</div>
<div class="annotation" style="left:25px; top:60px;">2</div> <div class="annotation" style="left:350px; top:175px;">2</div>
<div class="annotation" style="left:125px; top:60px;">3</div> <div class="annotation" style="left:185px; top:10px;">3</div>
<div class="annotation" style="left:615px; top:15px;">4</div> <div class="annotation" style="left:25px; top:70px;">4</div>
<div class="annotation" style="left:755px; top:65px;">5</div> <div class="annotation" style="left:125px; top:70px;">5</div>
<div class="annotation" style="left:25px; top:385px;">6</div> <div class="annotation" style="left:500px; top:95px;">6</div>
<div class="annotation" style="left:705px; top:385px;">7</div>
<div class="annotation" style="left:270px; top:35px;">8</div>
<div class="annotation" style="left:400px; top:35px;">9</div>
<div class="annotation" style="left:530px; top:35px;">10</div>
<div class="annotation" style="left:430px; top:245px;">11</div>
<div class="annotation" style="left:400px; top:405px;">12</div>
</div> </div>
<img src="mission.png" class="screenshot"> <img src="mission1.png" class="screenshot">
<ol> <ol>
<li>Player armour and shield.</li> <li>Player craft.</li>
<li>Mouse pointer.</li>
<li>
Player attributes:
<ol>Green: Armour</ol>
<ol>Blue: Shield</ol>
<ol>Purple: Boost</ol>
<ol>Orange: ECM</ol>
</li>
<li>Selected weapon.</li> <li>Selected weapon.</li>
<li>Number of missiles.</li> <li>Number of missiles.</li>
<li>Target armour and shield.</li> <li>Message box.</li>
<li>Distances to target and mission objectives.</li>
<li>Messages.</li>
<li>Radar</li>
<ol>
<li>Green: friendly unit.</li>
<li>Yellow: current target.</li>
<li>Red: enemy unit.</li>
<li>White: mission target.</li>
</ol> </ol>
<h3>Combat</h3>
<p>
It is rare for missions not to involve any combat. The player will automatically lock on to the closest enemy to them, switching to a new target if the current one is destroyed. The player can also press A to cycle targets.
</p>
<p>
A red box will appear around the current target, and an arrow around the player's craft will point in the target's direction. The name of the target and its distance from the player will also be displayed in the upper right of the screen. Targets can be destroyed by shooting them with your guns, or by firing missiles at them.
</p>
<h4>Shields</h4>
<p>
Most fighters, including the player's, are equipped with an energy shield. Unlike armour, this shield will recharge over time, and must be depleted entirely before the armour takes damage. Be aware that shields are extremely vulnerable to lasers. If a shield is hit by a laser blast and is depleted completely, it won't begin to recharge for 10 seconds, leaving the craft unable to rely on them for added protection.
</p>
<h4>Missiles</h4>
<p>
Missiles are fast, and chase after their targets for quite some time, finally causing a tremendous amount of damage on impact. A missile can only be fired if the player has missiles remaining, and the target is within range. When their route is clear, missiles rarely fail to hit their target, which can be very troublesome for the player if one is loosed against them. The player can instantly destroy any incoming missiles by using their ECM (activated by pressing D). The ECM must recharge whenever it is used (a duration lasting several seconds), and therefore should only be used when it is needed.
</p>
<h4>Boost</h4>
<p>
Unlike the AI craft in the game, the player has the ability to Boost (unrestricted by craft type). Boosting provides a temporary sudden burst of speed, lasting less than one second. It is highly useful for escaping dangerous situations, and, on occassion, outrunning a missile for long enough to allow the ECM to recharge. Once used, the Boost must spend several seconds recharging.
</p>
<div style='position:relative'>
<div class="annotation" style="left:400px; top:185px;">1</div>
<div class="annotation" style="left:175px; top:360px;">2</div>
<div class="annotation" style="left:775px; top:50px;">3</div>
<div class="annotation" style="left:15px; top:395px;">4</div>
<div class="annotation" style="left:705px; top:355px;">5</div>
<div class="annotation" style="left:660px; top:425px;">6</div>
<div class="annotation" style="left:290px; top:5px;">7</div>
<div class="annotation" style="left:430px; top:5px;">8</div>
<div class="annotation" style="left:570px; top:5px;">9</div>
</div>
<img src="mission2.png" class="screenshot">
<ol>
<li>Player target indicator:</li>
<li>Player target:</li>
<li>Target detail:</li>
<li>Battle messages</li>
<li>Radar:</li>
<ol>Green: friendly unit.</ol>
<ol>Yellow: current target.</ol>
<ol>Red: enemy unit.</ol>
<ol>White: mission target.</ol>
<li>Radar zoom amount.</li>
<li>Number of allied craft.</li> <li>Number of allied craft.</li>
<li>Number of complete / total objectives.</li> <li>Number of complete / total objectives.</li>
<li>Number of opposing craft.</li> <li>Number of opposing craft.</li>
<li>Player</li>
<ol>
<li>Red arrow: points in direction of current target.</li>
<li>Green arrow: points in direction of mission objective.</li>
</ol>
<li>Current target (boxed in red).</li>
</ol> </ol>
<h4>Controls</h4> <h4>Controls</h4>
@ -266,15 +333,22 @@ See the LICENSE and README.md files that came with this game for information on
<script> <script>
var toc = $('#toc'); var toc = $('#toc');
$('h3').each(function(i, e) { $('h3,h4').each(function(i, e) {
var link = 'link' + i; var link = 'link' + i;
var a = $('<a>').attr('href', '#' + link).append(e.innerText); var a = $('<a>').attr('href', '#' + link).append(e.innerText);
$(e).before($('<a>').attr('name', link)); $(e).before($('<a>').attr('name', link));
li = $('<li>').append(a); if (e.tagName == 'H3')
toc.append(li); {
toc.append("<a href=''>" + + "</a>");
}
if (e.tagName == 'H4')
{
toc.append("Hello");
}
}); });
</script> </script>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 547 KiB

BIN
manual/mission1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 418 KiB

BIN
manual/mission2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 468 KiB

BIN
manual/starSystem.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 407 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 398 KiB