forked from pioneerspacesim/pioneer
/
COMPILING.txt
247 lines (162 loc) · 7.04 KB
/
COMPILING.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
Table of Contents
=================
1 How to compile Pioneer
1.1 Linux - Autotools
1.2 Windows - MSVC
1.3 Windows - Autotools (Linux cross-compile)
1.4 OS X - Autotools
1.5 OSX - XCode 4
2 pioneer-thirdparty
2.1 Linux - Autotools
2.2 Windows - MSVC
2.3 Windows - Autotools (Linux cross-compile)
2.4 OSX
3 Building documentation
3.1 Lua API - Natrual Docs
3.2 C++ source - Doxygen
1 How to compile Pioneer
========================
Pioneer is known to build on the following platforms and build systems:
Linux: GNU Autotools with GCC or Clang
Windows: Microsoft Visual C++ 2013 (Express Edition or Pro)
Windows: GNU Autotools with MXE (MinGW GCC) (cross-compile on Linux)
OS X: GNU Autotools or XCode 4
The Autotools build system is usually the most up-to-date, and is what is used
to produce the Linux and Windows builds. The others typically lag behind,
depending on the motivation of those using them to keep them up too date with
source file changes.
There is an additional repository called pioneer-thirdparty that contains
various files that may assist with building. If the instructions for your
platforms indicates you may need it, then read the section below for details.
If you're having trouble compiling, please ask in #pioneer on
irc.freenode.net.
1.1 Linux - Autotools
---------------------
1. Install the following libraries (with development headers) for your system.
If your system is not Debian/Ubuntu based, they may have different names.
Debian/Ubuntu
-------------
g++
automake
pkg-config
libsigc++-dev
libsigc++-2.0-dev
libsdl2-dev
libsdl2-image-dev
libfreetype6-dev
libvorbis-dev
libpng-dev
libassimp-dev >= 3.0
mesa-common-dev
If your platform doesn't have assimp 3.0, you'll need to build it from
source. Its available in pioneer-thirdparty, see below.
2. Run ./bootstrap to generate your 'configure' file
3. Run ./configure to configure the build. If you're using the
pioneer-thirdparty repository, pass
--with-thirdparty=/path/to/pioneer-thirdparty to configure.
4. Run make to build everything
1.2 Windows - MSVC
------------------
1. Get both the pioneer and the pioneer-thirdparty repositories and keep them
in a directory side by side. Don't rename pioneer-thirdparty because the
relative path to it is included in the project files.
2. Open the pioneer solution from win32/vc2013Express.
3. Build and run the project or solution.
1.3 Windows - Autotools (Linux cross-compile)
---------------------------------------------
1. First you need a cross-compiling environment. We use MXE (http://mxe.cc)
with a patch required to make SDL2 compile. Until that patch is merged
upstream, grab it from:
git://github.com/robn/mxe.git
Now compile GCC and the dependencies needed for Pioneer:
make gcc freetype sdl2 sdl2_image vorbis libsigc++
2. Prepare the pioneer-thirdparty repository. See below.
3. Now you can build Pioneer. Run ./bootstrap to generate your 'configure'
file.
4. Run configure to configure the build:
./configure --with-mxe=/path/to/mxe --with-thirdparty=/path/to/pioneer-thirdparty
5. Run make to build everything
1.4 OS X - Autotools
--------------------
1. Install XCode (free download from apple). This will install the required
compilers and other commandline tools.
2. You will need the following libraries installed. The best method I found
was to install macports (http://www.macports.org/) and install the
following ports (sudo port install xxxx):
assimp
pkgconfig
freetype
libsdl2
libsdl2_image
libsdl2_sound
libsigcxx2
libvorbis
autoconf
automake
3. Run ./bootstrap to generate your 'configure' file
4. By default the OpenGL frameworks don't seem to be visible to 'automake'
way so I did a few tricks to get it working:
Create a symlink from the OpenGL framework to your /usr/local/include
directory
sudo ln -s /System/Library/Frameworks/OpenGL.framework/Versions/A/Headers/ /usr/local/include/GL
5. Instead of running ./configure run it with this command line:
LDFLAGS="-L/System/Library/Frameworks/OpenGL.framework/Libraries -L/System/Library/Frameworks/GLUT.framework" ./configure
6. Now you can run make as per normal. :)
Note: Compiling from source this way isn't recommended as it doesn't allow you
to 'install' the application into a different location (pioneer.app
bundle). It also isn't the 'Apple way', To do that you need to use XCode.
1.5 OSX - XCode 4
-----------------
* The XCode project isn't as up to date as the 'autotools' method and may
be broken.
The latest XCode project files are located in ./osx. Simply build the
aplication bundle. The XCode project uses the mac port libraries that you
have installed above. Once the pioneer.app bundle is complete you can move it
around where you like (/Applications is a nice place for it).
2 pioneer-thirdparty
====================
The pioneer-thirdparty repository contains:
- source for dependencies that may be difficult to obtain or build
- pre-built dependencies for MSVC targets
To get it, clone git://github.com/pioneerspacesim/pioneer-thirdparty.git.
2.1 Linux - Autotools
---------------------
1. After cloning the repo, run autoconf to generate 'configure'.
2. Run ./configure to configure the build
3. Run make <package> to compile and prepare the named package for use with
Pioneer, or just run make alone to build everything.
2.2 Windows - MSVC
------------------
1. After cloning the repo, move it to a folder called "pioneer-thirdparty"
alongside your "pioneer" folder.
2.3 Windows - Autotools (Linux cross-compile)
---------------------------------------------
1. After cloning the repo, run autoconf to generate 'configure'.
2. Run ./configure --with-mxe=/path/to/mxe to configure the build.
3. Run make <package> to compile and prepare the named package for use with
Pioneer, or just run make alone to build everything.
2.4 OSX
-------
- pioneer-thirdparty currently not required.
3 Building documentation
========================
This section describes how to build html-documentation which is stored on disk
for the local pioneer source tree.
3.1 Lua API - Natrual Docs
--------------------------
Pioneer is extensible through the Lua scripting language. It is used for
modules such as missions and BBS interaction. See the pioneer wiki for further
details. For up-to-date documentation one can build it locally from the
pioneer source
0. Install dependencies: natruldocs
1. Run make codedoc
2. The html documentation can be found in the codedoc/ folder
3.2 C++ source - Doxygen
------------------------
To build html-documentation of the pioneer C++ source, doxygen needs to be
installed, as well as the graphviz package, from where dot is used for
visualizing inheritance as graphs. To enable LaTeX output, set GENERATE_LATEX
= YES in the configuration file doxygen/Doxyfile. Same goes for xml, man, rtf.
0. Install dependencies: doxygen and graphviz
1. Run doxygen from the doxygen/ folder.
2. The html documentation will be available from doxygen/html/index.html