wersja polska | English version | Version française
On-line version

Copyright © 2007 Tomasz Kaźmierczak

This documentation is distributed under the terms of the GNU Free Documentation Licence. Either version 1.2 of the license, or (at your option) any later version. See the GNU FDL for details.


Cytadela

Version 0.7

project homepage



Copyright © 2003-2007 Tomasz Kaźmierczak
Copyright © 2006 Kamil Pawłowski

Cytadela is distributed under the terms of the GNU General Public License (GNU GPL); either version 3 of the License, or (at your option) any later version. Cytadela comes with ABSOLUTELY NO WARRANTY. See the COPYING for details.

Cytadela is a conversion of an Amiga game also called Cytadela, created by Virtual Design. The conversion contains an implementation of several algorithms taken from the original. Major part of graphics, all music, sounds and levels are taken from the original, but in some cases they are processed and/or modified in order to make them easier to use with the conversion and to correct some bugs.

All the algorithms and artwork were taken from the original with permission from their authors. Distribution of the artwork (as a part of the conversion) is allowed under terms of the GNU GPL.

Table of contents


1. System requirements

1.1 Software requirements
The Citadel uses OpenGL, GLU, SDL and SDL_mixer. The minimum required versions of the libraries are:

  1. SDL: 1.2.11
  2. SDL_mixer: 1.2.6
  3. OpenGL: the best is to have 1.4 or newer; if your OpenGL driver is in earlier version then the folowing extensions are required:
    • 1.0 and 1.1 - you can't run the Citadel with this version of OpenGL!
    • 1.2 - GL_ARB_multitexture, GL_ARB_texture_env_add, GL_ARB_texture_env_combine, GL_ARB_texture_border_clamp, GL_ARB_texture_mirrored_repeat
    • 1.3 - GL_ARB_texture_mirrored_repeat
  4. GLU: 1.1

You should have all the libraries installed in your system in order to run the game.

If you are unsure about the OpenGL version that your graphics card's driver supports you can check it after compiling the Citadel - at startup the program checks for the GL version and displays an information about it.

1.2 Hardware requirements

1.3 Known problems


2. Compiling and running

2.1 Under POSIX systems (GNU/*, *NIX, *BSD, etc.)

2.1.1 Compiling
To compile the sources you need the following:

In console run:

#./configure
#make
#make install (as root)

For configure options type:
#./configure --help

For more information see the INSTALL file in the archive's top-level directory.

2.1.2 Running
To run the Citadel just type:

#cytadela

or if you used an installation system that created some link in your graphical user interface, you can also run the Citadel using the link.

2.2 Under Windows:

2.2.1 Compiling
In the main directory of the source tree there are also Dev-C++ project files created by Dev-C++ 5 beta. Just open the project and build it.
You will need SDL and SDL_mixer devpacks installed. OpenGL and GLU devpacks are included in the Dev-C++ 5 beta.

You can also compile using some other IDE. In such case create a project in your IDE, add the source files to the project and add SDL, SDL_mixer, OpenGL and GLU libraries in the linker options. If you don't know how to do it, read your IDE's documentation.

2.2.2 Running
There is no installation system for the Citadel so just run the cytadela.exe from the explorer window.


3. Controllers

3.1 In menu
Keyboard:

Mouse: move the mouse to change the cursor position; click the first or the second mouse button to select the position.

Joystick: move to change the cursor position; press the first button to select the position.

3.2 In game
Keyboard:

Mouse: move the mouse to turn left or right; click the first (left) mouse button to move forwards; click the second (right) mouse button to use selected weapon/item.

Joystick: move the joystick to move forwards, move backwards, turn left, turn right; press the first button to use selected weapon/item.


4. Menu

After running the game a startup screen is displayed. You can wait till it disappears after few seconds or turn it off yourself - just click a mouse button, a joystick button or press enter on the keyboard.
After the startup screen a menu appears. In main menu you can choose the following:


5. The aim and the gameplay

5.1 The aim
The aim of the game is to destroy the Citadel. You must find six parts of a bomb with which you will blow the Citadel up. The bomb parts are placed in six complexes: Sewers, Laboratories, Power station, Stores, Hangar and Prison. There are two additional levels - Basement which is the entrance to the Citadel, and Command Center where the bomb should be planted.
The Basement is divided into two levels. The Command Center consists of just one level. All the other complexes are divided into three levels, and the bomb parts are placed in the third level of each complex. Before leaving a complex you have to make sure that you've taken a bomb part, because you can't go back to the allready penetrated complex.
Only when you have collected all the bomb parts you have access to the Command Center.

5.2 OSD elements
During the gameplay, at the bottom of the screen you can see an OSD panel which shows some useful information. Beginning from the left, the OSD panel contains:

At the same bottom of the screen there is a window showing some scrolled messages.

5.3 Weapons and items
Weapons:

The weapons are accessible after finding them. After some time every weapon gets damaged and you have to find another one for it's place. The damaged weapon is automatically thrown away after finding a new one or when you select another item you posess (either another weapon, ID card or hand). Weapons come with out ammunition - it has to be found separately.

Other items that can be found: Collecting items is as simple as passing near to them.

5.4 The map
After pressing the TAB key a map will be displayed, which is beeing drawn while you walk through the Citadel. Only the locations you walked through and the nearest ones to them are visible. On the map you can see walls, doors and objects that block your way.

5.5 Saving and loading
TBD

5.6 Enemies and fighting
TBD