Mercurial > fife-parpg

comparison INSTALL @ 378:64738befdf3b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children adb4b0e7c08c
comparison
equal deleted inserted replaced
377:fe6fb0e0ed23 378:64738befdf3b
1 == Building, Installing and Running FIFE ==
2
3 === Notes ===
4 We are finally able to provide install targets for most platforms. There may be a few minor issues left over to work out but for the most part the install targets work as advertized.
5
6
7 === Dependencies ===
8 A list of all dependencies (including accurate version numbers) that you'll need to obtain to build FIFE on your platform can be found at the project wiki:
9 * http://wiki.fifengine.de/index.php?title=Build_dependencies
10
11
12 === SCons Build System Notes ===
13 FIFE utilizes the SCons (http://www.scons.org) build system. Here is a quick list of scons commands that can be important for building FIFE on your platform:
14 * 'scons -h' will list additional compile options.
15 * 'scons -c' deletes any compiled objects (scons equivalent of 'make clean').
16 * 'scons' will build FIFE (default target is fife-python).
17
18 Valid targets include:
19 * ext : builds the external dependencies (only REQUIRED in Linux)
20 * tests : builds unittests (needed for test_fife.py)
21 * fife-shared : builds a shared library (DLL on Windows)
22 * fife-static : builds a static library
23 * fife-python : (default) builds a python module (uses swig)
24 * fife-swig : build the swig python wrappers
25 * fife : builds fife-shared, fife-static and fife-python
26 * install-shared : installs the shared library
27 * install-static : installs the static library
28 * install-python : installs the python module and library
29 * install-dev : installed the shared, static and header files
30 * install-all : installs the shared, static and python libraries
31 * projects : build msvc, msvc9 and code-blocks (win32 and linux) project files
32
33 Build options:
34 * --release : builds the release versions of the binaries
35 * --disable-opengl : removes opengl support
36 * --disable-zip : removes ZIP archive support
37 * --disable-log : disable engine logging support
38 * --enable-rend-camzone : enables camera zone renderer
39 * --enable-rend-grid : enables camera grid renderer
40 * --enable-profile : build with profiling information
41 * --prefix : installation prefix for the shared and static libraries
42 * --python-prefix : installation prefix for the python library
43
44
45 == Platform specific details ==
46
47 === Linux ===
48 Detailed information how to build FIFE on Linux-based distributions can be found at the project wiki:
49 * http://wiki.fifengine.de/index.php?title=Building:Linux:SCons
50
51 After FIFE has been built successfully move into the <FIFE>/demos/rio_de_hola directory and run: 'python run.py'
52
53 === OS X ===
54 Detailed information how to build FIFE on OS X systems can be found at the project wiki:
55 * http://wiki.fifengine.de/index.php?title=Building:Mac:Scons
56
57 After FIFE has been built successfully move into the <FIFE>/demos/rio_de_hola directory and run: 'python run.py'
58
59
60 === Win32 ===
61 The Win32 package ships with precompiled binaries. Simply unpack the package to location of your choice. After that you'll need to install ActivePython 2.6:
62 * http://downloads.activestate.com/ActivePython/windows/2.6/ActivePython-2.6.4.8-win32-x86.msi (for 32bit Windows systems)
63 * http://downloads.activestate.com/ActivePython/windows/2.6/ActivePython-2.6.4.8-win64-x64-nopywin32.msi (for 64bit Windows systems)
64
65 Move into the <FIFE>\demos\rio_de_hola directory and start the run.py script. You can simply double-click with your mouse on it. It should be automatically associated with the Python interpreter after installing ActivePython.