Permalink
Browse files

Updated all installation sections.

Added information on how to build with SDL_mixer or FMod Ex for
Windows or Linux platforms.
  • Loading branch information...
1 parent 0110872 commit 5de3e96c82b406d993cb68dd5d4138c80e24712d @petarov petarov committed Jun 28, 2013
Showing with 54 additions and 23 deletions.
  1. +54 −23 INSTALL
View
77 INSTALL
@@ -14,8 +14,8 @@ Get the latest source code from GitHub:
Get the data files archive 'savagewheels-gamedata.tar.gz' from
https://code.google.com/p/savagewheels. Extract the downloaded archive into
-the bin/ folder.
-This archive should contain the folders: autos/, graphics/ and sounds/.
+the bin/ folder. This archive should contain the folders:
+autos/, graphics/ and sounds/.
3) Installation on Linux platforms
@@ -34,8 +34,7 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
a) Install the libSDL package using the package manager on your Linux
distribution.
- b) Install the FMod Ex package using the package manager on your Linux
- distribution or get the package from FMod's website.
+ b) Install one of the supported sound libraries. See 3.2.1)
c) Run the build script - build.sh
$ ./build.sh
@@ -51,24 +50,37 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
The 'run.sh' script will attempt to set the LD_LIBRARY_PATH in case you
are missing libSDL or FModEx shared object libraries.
- If you experience problems with the automated 'build.sh' script you can
- try to build manually.
+ If you experience problems with the automated 'build.sh' script or you
+ would like to change build options you can build manually with CMake.
- a) You can also run CMake manually. Go to the release/ sub folder and run.
+ a) Go to the release/ sub folder and run:
$ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release
-
- Or to build without sound & music run:
- $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=NO
b) Build with:
$ make
c) Create the installation package with:
$ cpack
-3.2.1) Sound libraries support
+3.2.1) Sound libraries
+3.2.1.1) SDL_mixer
+
+ Install the SDL_mixer library using your package manager.
+
+3.2.1.2) FMod Ex
+
+ Install the FMod Ex package using the package manager on your Linux
+ distribution or get the package from FMod's website. If you choose
+ the second option you will need to copy the api/ folder from FMod's
+ installation package into the libs/ subfolder of savage wheels.
+
+ When you are running CMake, specify the SOUND=FMOD option, e.g.,
+ $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=FMOD
+
+3.2.1.3) No sound
- TODO
+ To build without sound & music run:
+ $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=NO
3.2.2) Compile 32-bit version on 64-bit Linux
@@ -78,7 +90,7 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
After all required packages are installed build the makefile by running:
$ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DM32=1
-
+
3.4) Packaging
A self-extracting STGZ file will be created by default when running:
@@ -112,34 +124,53 @@ This archive should contain the folders: autos/, graphics/ and sounds/.
a) Extract the contents of SDL 1.2.x package into the libs/ subfolder.
Set the environment variable SDLDIR=<SDL-directory-in-libs>.
- b) Install the FMod Ex API and copy the api/ folder into the libs/
- subfolder.
+ b) Install one of the supported sound libraries. See 4.2.1)
c) Run CMake manually. Go to the release/ sub folder and run.
> cmake -G "MinGW Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release
-
- Or to build without sound & music run:
- > cmake -G "MinGW Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=NO
- c) Build with:
+ d) Build with:
> mingw32-make
- d) Create the installation package with:
+ e) Create the installation package with:
> cpack
- c) Extract the produced archive file, e.g.,
+ f) Extract the produced archive file, e.g.,
savagewheels-1.5.0-Windows-x86.tar.gz to your desired Games folder.
- e) Start the game with:
+ g) Start the game with:
> savagewheels
-4.2.1) Sound libraries support
+4.2.1) Sound libraries
+4.2.1.1) SDL_mixer
+
+ Copy the contents of the SDL_mixer-1.2.x-win32 binary package to the
+ <SDL-directory-in-libs>/lib.
+
+ Copy the SDL_mixer.h header file from SDL_mixer-1.2.x.zip sources package
+ to the <SDL-directory-in-libs>/include.
+
+4.2.1.2) FMod Ex
+ Install the FMod Ex API and copy the api/ folder from FMod's installation
+ into the libs/ subfolder of savage wheels.
+
+ When you are running CMake, specify the SOUND=FMOD option, e.g.,
+ > cmake -G "MinGW Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=FMOD
+
+4.2.1.3) No sound
+ To build without sound & music run:
+ $ cmake -G "Unix Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Release -DSOUND=NO
4.2.2) Compiling a Debug version
To build a Debug version to catch a bug or something use the following:
$ cmake -G "<?> Makefiles" ../ -DCMAKE_BUILD_TYPE:STRING=Debug
+4.3) Packaging
+
+ A tar.gz file will be created by default when running:
+ $ cpack
+ after the build process has finished.

0 comments on commit 5de3e96

Please sign in to comment.