README

   1 About
   2 =====
   3
   4 Doom2D:Rembo is a Linux port of Doom2D game,
   5 free DOS two-dimensional arcade created by Russian game company "Prikol Software"
   6 in early 1996 being inspired by original DOOM game by id Software.
   7
   8 Authors
   9 =======
  10
  11 Original Doom2D authors were Aleksey Volynskov, Vladimir Kalinin and Eugeniy Kovtunov.
  12 They called themselves as Prikol Software company.
  13 Aleksey Volynskov worked under game engine.
  14 Vladimir Kalinin created unique sounds.
  15 Eugeniy Kovtunov helped them both with graphics.
  16 Most of game levels were designed by Vladimir Kalinin, other ones is Aleksey Volynskov's.
  17
  18 Over some time boys dropped Doom2D developing.
  19 Soon Aleksey Volynskov opened source code and
  20 shared it at Gaijin Entertainment site.
  21 Some remakes were designed and gathered at Doom2D forum.
  22
  23 In summer 2011 <ARembo@gmail.com> decided to port Doom2D to Linux and
  24 started work under Doom2D:Rembo project at code.google.com.
  25 Andriy Shinkarchuck <adriano32.gnu@gmail.com> helped him with documentation and
  26 some other things.
  27
  28 Installation
  29 ============
  30
  31 For installation instructions see INSTALL file in source tree.
  32
  33 Game modes
  34 ==========
  35
  36 In Doom2D:Rembo like in original Doom2D you can select
  37 to start "One player" or "Two player" new game.
  38 When "Two player" selected, you can select "Cooperative" (play like a team) or
  39 "Deathmatch" (against each other) game.
  40
  41 Configuration
  42 =============
  43
  44 Doom2D:Rembo like original Doom2D can be configured both with config file and
  45 command line parametres.
  46
  47 For default config file see /usr/share/doom2d-rembo/default.cfg.
  48
  49 Below all acceptable config options and command line parametres are listed.
  50
  51 Config options:
  52
  53    screenshot=[on|off]
  54
  55       Allow to make screenshots by pressing F1 key. You should not use F1 for pl1_* and
  56       pl2_* options with this option.
  57       Screenshots will be saved to $HOME/.doom2d-rembo directory.
  58
  59    sound_volume=<0-128>
  60
  61       Specify sounds volume level from 0 to 128.
  62
  63    music_volume=<0-128>
  64
  65       Specify music volume level from 0 to 128.
  66
  67    fullscreen=[on|off]
  68
  69       Launch in fullscreen.
  70
  71    sky=[on|off]
  72
  73       Enable background rendering.
  74
  75    gamma=<0-4>
  76
  77       Specify brightness level from 0 to 4.
  78
  79    screen_width=<numerical value>
  80
  81       Specify launched window width in pixels.
  82
  83    screen_height=<numerical value>
  84
  85       Specify launched window height in pixels.
  86
  87    music_random=[on|off]
  88
  89       Enable random music selection.
  90
  91    music_time=<numerical value>
  92
  93       Specify each music track duration in minutes.
  94
  95    music_fade=<numerical value>
  96
  97       Specify fade between music tracks in seconds.
  98
  99    pl1_left=<key>
 100    pl1_right=<key>
 101    pl1_up=<key>
 102    pl1_down=<key>
 103    pl1_jump=<key>
 104    pl1_fire=<key>
 105    pl1_next=<key>
 106    pl1_prev=<key>
 107    pl1_use=<key>
 108
 109    pl2_left=<key>
 110    pl2_right=<key>
 111    pl2_up=<key>
 112    pl2_down=<key>
 113    pl2_jump=<key>
 114    pl2_fire=<key>
 115    pl2_next=<key>
 116    pl2_prev=<key>
 117    pl2_use=<key>
 118
 119       Specify first and second players' keys respectively for left and right moving,
 120       up and down looking, jumping, shooting, weapon change forward and back,
 121       switching controls.
 122
 123    Avaliable keys for pl1_* and pl2_* config file options are listed below.
 124
 125    Single word keys (typed here in lines by groups):
 126
 127       backspace tab clear return pause escape space
 128       ! " # $ & ' ( ) * + , - . /
 129       0 1 2 3 4 5 6 7 8 9
 130       : ; < = > ? @ [ \ ] ^ _ `
 131       a b c d e f g h i j k l m n o p q r s t u v w x y z
 132       delete
 133       [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] [.] [/] [*] [-] [+]
 134       enter equals up down right left insert home end page up page down
 135       f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12 f13 f14 f15
 136       numlock
 137       break menu power euro undo compose help
 138
 139    Double word keys (it means that following keys consists of two words and
 140    you should write e.g.
 141    `pl1_left=caps lock'
 142    without quotes in your custom config):
 143
 144       caps lock
 145       scroll lock
 146       right shift
 147       left shift
 148       right ctrl
 149       left ctrl
 150       right alt
 151       left alt
 152       right meta
 153       left meta
 154       left super
 155       right super
 156       alt gr
 157       print screen
 158       sys req
 159
 160 Command line parametres:
 161
 162    -file <file.wad>
 163
 164       Specify custom .wad or .lmp file.
 165
 166    -config <config_file.cfg>
 167
 168       Specify custom config file.
 169
 170    -warp <numerical value>
 171
 172       Specify start map number.
 173
 174    -vga
 175
 176       Allow to make screenshots by pressing F1 key. You should not use F1 for pl1_* and
 177       pl2_* options with this option.
 178       Screenshots will be saved to $HOME/.doom2d-rembo directory.
 179
 180    -sndvol <0-128>
 181
 182       Specify sounds volume level from 0 to 128.
 183
 184    -musvol <0-128>
 185
 186       Specify music volume level from 0 to 128.
 187
 188    -fullscr
 189
 190       Launch in fullscreen.
 191
 192    -window
 193
 194       Launch in window mode.
 195
 196    -gamma <0-4>
 197
 198       Specify brightness level from 0 to 4.
 199
 200    -width <numerical value>
 201
 202       Specify launched window width in pixels.
 203
 204    -height <numerical value>
 205
 206       Specify launched window height in pixels.
 207
 208    -cheat
 209
 210       Allow cheats in two player mode.
 211
 212    -mon
 213
 214       Allow monsters in two player mode "Deathmatch".