manual: Add more crosslinking between sections.

Also some slight rewording.
This commit is contained in:
Simon Howard 2019-08-18 22:47:41 +01:00
parent 6a1db18e9d
commit 04f60ee64e

View file

@ -31,6 +31,7 @@ following:
TODO: Add a section on `freedoom1.wad` vs `freedoom2.wad` TODO: Add a section on `freedoom1.wad` vs `freedoom2.wad`
[[menus]]
== Using the Freedoom Menus == Using the Freedoom Menus
Freedoom's menus are fairly self-explanatory but here are some brief Freedoom's menus are fairly self-explanatory but here are some brief
@ -41,18 +42,19 @@ image::images/menu-mainmenu.png[Freedoom Main Menu,align="center",width=380,pdfw
[cols="1,4",width="90%",align="center",valign="middle"] [cols="1,4",width="90%",align="center",valign="middle"]
|========================== |==========================
| **New game** | Start a new game, abandoning the current game (if you're | <<newgame,**New game**>> | Start a new game, abandoning the current game (if you're
already playing). already playing).
| **Options** | Brings up the options menu. The appearance of this menu | **Options** | Brings up the options menu. The appearance of this menu
and the available options depend upon the source port you're using. and the available options depend upon the source port you're using.
| **Load Game** | Load a saved game. | <<savegame,**Load Game**>> | Load a saved game.
| **Save Game** | Save your current game, so that you can continue playing | <<savegame,**Save Game**>> | Save your current game, so that you can continue playing
later. later.
| **Read This!** | Brings up a help screen showing a description of the | **Read This!** | Brings up a help screen showing a description of the
items you'll encounter in the game. items you'll encounter in the game.
| **Quit Game** | Finish playing and return to the operating system. | **Quit Game** | Finish playing and return to the operating system.
|========================== |==========================
[[newgame]]
=== Starting a new game === Starting a new game
To start a new game, press _Esc_ to bring up the main menu, and choose To start a new game, press _Esc_ to bring up the main menu, and choose
@ -89,6 +91,7 @@ _Extreme Carnage_ except that monster attacks are up to twice as fast,
and killed monsters come back to life after around 40 seconds. and killed monsters come back to life after around 40 seconds.
|========================== |==========================
[[savegame]]
=== Loading and saving the game === Loading and saving the game
It is a good idea to save the game regularly -- for example, at the start It is a good idea to save the game regularly -- for example, at the start
@ -131,18 +134,18 @@ accessing common menu functions.
[cols="1,2,8",width="90%",align="center",valign="middle"] [cols="1,2,8",width="90%",align="center",valign="middle"]
|========================== |==========================
| **Esc** | Menu | Bring up the main menu. | **Esc** | <<menus,Menu>> | Bring up the main menu.
| **F1** | Help | Bring up the help screen that shows information about the | **F1** | Help | Bring up the help screen that shows information about the
in-game items. in-game items.
| **F2** | Save | Bring up the _Save Game_ menu. | **F2** | <<savegames,Save>> | Bring up the _Save Game_ menu.
| **F3** | Load | Bring up the _Load Game_ menu. | **F3** | <<savegames,Load>> | Bring up the _Load Game_ menu.
| **F4** | Volume | Bring up a menu to control volume levels. | **F4** | Volume | Bring up a menu to control volume levels.
| **F6** | Quicksave | Save the game to your _quicksave_ slot, which saves | **F6** | <<savegames,Quicksave>> | Save the game to your _quicksave_ slot,
time if you're repeatedly saving your progress while you play. which saves time if you're repeatedly saving your progress while you play.
| **F7** | End Game | End the current game and return to the title screen. | **F7** | End Game | End the current game and return to the title screen.
| **F8** | Messages | Toggles between showing or hiding the on-screen | **F8** | Messages | Toggles between showing or hiding the on-screen
messages shown when you collect an item. messages shown when you collect an item.
| **F9** | Quickload | Load the game from your _quicksave_ slot. | **F9** | <<savegames,Quickload>> | Load the game from your _quicksave_ slot.
| **F10** | Quit Game | Quit the game and return to the operating system. | **F10** | Quit Game | Quit the game and return to the operating system.
| **F11** | Brightness | Toggle the on-screen brightness level. | **F11** | Brightness | Toggle the on-screen brightness level.
|========================== |==========================
@ -160,7 +163,7 @@ find a switch to open a locked door. This gives a puzzle element to the game in
addition to the action. addition to the action.
By default, the keyboard cursor keys will move forward and backward, and turn By default, the keyboard cursor keys will move forward and backward, and turn
left and right. The "control" key fires the current weapon, and the spacebar left and right. The _Control_ key fires the current weapon, and the spacebar
will open doors and activate switches. All source ports allow you to rebind will open doors and activate switches. All source ports allow you to rebind
these keys to a setup that you find more comfortable. You'll also want to look these keys to a setup that you find more comfortable. You'll also want to look
into using the strafe (sidestep) and run keys to better control over your into using the strafe (sidestep) and run keys to better control over your
@ -174,13 +177,14 @@ the first level do not present much of a challenge and they're a good
opportunity to practice taking shots at. opportunity to practice taking shots at.
Within the game you'll encounter various collectible items and power-ups. Within the game you'll encounter various collectible items and power-ups.
These will typically give you more ammunition for your weapons, more health or These will typically give you more <<ammo,ammunition>> for your weapons, more
more armor. You can also find new weapons and some rarer power-ups which give <<health,health>> or more <<armor,armor>>. You can also find <<weapons,new
you special abilities. Picking something up is a simple matter of walking over weapons>> and some <<specialitems,rarer power-ups>> which give you special
it - an on-screen message and a brief flash of the screen indicate that you've abilities. Picking something up is a simple matter of walking over it - an
done so successfully. If you don't pick it up, it's likely you don't need it on-screen message and a brief flash of the screen indicate that you've done so
right now (for example, you can't pick up a health pack when you already have successfully. If you don't pick it up, it's likely you don't need it right
100% health). now (for example, you can't pick up a health pack when you already have 100%
health).
=== The Status Bar === The Status Bar
@ -191,7 +195,8 @@ image::images/status-bar.png[Freedoom Status Bar,width="640",pdfwidth="70vw",ali
[cols="1,6",width="90%",align="center",valign="middle"] [cols="1,6",width="90%",align="center",valign="middle"]
|========================== |==========================
| **Ammo** | Number of units of ammunition remaining for the current weapon. | **Ammo** | Number of units of <<ammo,ammunition>> remaining for the current
weapon.
| **Health** | If this reaches zero, you're dead! See the | **Health** | If this reaches zero, you're dead! See the
<<health,health section>> for power-ups you can find to replenish your health. <<health,health section>> for power-ups you can find to replenish your health.
| **Arms** | Which weapons you've found so far. Check out the | **Arms** | Which weapons you've found so far. Check out the
@ -199,14 +204,16 @@ image::images/status-bar.png[Freedoom Status Bar,width="640",pdfwidth="70vw",ali
| **Freedoomguy** | A quick visual indication of how your health is. | **Freedoomguy** | A quick visual indication of how your health is.
| **Armor** | The more armor you have, the less your health will suffer if | **Armor** | The more armor you have, the less your health will suffer if
you're injured. See the <<armor,armor section>> for more information. you're injured. See the <<armor,armor section>> for more information.
| **Ammo counts** | How much you're carrying of each of the four types of | **Ammo counts** | How much you're carrying of each of the <<ammo,four types of
ammunition, along with the maximum of each you can carry. ammunition>>, along with the maximum of each you can carry.
|========================== |==========================
[[weapons]] [[weapons]]
=== Freedoom's Weapons === Freedoom's Weapons
You'll encounter a number of weapons within the game: You start the game with only a handgun, 50 bullets and your fists to fall back
on once they run out. You'll want to find yourself some better weaponry as
soon as possible.
[options="header",cols="4,1,7,3,2",valign="middle"] [options="header",cols="4,1,7,3,2",valign="middle"]
|========================== |==========================
@ -253,6 +260,7 @@ has been picked up!). Apart from the melee weapons, each weapon consumes a
certain type of ammo, and you should be careful to look out for more ammo as certain type of ammo, and you should be careful to look out for more ammo as
you're exploring. you're exploring.
[[ammo]]
[options="header",cols="2,1,1",width="50%",align="center",valign="middle"] [options="header",cols="2,1,1",width="50%",align="center",valign="middle"]
|========================== |==========================
| Ammo type | Small | Large | Ammo type | Small | Large
@ -279,7 +287,7 @@ and doubles the maximum amount of ammo you can carry.
[[health]] [[health]]
=== Health === Health
You die if your health reaches 0%. You'll find health bonuses hidden around the You die if your health reaches 0%. You'll find health bonuses around the
levels which can restore you back to 100% health; 1% health bonuses can take levels which can restore you back to 100% health; 1% health bonuses can take
you over 100% and up to 200% health. you over 100% and up to 200% health.
@ -314,6 +322,7 @@ The heavy armor vest has slightly different behavior: in addition to being
worth 200% armor, it also absorbs half of all damage. For this reason, it's worth 200% armor, it also absorbs half of all damage. For this reason, it's
a very good idea to get your hands on a heavy armor vest if you can locate one. a very good idea to get your hands on a heavy armor vest if you can locate one.
[[specialitems]]
=== Special Items === Special Items
You may also encounter any one of these special items while exploring: You may also encounter any one of these special items while exploring:
@ -358,9 +367,9 @@ Makes you immune to all damage for a limited time.
=== Enemies === Enemies
The levels are filled with monsters intent on stopping you from completing your The levels are filled with monsters who have no other goal apart from stopping
mission. Here's a selection of some of these monsters you can expect to you from completing your mission. Here's a selection of some of these monsters
encounter. who you can expect to encounter.
[frame="none",cols="2,6,2",valign="middle",grid="none",align="center",width="90%"] [frame="none",cols="2,6,2",valign="middle",grid="none",align="center",width="90%"]
|========================== |==========================
@ -452,7 +461,7 @@ Areas of the map are usually color coded as follows:
| **Yellow** | Changes in ceiling height, including doors. | **Yellow** | Changes in ceiling height, including doors.
| **Brown** | Changes in floor height (eg. steps) | **Brown** | Changes in floor height (eg. steps)
| **Grey** | Undiscovered areas (not normally shown, but may be revealed | **Grey** | Undiscovered areas (not normally shown, but may be revealed
if the _Tactical Survey Map_ item is discovered). if the <<specialitems,Tactical Survey Map>> item is discovered).
|========================== |==========================
While using the map, the game continues as normal, so it is wise to find a While using the map, the game continues as normal, so it is wise to find a
@ -491,8 +500,8 @@ image:images/hazard-barrels.png[Barrels,150,150]
| **Damaging Floors** | | **Damaging Floors** |
Red-hot lava and radioactive sludge are just two of the types of damaging floor Red-hot lava and radioactive sludge are just two of the types of damaging floor
you can encounter in Freedoom's levels. If walking over it is necessary, try to you can encounter in Freedoom's levels. If walking over it is necessary, try to
find yourself a hazard suit, but be aware that it will only protect you for find yourself a <<specialitems,hazard suit>>, but be aware that it will only
a limited time. | protect you for a limited time. |
image:images/hazard-slime.png[Radioactive slime,150,150] image:images/hazard-slime.png[Radioactive slime,150,150]
| **Crushing Ceilings** | | **Crushing Ceilings** |
Many of the levels have been rigged with traps and this is just one of them. Many of the levels have been rigged with traps and this is just one of them.
@ -541,14 +550,18 @@ suggestions:
[[wads]] [[wads]]
== Playing with fan-made WADs and mods == == Playing with fan-made WADs and mods ==
TODO: Add this section. TODO: Write this section.
== Contributing to Freedoom ==
TODO: Write this section.
[[reusing]] [[reusing]]
== Reusing portions of Freedoom == == Reusing portions of Freedoom ==
TODO: Add some instructions. TODO: Write this section.
== Cheats == == Cheats ==
TODO: Document cheats. TODO: Write this section.