LinuxInstall
Linux installation
See source:tags/2.0.0/INSTALL.txt
2.2.3
Speed Dreams 2 is available to install as an AppImage, via Flatpak, and XtraDeb PPA:
Flatpak
The flatpak installation is available on the official Flathub website.
AppImage
Speed Dreams is available through the convenient and portable AppImage format. Just download the AppImage, give it permissions to execute as a file and you are good to go. You can find a mirror on AppImageHub, where you can find also Experimental versions. One limitation of this format as of Speed Dreams 2.2.3 is that it doesn’t allow for the user to add community made cars.
XtraDeb PPA
For Ubuntu and Ubuntu derived installations Speed Dreams is available through the XtraDeb PPA. Further instructions on how to use XtraDeb can be found here and Speed Dreams on XtraDeb is available on this link.
Install from sources
Introduction
Taken from source:trunk/INSTALL.txt)
Pre-requisites
- Working OpenGL Driver and header files / associated libraries
- SDL 1.2 (http://www.libsdl.org/)
- PLIB 1.8.3 / 4 / 5 (http://plib.sourceforge.net/).
Linux: Be carefull to compile plib with -fPIC on AMD64 if you run a 64 bit version. - OpenAL soft 1.5 / 1.6 / 1.11 (http://connect.creativelabs.com/openal)
(Torcs modified 0.0.8 from www.torcs.org also used to work in the past). - ENet 1.2 (http://enet.bespin.org)
Linux: Be carefull to compile ENet with -fPIC on AMD64 if you run a 64 bit build. - libpng
- zlib
- jpeg
-OpenSceneGraph
-Java jre and jdk if you want to build TrackEditor
1 - Introduction
There are 2 ways to build and install Speed Dreams from sources :
- from the official source tarballs,
- from the subversion repository.
Pick only one of the above options. If you have trouble during the installation,
have a look in the FAQ on the above sites. In case you get stuck,
please learn how to report the problem in the FAQ before filing a bug or contact us.
2 - Installation from the official tarballs
a - get these tarballs : please go to our SF.net download page at
https://sourceforge.net/projects/speed-dreams/files/<version>/
and you should find :
speed-dreams-src-base-<version>.tar.xz
speed-dreams-src-hq-cars-and-tracks-<version>.tar.xz
speed-dreams-src-more-hq-cars-and-tracks-<version>.tar.xz
speed-dreams-src-wip-cars-and-tracks-<version>.tar.xz
speed-dreams-src-unmaintained-<version>.tar.xz
where <version> is something like "2.2.3-r7616"</version>
Warning: you must download them all, as our current build system
can't cope with missing files.
Let's say you downloaded them all in $HOME/sd, and that <version> is 2.2.3-r7616.
(you can do as you like, but we'll use this folder in the explanations below).</version>
b - uncompress the tarballs :
$ cd $HOME/sd
$ mkdir 2.2.3-r7616
$ cd 2.2.3-r7616
$ for file in *.xz; do tar xvfa $file; done
You should now see "cmake", "data" and "src" folders (among others).
c - configure :
1. create the build dir for CMake
$ mkdir build
$ cd build
2. run CMake :
- for a Release build using default 3rd party libs
$ cmake -D OPTION_OFFICIAL_ONLY:BOOL=ON ..
Note: This "OFFICIAL_ONLY" stuff is mandatory, otherwise
you'll get errors saying that some (unofficial contents) folders
are missing, just because the official tarballs don't include them.
- you may also want to override some default settings :
for that, you can use the -D option of cmake :
Example :
$ cmake -D SD_LOCALDIR:STRING=~/dev/.sd-settings \
-D CMAKE_PREFIX_PATH:STRING=/usr/local
-D CMAKE_BUILD_TYPE:STRING=Debug
or else you can use ccmake to change the variables interactively :
$ ccmake ..
* press (t) for advanced options if needed
* in order to change a variable :
* select the associated line using the up/down arrow keys
* press (enter)
* edit the value
* press (enter)
* press (c) for configure
* press (g) for generate
* press (e) to exit
Usefull CMake variables for Speed Dreams (note that some might be "advanced" ones) :
- CMAKE_BUILD_TYPE:STRING :
Debug, Release, RelWithDebInfo, MinSizeRel (def: Release)
- OPTION_OFFICIAL_ONLY:BOOL :
Build/install only official contents (def: OFF)
- SD_LOCALDIR:STRING :
User settings dir for run-time (def: ~/.speed-dreams-2)
- CMAKE_PREFIX_PATH:STRING :
Path prefixes for additional 3rdParty libraries (def:empty)
(use /usr/local if you compiled some 3rdParty libs yourself).
- CMAKE_INSTALL_PREFIX:PATH :
Install path for Speed Dreams (def: /usr/local)
- OPTION_TRACE:BOOL :
Full run-time traces if ON (def: ON)
- OPTION_TRACE_LEVEL:STRING :
Run-time traces level integer threshold, only if OPTION_DEBUG
(traces with higher level are not logged ;
0=Fatal, 1=Error, 2=Warning, 3=Info, 4=Trace, 5=Debug, ...) (def: 5)
- OPTION_UNLOAD_SSGGRAPH:BOOL :
The 'ssggraph' graphics engine module will never be unloaded if OFF (def: ON)
Usefull under some Linux configurations where this unloading badly crashes XOrg
(see http://sourceforge.net/apps/trac/speed-dreams/ticket/209),
or simply makes SD crash because PLib is shipped as a set of shared libraries
(see http://sourceforge.net/apps/trac/speed-dreams/ticket/459).
- OPTION_DEBUG:BOOL :
Enable debug symbols even in Release builds (def: ON)
Tips reported about some issues :
- sometimes, ENET_INCLUDE_DIR is not detected correctly, resulting in something like
/usr/include/enet or so, and, consequently, in bad compilation errors because
/usr/include/enet contains a special time.h header file that conflicts with the standard
one in /usr/include. Removing the "enet" postfix from ENET_INCLUDE_DIR should fix this
(in cmake command line or interactively through ccmake).
d - build:
$ make
e - install:
$ sudo make install
Notes:
* sudo is only useful if your install PREFIX is a read-only folder (like default /usr/local)
* sudo configuration : you may ask your system administrator to enable you to run
'sudo make install' ; if he doesn't know how, you can tell him/her
to add a line like this in /etc/sudoers (or something less permissive ;-) :
<your login name> ALL=(ALL) NOPASSWD: ALL
3 - Installation from SVN
Before you start, be aware that the SVN trunk / branches might crash or even not compile
sometimes. If you want to get it anyway, follow the instructions at
http://sourceforge.net/svn/?group_id=239111
For the moment,
- the developments for the next release are located in the trunk ;
you can checkout the current development state through :
$ svn co https://speed-dreams.svn.sourceforge.net/svnroot/speed-dreams/trunk sd-trunk
- we make branches under the "branches" root dir ; as an exemple,
you can get the last "2.2.3" through :
$ svn co https://sourceforge.net/p/speed-dreams/code/HEAD/tree/tags/2.2.3/ sd-2.2.3
See configure, build and install method above (2)
(note however that branches/1.4.x and tags/1.4.0 are not built through cmake :
please refer to the dedicated INSTALL file for these).
4 - Run Speed-Dreams
If the default CMake settings were kept, Speed Dreams is normally installed in /usr/local :
$ speed-dreams-2
or, if /usr/local/games not already in your PATH :
$ /usr/local/games/speed-dreams-2
Runtime options :
$ speed-dreams-2 --help
5 - Getting Help
From inside the game, press F1 at any time, you'll get a help page explaining
the available keyboard shorcuts.
If you are stuck please report problems through speed-dreams-users mailing list
or our bug tracker at https://sourceforge.net/p/speed-dreams/tickets/.
