DEADSOFTWARE

Added package installation guide to INSTALL. README with complete reference was written.
[flatwaifu.git] / README
1 About
2 =====
4 Doom2D:Rembo is a Linux port of Doom2D game, free DOS two-dimensional arcade created by Russian video game company "Prikol Software" in early 1996 being inspired by original DOOM game by id Software.
6 Authors
7 =======
9 Original Doom2D authors were Aleksey Volynskov, Vladimir Kalinin and Eugeniy Kovtunov. They called themselves as Prikol Software company.
10 Aleksey Volynskov worked under game engine, Vladimir Kalinin created unique sounds. Eugeniy Kovtunov helped them both with graphics. Most of game levels were designed by Vladimir Kalinin, other ones is Aleksey Volynskov's.
12 Over some time boys dropped Doom2D developing. Soon Aleksey Volynskov opened source code and shared it at Gaijin Entertainment site, some remakes were designed and gathered at Doom2D forum.
14 In summer 2011 <ARembo@gmail.com> decided to port Doom2D to Linux and started work under Doom2D:Rembo project at code.google.com. Andriy Shinkarchuck <adriano32.gnu@gmail.com> helped him with documentation and some other things.
16 Installation
17 ============
19 For installation instructions see INSTALL file in source tree.
21 Game modes
22 ==========
24 In Doom2D:Rembo like in original Doom2D you can select to start "One player" or "Two player" new game. When "Two player" selected, you can select "Cooperative" (play like a team) or "Deathmatch" (against each other) game.
26 Configuration
27 =============
29 Doom2D:Rembo like original Doom2D can be configured both with config file and command line parametres.
31 For default config file see /usr/share/doom2d-rembo/default.cfg.
33 Below all acceptable config options and command line parametres are listed.
35 Config options:
37 screenshot=[on|off]
39 Allow to make screenshots by pressing F1 key. You should not use F1 for pl1_* and pl2_* options with this option.
40 Screenshots will be saved to $HOME/.doom2d-rembo directory.
42 sound_volume=<0-128>
44 Specify sounds volume level from 0 to 128.
46 music_volume=<0-128>
48 Specify music volume level from 0 to 128.
50 fullscreen=[on|off]
52 Launch in fullscreen.
54 sky=[on|off]
56 Disable background rendering.
58 gamma=<0-4>
60 Specify brightness.
62 screen_width=<numerical value>
64 Specify launched window width in pixels.
66 screen_height=<numerical value>
68 Specify launched window height in pixels.
70 music_random=[on|off]
72 Enable/Disable random music selection.
74 music_time=<numerical value>
76 Specify each music track duration in minutes.
78 music_fade=<numerical value>
80 Specify fade between music tracks in seconds.
82 pl1_left=<key>
83 pl1_right=<key>
84 pl1_up=<key>
85 pl1_down=<key>
86 pl1_jump=<key>
87 pl1_fire=<key>
88 pl1_next=<key>
89 pl1_prev=<key>
90 pl1_use=<key>
92 pl2_left=<key>
93 pl2_right=<key>
94 pl2_up=<key>
95 pl2_down=<key>
96 pl2_jump=<key>
97 pl2_fire=<key>
98 pl2_next=<key>
99 pl2_prev=<key>
100 pl2_use=<key>
102 Specify first and second players keys respectively for left and right moving,
103 up and down looking, jumping, shooting, weapon change forward and back,
104 switching controls.
106 Avaliable keys for pl1_* and pl2_* config file options are listed below.
108 Single word keys (typed here in lines by groups):
110 backspace tab clear return pause escape space
111 ! " # $ & ' ( ) * + , - . /
112 0 1 2 3 4 5 6 7 8 9
113 : ; < = > ? @ [ \ ] ^ _ `
114 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
115 delete
116 [0] [1] [2] [3] [4] [5] [6] [7] [8] [9] [.] [/] [*] [-] [+]
117 enter equals up down right left insert home end page up page down
118 f1 f2 f3 f4 f5 f6 f7 f8 f9 f10 f11 f12 f13 f14 f15
119 numlock
120 break menu power euro undo compose help
122 Double word keys (it means that following keys consists from two words you should write e.g.
123 `pl1_left=caps lock'
124 without quotes in your custom config):
126 caps lock
127 scroll lock
128 right shift
129 left shift
130 right ctrl
131 left ctrl
132 right alt
133 left alt
134 right meta
135 left meta
136 left super
137 right super
138 alt gr
139 print screen
140 sys req
142 Command line parametres:
144 -file <file.wad>
146 Specify custom .wad or .lmp file.
148 -config <config_file.cfg>
150 Specify custom config file.
152 -warp <numerical value>
154 Specify start card number.
156 -vga
158 Allow to make screenshots by pressing F1 key. You should not use F1 for pl1_* and pl2_* options with this option.
159 Screenshots will be saved to $HOME/.doom2d-rembo directory.
161 -sndvol <numerical value>
163 Specify sounds volume level from 0 to 128.
165 -musvol <numerical value>
167 Specify music volume level from 0 to 128.
169 -fullscr
171 Launch in fullscreen.
173 -window
175 Launch in window mode.
177 -gamma <numerical value>
179 Specify brightness.
181 -width <numerical value>
183 Specify launched window width in pixels.
185 -height <numerical value>
187 Specify launched window height in pixels.
189 -cheat
191 Allow cheats in two player mode.
193 -mon
195 Allow monsters in two player mode "deathmatch".