Games/lbreakout2/README

   1
   2                                 LBreakout2
   3
   4                 a breakout-style arcade game for Linux
   5                             by Michael Speck
   6
   7 ********************
   8 I.   Requirements
   9 II.  Installation
  10 III. Network Server
  11 IV.  Documentation
  12 V.   Troubleshooting
  13 VI.  Resources
  14 VII. Feedback
  15 ********************
  16
  17 ********************
  18 I.   Requirements
  19 ********************
  20 LBreakout runs in X and uses SDL (any version though >= 1.1.4
  21 is recommended) and SDL_mixer (optional for sound). Both libraries
  22 can be found at http://libsdl.org. The graphical stuff requires PNG
  23 which is usually included to a distro. If not check out
  24 http://www.libpng.org/pub/png/libpng.html.
  25
  26 ********************
  27 II.  Installation
  28 ********************
  29 Enter your favorite shell and type in the following stuff (in the
  30 directory you extracted the LBreakout source)
  31 > ./configure [--disable-audio] [--disable-install] [--enable-warp]
  32               [--with-highscore-path=HPATH] [--with-doc-path=DPATH]
  33               [--disable-network]
  34     --disable-audio:       no sound
  35     --disable-install:     no installation; play from source directory
  36     --enable-warp:         nescessary for non-Unices to use relative
  37                            mouse motion for inverting or modify mouse
  38                            speed
  39     --with-highscore-path: write global highscore chart lbreakout.hscr
  40                            to the specified directory
  41                            DEFAULT: /var/lib/games
  42     --with-doc-path:       install documentation to $DPATH/lbreakout2
  43                            DEFAULT: /usr/doc
  44     --disable-network:     compile LBreakout2 without any network
  45                            support
  46 > make
  47 > su (become root)
  48 > make install (if install wasn't disabled)
  49 > exit (become user again)
  50 > lbreakout2 (run client/non-network game)
  51
  52 !!! NOTE: Since 2.1.2 the config directory is ~/.lgames instead
  53 of ~/.lbreakout2. If you created levelsets with a previous version
  54 you'll have to copy these sets from ~/.lbreakout2/levels to
  55 ~/.lgames/lbreakout2-levels !!!
  56 The directory ~/.lbreakout2 is obsolete and may be deleted.
  57
  58 Building on Win32
  59 -----------------
  60 To build on a Win32 platform I used MinGW and MSYS.
  61 Network support is not available for the win32 version of lbreakout2.
  62
  63 1) Install the following win32 tools:
  64     MinGW
  65     MSYS
  66     Inno Setup 2
  67 2) Install the following win32 libaries:
  68     SDL (you might need to edit sdl-config)
  69     SDL_mixer
  70     lipng
  71     zlib
  72 3) From the build root, create win32dll directory and copy the following
  73    win32 dlls to it:
  74     SDL.dll
  75     SDL_mixer.dll
  76     libpng.dll
  77     zlib.dll
  78     msvcrt.dll (freely available from Microsoft)
  79 4) configure will need to find SDL.dll. You can either make sure SDL.dll
  80    is in your PATH or simply copy it to the root build directory.
  81 5) Setup environment.  To get things to compile, I setup the following
  82    environment variables:
  83     SDL_CONFIG  - fully qualified path to sdl-config
  84     CFLAGS      - tell build process where to find include files
  85     LDFLAGS     - tell build process where to find libraries
  86     PATH        - ensure that Inno Setup 2 iscc and zip are in the PATH
  87 6) Do a full build by issueing the following commands:
  88     configure --disable-install --disable-network
  89     make
  90 7) Create a win32 installer by issueing the following command:
  91     make win32-installer
  92
  93 You'll find lbreakout2-<version>-win32.exe in the build director. This is
  94 the is a standalone installer for lbreakout2.
  95
  96 ********************
  97 III. Network Server
  98 ********************
  99 To run a server start lbreakout2server with any of the following
 100 options:
 101 -p <PORT>     server port (default 2002)
 102 -l <LIMIT>    maximum number of users that may connect to the server
 103               (default is 30)
 104 -i <IDLETIME> a user will be kicked if he didn't communicate with the
 105               server for this amount of seconds (default is 1200)
 106 -n <MESSAGE>  this message is displayed to welcome a user
 107 -a <PASSWORD> a user that logs in with this name will become
 108               administrator named admin (default is no admin)
 109 After that you'll have to query your IP (e.g. with
 110 /sbin/ifconfig) and pass it to your friends as there is no permanent
 111 internet server yet. Note, that you shouldn't use localhost as you
 112 won't be able to challenge others then.
 113 Check the online documentation at http://lgames.sf.net
 114 for information on how to play.
 115
 116 ********************
 117 IV.  Documentation
 118 ********************
 119 If you have any questions about options, game play or editor
 120 please check the documentation and see if you
 121 can find an answer there. I will not respond to any eMails concerning
 122 questions easily answered by the manual (/usr/doc/lbreakout2).
 123 However, if you have any other problems or suggestions or you found a
 124 bug please contact me: kulkanie@gmx.net
 125
 126 ********************
 127 V.   Troubleshooting
 128 ********************
 129 The solution for relative mouse motion (nescessary when inverting or
 130 slowing down mouse by motion modifier) works fine for Linux and
 131 Win32 but fails for other non-Unices. Current solution is to warp the
 132 mouse (by using configure option --enable-warp). Unfortunately, this
 133 will handicap events when trying to fire weapon or release balls AND
 134 move the paddle at the same time. This means it may happen that a weapon
 135 is not fired or doesn't stop fire, balls keep being attached and so
 136 on...
 137 ---
 138 Disabling sound while playing seems to result in loosing various
 139 sound channels when some sounds were actually mixed.
 140 ---
 141 Someone reported that he had problems with PNG (configure script
 142 didn't find it) if it was installed to /usr/local/lib.
 143 Setting a link in /usr/lib fixes this.
 144 ---
 145 If you have SDL_mixer installed but configure tells you that it can't
 146 find it, remember that you have to install the development package
 147 for compiling!
 148 ---
 149 If you can't compile because LBreakout2' timestamps are slightly in
 150 the future run 'touchall' (found in the configure directory).
 151 ---
 152 If 'fullscreen' just adds a black frame around the game but does
 153 not change the solution make sure that you have 640x480 available
 154 as resolution in your Xconfig.
 155 ---
 156 If the SDL sound seems to be out of sync first try
 157 to modify the audio buffer size in ~/.lgames/lbreakout2.conf.
 158 If this fails set SDL_AUDIODRIVER to dma (export SDL_AUDIODRIVER=dma).
 159
 160 ********************
 161 VI.  Resources
 162 ********************
 163 Some graphics and sounds has been taken and modified from other
 164 non-copyrighted resources:
 165 Backgrounds:    http://www.grsites.com/textures
 166 Sounds:         "Web Clip Empire 50.000", NovaMedia Verlag, Germany
 167 Thanks to all of these guys for there free stuff!
 168
 169 ********************
 170 VII. Feedback
 171 ********************
 172 LGames URL:  http://www.lgames.org
 173 e-Mail:      kulkanie@gmx.net
 174