Project

General

Profile

Start to build Scol using CMAKE » History » Version 28

arkeon, 02/28/2017 04:40 PM

1 1 arkeon
h1. Start to build Scol using CMAKE
2
3
4 20 brainsandwich
h2. Tools
5 1 arkeon
6 20 brainsandwich
h3. Common to all platforms
7 1 arkeon
8 20 brainsandwich
* "CMake":http://www.cmake.org/download/
9 27 arkeon
* Visual Studio Community
10 20 brainsandwich
* "Tortoise SVN":http://tortoisesvn.net/ (or any SVN client)
11
* "Tortoise git":https://code.google.com/p/tortoisegit/ (or any Git client too)
12 1 arkeon
13 20 brainsandwich
h3. Windows target
14 1 arkeon
15 28 arkeon
The minimum compiler supported is the one in Visual Studio 2013.
16 20 brainsandwich
You can try with a newer version at your own risks !
17 1 arkeon
18 20 brainsandwich
h3. Android target
19 1 arkeon
20 20 brainsandwich
_With standard tools_
21 1 arkeon
22 20 brainsandwich
i.e. free tools found on the web or provided by Google
23 1 arkeon
24 20 brainsandwich
* "Java Development Kit (JDK)":http://www.oracle.com/technetwork/java/javase/downloads
25
* "Android SDK":https://developer.android.com/sdk/installing
26
* "Native Development Kit (NDK)":https://developer.android.com/tools/sdk/ndk
27
* "Apache ANT":http://ant.apache.org/
28 1 arkeon
29 20 brainsandwich
_With Tegra Android Development Pack_
30 10 brainsandwich
31 20 brainsandwich
A package provided by Nvidia to build applications for Android. The download process requires authentication to the Nvidia Developper Network (it's free and not too spammy though)
32
33
* "TADP":https://developer.nvidia.com/gameworksdownload
34
* On setup, let it download everything or at least the tools described in the previous section.
35
36
_SDK preparation_
37
38
You should launch the SDK to download other tools like emulators for each API you want to target.
39
(Our target API is 17 so you can get any emulator above).
40
41
h3. Linux target
42
43
Not supported yet.
44
45
h3. Mac OS target
46
47
Not supported yet.
48
49
50 7 brainsandwich
h2. Get the Scol sources
51 1 arkeon
52 20 brainsandwich
Scol uses Subversion for source control and you can use your SVN client to get the source code.
53 6 arkeon
54 1 arkeon
So first retrieve the sources from "https://svn.scolring.org/trunk/", accept the certificate and go take some coffee.
55
The source directories contains most of the dependencies, and since some of them are modified they are provided in the sources.
56 7 brainsandwich
57 20 brainsandwich
Some sources like curl use Git as source control and are downloaded when building, so make sure it's installed before building the project
58 7 brainsandwich
59 20 brainsandwich
60
61 1 arkeon
h2. Dependencies search paths
62 8 brainsandwich
63 1 arkeon
h3. Windows
64
65
Once you get the sources, you can execute "setWindowsSearchPaths.bat" in the dependencies directory.
66
!!WARNING!! when you execute the bat file using the mouse the current directory is wrong.
67
You need to start a DOS command line "cmd.exe" as administrator and go to the dependencies directory to start the bat file manually.
68
 
69
This will add needed environment variables and paths.
70
71
h3. Android
72
73 20 brainsandwich
If you downloaded the TADP, the following variables are likely to be defined already (or they should look alike).
74
If not, add these to the environment variables
75 1 arkeon
* ANDROID_HOME : path/to/sdk
76
* ANDROID_SDK_HOME : path/to/sdk
77
* ANDROID_SDK : path/to/sdk
78
* ANDROID_NDK : path/to/ndk
79
* ANT_HOME : path/to/ant
80 7 brainsandwich
* JAVA_HOME : path/to/jdk -- should be something like "C:\Progra~1\Java\<jdkfolder>"
81 1 arkeon
* CMAKE : path/to/cmake
82 7 brainsandwich
83 20 brainsandwich
Then you should add these variables into the PATH:
84 1 arkeon
85
@%ANDROID_NDK%;%ANT_HOME%\bin;%ANDROID_SDK%\tools;%ANDROID_SDK%\platform-tools;%CMAKE%;%JAVA_HOME%\bin;@
86
87 20 brainsandwich
88
89
90 1 arkeon
h2. Build needed dependencies
91
92 20 brainsandwich
h3. From Windows, for Windows
93 1 arkeon
94 22 hector
# Launch cmake-gui from a Visual Studio command line (it configures environment so you can build things correctly)
95
# Specify the source folder to trunk/dependencies and the build to trunk/dependencies/build/windows/x86
96 24 hector
# Hit Configure. In the message box, select your Visual Studio version as generator, and check "Use default native compilers".
97 21 hector
98
You will see a list of categories, under which are variables to tweak build parameters.
99
The category SCOLDEPS contains CMake variables that enable/disable the build of individual SCOL dependencies.
100
Some of these dependencies depend on one or several others. Since CMake needs to detect these "sub-dependencies" when configuring,
101
we need to make several build passes, in order to build said "sub-dependencies" before the dependencies that depend on them.
102
103 22 hector
# Leave all variables at their default values.
104 25 hector
# Keep hitting Configure until no variables are highlighted in red.
105 1 arkeon
# Hit Generate to generate a Visual Studio project.
106 22 hector
# Build the project in Visual Studio (Build->Batch Build, check debug and release for "INSTALL" configuration).
107 24 hector
# When the build is done, in CMake, check LIBPNG, OPENAL, CURL under SCOLDEPS (leave the other variables as they are).
108 1 arkeon
# Hit Configure again. When configuring is done, you will see new variables appear in red. Leave them at their default values.
109 25 hector
# Repeat steps 2 to 4.
110
# Check OGRE, CAUDIO, LIBHARU under SCOLDEPS, hit Configure, and repeat steps 2 to 4.
111
# Check HYDRAX and SKYX under SCOLDEPS, hit Configure, and repeat steps 2 to 4.
112 26 hector
# HYDRAX / SKYX build might fail due to header conflicts. To solve them, in Visual Studio :
113
## In the solution explorer, open the properties of the *RenderSystem_Direct3D11* project.
114
## In the properties window, Select *All configurations*.
115
## Under *Configuration Properties* > *C/C++* > *General*, modify the *Other include directories* entry.
116
## In the directories list, move the directory at the bottom all the way to the top.
117
## Save the changes.
118
## Repeat the same steps for the *RenderSystem_Direct3D9* project.
119
## Re-run the build.
120 21 hector
121
Now every required dependency should be built. The ones that we left unchecked aren't needed.
122 7 brainsandwich
123 20 brainsandwich
h3. From Windows, for Android
124 7 brainsandwich
125 20 brainsandwich
Do the same as for Windows target, but
126
* Set source folder to trunk/dependencies and build folder to trunk/scol/build/android/<target abi>
127
* Specify the generator : "NMake"
128
* The toolchain for crosscompile : trunk/dependencies/CMake/toolchain/android.toolchain.cmake
129
* Build dependencies with "nmake install" command from a command line.
130 13 brainsandwich
131
132 19 brainsandwich
133 20 brainsandwich
134 19 brainsandwich
h2. Build the Scol project
135 13 brainsandwich
136 20 brainsandwich
As for the dependencies:
137 13 brainsandwich
138 20 brainsandwich
h3. Windows target
139 3 arkeon
140 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/windows/x86
141
* Configure, generate and build from Visual Studio
142
143
h3. Android target
144
145
* Set source folder to trunk/scol and build folder to trunk/scol/build/android/<target abi>
146
* If you're using Nsight with Visual Studio (TADP), some build paramaters should be modified for each build if you want to install and test the project on a device :
147
  - Open ScolLauncher subproject -> properties
148
  - Configuration Properties -> General -> Configuration Type -> Make Application (ndk-build -> .apk|.so|.a)
149
  - Configuration Properties -> Deployment -> Fast Deploy -> No
150
  - Configuration Properties -> Ant Build -> Skip Ant Step -> No
151
* Without TADP, after it's build, go to trunk/scol/build/android/<target abi>/App/bin, and run "ant debug install" if you wish to install the project on an emulator or your device  
152 1 arkeon
153
h1. Start your new plugin
154
155
h2. Source paths
156
157
Start by creating a directory with your new plugin name in the trunk/scol/plugins folder.
158
For example trunk/scol/plugins/myPlugin
159 4 arkeon
160
Usually we prefer to separate the sources and the includes.
161 1 arkeon
So creates a "src" and "include" directory in your plugin folder.
162
163
Creates the empty files you will need for your project, usually :
164
- include/myplugin.h for your classes declaration
165
- src/myplugin.cpp for your classes definition
166
- src/scolplugin.cpp for the Scol binding functions
167
168
h2. Dependencies
169
170
If your project need an external SDK or dependencies, add then in the trunk/dependencies directory.
171
Then create a findMydepname.cmake file in trunk\scol\CMake\Packages.
172
You can copy and change an existing Find.cmake file to make yours.
173
Start from a simple one like FindMyo.cmake for example.
174
175
h2. Cmake files
176
177
It's time to creates the CMAKE script for your plugin.
178
179
Create a "CMakeLists.txt" file in the plugin directory.
180
trunk/scol/plugins/myPlugin/CMakeLists.txt
181
182
And edit the file with a text editor.
183
184
<pre>
185
#-------------------------------------------------------------------
186
# This file is part of the CMake build system for Scol
187
#
188
# The contents of this file are placed in the public domain. Feel
189
# free to make use of it in any way you like.
190
#-------------------------------------------------------------------
191
192
############################################################
193
# CmakeList file for Myplugin
194
############################################################
195
196
#Your project name
197
PROJECT(myPLugin)
198
199
# define header and source files for the library
200
set (MYPLUGIN_HEADER_FILES
201
  include/myplugin.h
202
)
203
204
set (MYPLUGIN_SOURCE_FILES
205
  src/myplugin.cpp
206
  src/scolplugin.cpp
207
)
208
209
# Add includes directories from dependencies
210
#  include_directories(include ${MYDEP_INCLUDE_DIRS})
211
212
# Add definition for P4 optimizations, warnings removal.
213
add_definitions(-DOPTI_P4 -D_CRT_SECURE_NO_WARNINGS -D)
214
215
# Add dependencies libraries
216
#  set(LIBRARIES
217
#    ${MYDEP_LIBRARIES}
218
#    ${ZLIB_LIBRARIES}
219
#    ${PNG_LIBRARIES}
220
#  )
221
222
# setup Scol plugin target
223
add_library(myPLugin
224
  ${Scol_LIB_TYPE}
225
  ${MYPLUGIN_HEADER_FILES}
226
  ${MYPLUGIN_SOURCE_FILES}
227
)
228
add_dependencies(myPLugin kernel)
229
230
# set the dll version.
231
set_target_properties(myPLugin PROPERTIES VERSION ${Scol_VERSION} SOVERSION ${Scol_VERSION_MAJOR})
232
target_link_libraries(myPLugin ${LIBRARIES})
233
234
# install Scol
235
scol_config_plugin(myPLugin)
236
install(FILES ${MYPLUGIN_HEADER_FILES} DESTINATION include/SCOL/plugins/myPLugin)
237
</pre>
238
239
Now we need to declare this new plugin in the common Scol cmake files.
240
Edit the trunk/scol/CMakeLists.txt file and add your plugin definition like the following.
241
242
If you don't have dependencies.
243
<pre>
244
option(Scol_BUILD_MYPLUGIN "Build myPluginplugin, my library" TRUE)
245
</pre>
246
247
If you have depencies
248
<pre>
249
cmake_dependent_option(Scol_BUILD_MYPLUGIN "Build myPlugin, my library." TRUE "MYDEP_FOUND;ZLIB_FOUND;PNG_FOUND" FALSE)
250
</pre>
251
252
Now edit the trunk/scol/plugin/CMakeLists.txt file and add the following.
253
<pre>
254
# Configure myPlugin plugin build
255
if (Scol_BUILD_MYPLUGIN)
256
  add_subdirectory(myPlugin)
257
endif ()
258
</pre>
259
260
Only if you have dependencies, edit the trunk/scol/CMake/ScolDependencies.cmake file and add the dependencies resolution as the following
261
262
<pre>
263
# Find MyDep
264
find_package(MYDEP)
265
macro_log_feature(MYDEP_FOUND "Mydep" "MydepLibrary" "http://Mydep.org/" FALSE "" "")
266
</pre>
267
268
h2. Almost done
269
270
Open the CMAKE-gui again.
271
Hit the "Configure button" and check if you found your plugin in the scol group.
272
Then hit the generate button, and open the scol.sln project again.
273
274
You should have the project added in Visual Studio.