README
1 ------------------------
2| Bomns for Linux README |
3 ------------------------
4
5
6
7System Requirements
8-------------------
9- SDL - get the latest version at www.libsdl.org
10- SDL_mixer - get the latest version at www.libsdl.org/projects/SDL_mixer/
11- GTK - you'll need GTK2 for the newest launcher, although there is a GTK
12 1.2.x version of the launcher you can use
13- The header files for those libraries
14
15
16
17Installation
18------------
19Bomns for Linux uses CMake as its build system. You can read the INSTALL
20file for details, but the installation basically boils down to:
21
22 mkdir -p build
23 cd build
24 cmake ..
25 make
26 sudo make install
27
28This, by default, will build and install "bomns" (the main game), "bomnsedit"
29(the level editor), and "bomnslauncher" (the GTK2 game launcher). At some
30point you will be able to configure what is and isn't built -- but not yet!
31(Unless you know your way around CMake.)
32
33
34
35Playing Bomns for Linux
36-----------------------
37The gameplay of Bomns for Linux is quite simple: just move around the level,
38picking up powerups and avoiding powerdowns, all the while laying bomns and
39plotting your opponent's desctruction. A bomn will do 5 damage to the other
40player, and running into them will do 1 damage. The first to kill their
41opponent before the time runs out is declared the winner.
42
43Player one controls:
44 Move : arrow keys
45 Drop Bomn : enter
46
47Player two controls:
48 Move : w,a,s,d
49 Drop Bomn : spacebar
50
51Other controls:
52 Enter/exit fullscreen mode: f
53 Quit current game : escape
54
55
56
57Configuring Bomns for Linux
58---------------------------
59Bomns reads its configuration from a file called "~/.bomnsrc", which will be
60created the first time you run the game. This is a simple text file, fairly
61well-commented, and it can be easily edited. Of course this should never be
62necessary, because you can just use the launcher, as described below.
63
64
65
66Using the Bomns for Linux Launcher
67----------------------------------
68The launcher is what you can use to customize your Bomns playing experience.
69There are several values you can change, and most of them are self-explanatory
70(and tooltipped, at that). Some things to note: in the "Game Settings"
71section there is a text entry box where you can either type in a level file
72to play, or open a file selection dialog to choose the level to load. This
73will only have an effect if you choose to "Load Level From File", as opposed
74to "Generate Random Level". Also: if you choose to "Load Level From File", but
75fail to choose a level file to load, Bomns will just generate a random level.
76Clicking on the "Editor" button will launch the level editor, using the level
77file name specified in the text box, or if that is empty, "default.lvl" in the
78current directory.
79
80
81
82Using the Level Editor
83----------------------
84The Bomns for Linux level editor is a fairly simple tool you can use to create
85your own custom levels in which to play. Use the keyboard or mouse to create
86a level, then press F2 to save it to the filename specified either on the
87command line, or with the launcher. The most crucial keyboard commands are
88layed out on the bottom of the editor screen, but here are the full controls:
89
90Keyboard Controls:
91 Move cursor : arrow keys
92 Stamp tile : s, spacebar, enter
93 Delete tile : d, delete
94 Next tile : page up
95 Previous tile : page down
96 Select tile : 1-9
97 Test level in Bomns : l
98 Fullscreen mode : f
99 Save level : F2
100 Clear level : F12
101 Exit editor : escape
102
103Mouse Controls:
104 Move cursor : mouse
105 Stamp tile : left click
106 Delete tile : right click
107 Next tile : mouse wheel up
108 Previous tile : mouse wheel down
109
110Enjoy!
111