Project

General

Profile

Start to build Scol using CMAKE » History » Version 21

hector, 01/11/2016 01:42 PM
Try to make build instructions clearer

1 1 arkeon
h1. Start to build Scol using CMAKE
2 1 arkeon
3 1 arkeon
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 20 brainsandwich
* Visual Studio (not free)
10 20 brainsandwich
* "Tortoise SVN":http://tortoisesvn.net/ (or any SVN client)
11 20 brainsandwich
* "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 20 brainsandwich
The minimum compiler supported is the one in Visual Studio 2010.
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 20 brainsandwich
* "Android SDK":https://developer.android.com/sdk/installing
26 20 brainsandwich
* "Native Development Kit (NDK)":https://developer.android.com/tools/sdk/ndk
27 20 brainsandwich
* "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 20 brainsandwich
33 20 brainsandwich
* "TADP":https://developer.nvidia.com/gameworksdownload
34 20 brainsandwich
* On setup, let it download everything or at least the tools described in the previous section.
35 20 brainsandwich
36 20 brainsandwich
_SDK preparation_
37 20 brainsandwich
38 20 brainsandwich
You should launch the SDK to download other tools like emulators for each API you want to target.
39 20 brainsandwich
(Our target API is 17 so you can get any emulator above).
40 20 brainsandwich
41 20 brainsandwich
h3. Linux target
42 20 brainsandwich
43 20 brainsandwich
Not supported yet.
44 20 brainsandwich
45 20 brainsandwich
h3. Mac OS target
46 20 brainsandwich
47 20 brainsandwich
Not supported yet.
48 20 brainsandwich
49 20 brainsandwich
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 1 arkeon
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 20 brainsandwich
61 1 arkeon
h2. Dependencies search paths
62 8 brainsandwich
63 1 arkeon
h3. Windows
64 1 arkeon
65 1 arkeon
Once you get the sources, you can execute "setWindowsSearchPaths.bat" in the dependencies directory.
66 1 arkeon
!!WARNING!! when you execute the bat file using the mouse the current directory is wrong.
67 1 arkeon
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 1 arkeon
 
69 1 arkeon
This will add needed environment variables and paths.
70 1 arkeon
71 1 arkeon
h3. Android
72 1 arkeon
73 20 brainsandwich
If you downloaded the TADP, the following variables are likely to be defined already (or they should look alike).
74 20 brainsandwich
If not, add these to the environment variables
75 1 arkeon
* ANDROID_HOME : path/to/sdk
76 1 arkeon
* ANDROID_SDK_HOME : path/to/sdk
77 1 arkeon
* ANDROID_SDK : path/to/sdk
78 1 arkeon
* ANDROID_NDK : path/to/ndk
79 1 arkeon
* 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 1 arkeon
@%ANDROID_NDK%;%ANT_HOME%\bin;%ANDROID_SDK%\tools;%ANDROID_SDK%\platform-tools;%CMAKE%;%JAVA_HOME%\bin;@
86 1 arkeon
87 20 brainsandwich
88 20 brainsandwich
89 20 brainsandwich
90 1 arkeon
h2. Build needed dependencies
91 1 arkeon
92 20 brainsandwich
h3. From Windows, for Windows
93 1 arkeon
94 20 brainsandwich
1. Launch cmake-gui from a Visual Studio command line (it configures environment so you can build things correctly)
95 20 brainsandwich
2. Specify the source folder to trunk/dependencies and the build to trunk/dependencies/build/windows/x86
96 21 hector
97 21 hector
You will see a list of categories, under which are variables to tweak build parameters.
98 21 hector
The category SCOLDEPS contains CMake variables that enable/disable the build of individual SCOL dependencies.
99 21 hector
Some of these dependencies depend on one or several others. Since CMake needs to detect these "sub-dependencies" when configuring,
100 21 hector
we need to make several build passes, in order to build said "sub-dependencies" before the dependencies that depend on them.
101 21 hector
102 21 hector
1. Under SCOLDEPS, check everything except GLSLOPTIMIZER, HLSL2GLSL, HYDRAX, OGRE, OIS, SKYX.
103 21 hector
2. Hit Configure, specifying no toolchain, using your Visual Studio version as generator.
104 21 hector
2. When configuring is done, you will see new variables appear in red. Simply hit Configure again.
105 21 hector
3. Hit Generate to generate a Visual Studio project.
106 21 hector
4. Build the project in Visual Studio (Build->Batch Build, check debug and release for "INSTALL" configuration).
107 21 hector
5. When the build is done, in CMake, check OGRE under SCOLDEPS (leave the other vaiables as they are).
108 21 hector
6. Repeat steps 2 to 4.
109 21 hector
7. Check HYDRAX and SKYX under SCOLDEPS, and repeat steps 2 to 4.
110 21 hector
111 21 hector
Now every required dependency should be built. The ones that we left unchecked aren't needed.
112 7 brainsandwich
113 20 brainsandwich
h3. From Windows, for Android
114 7 brainsandwich
115 20 brainsandwich
Do the same as for Windows target, but
116 20 brainsandwich
* Set source folder to trunk/dependencies and build folder to trunk/scol/build/android/<target abi>
117 20 brainsandwich
* Specify the generator : "NMake"
118 20 brainsandwich
* The toolchain for crosscompile : trunk/dependencies/CMake/toolchain/android.toolchain.cmake
119 20 brainsandwich
* Build dependencies with "nmake install" command from a command line.
120 13 brainsandwich
121 13 brainsandwich
122 19 brainsandwich
123 20 brainsandwich
124 19 brainsandwich
h2. Build the Scol project
125 13 brainsandwich
126 20 brainsandwich
As for the dependencies:
127 13 brainsandwich
128 20 brainsandwich
h3. Windows target
129 3 arkeon
130 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/windows/x86
131 20 brainsandwich
* Configure, generate and build from Visual Studio
132 20 brainsandwich
133 20 brainsandwich
h3. Android target
134 20 brainsandwich
135 20 brainsandwich
* Set source folder to trunk/scol and build folder to trunk/scol/build/android/<target abi>
136 20 brainsandwich
* 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 :
137 20 brainsandwich
  - Open ScolLauncher subproject -> properties
138 20 brainsandwich
  - Configuration Properties -> General -> Configuration Type -> Make Application (ndk-build -> .apk|.so|.a)
139 20 brainsandwich
  - Configuration Properties -> Deployment -> Fast Deploy -> No
140 20 brainsandwich
  - Configuration Properties -> Ant Build -> Skip Ant Step -> No
141 20 brainsandwich
* 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  
142 1 arkeon
143 1 arkeon
h1. Start your new plugin
144 1 arkeon
145 1 arkeon
h2. Source paths
146 1 arkeon
147 1 arkeon
Start by creating a directory with your new plugin name in the trunk/scol/plugins folder.
148 1 arkeon
For example trunk/scol/plugins/myPlugin
149 4 arkeon
150 4 arkeon
Usually we prefer to separate the sources and the includes.
151 1 arkeon
So creates a "src" and "include" directory in your plugin folder.
152 1 arkeon
153 1 arkeon
Creates the empty files you will need for your project, usually :
154 1 arkeon
- include/myplugin.h for your classes declaration
155 1 arkeon
- src/myplugin.cpp for your classes definition
156 1 arkeon
- src/scolplugin.cpp for the Scol binding functions
157 1 arkeon
158 1 arkeon
h2. Dependencies
159 1 arkeon
160 1 arkeon
If your project need an external SDK or dependencies, add then in the trunk/dependencies directory.
161 1 arkeon
Then create a findMydepname.cmake file in trunk\scol\CMake\Packages.
162 1 arkeon
You can copy and change an existing Find.cmake file to make yours.
163 1 arkeon
Start from a simple one like FindMyo.cmake for example.
164 1 arkeon
165 1 arkeon
h2. Cmake files
166 1 arkeon
167 1 arkeon
It's time to creates the CMAKE script for your plugin.
168 1 arkeon
169 1 arkeon
Create a "CMakeLists.txt" file in the plugin directory.
170 1 arkeon
trunk/scol/plugins/myPlugin/CMakeLists.txt
171 1 arkeon
172 1 arkeon
And edit the file with a text editor.
173 1 arkeon
174 1 arkeon
<pre>
175 1 arkeon
#-------------------------------------------------------------------
176 1 arkeon
# This file is part of the CMake build system for Scol
177 1 arkeon
#
178 1 arkeon
# The contents of this file are placed in the public domain. Feel
179 1 arkeon
# free to make use of it in any way you like.
180 1 arkeon
#-------------------------------------------------------------------
181 1 arkeon
182 1 arkeon
############################################################
183 1 arkeon
# CmakeList file for Myplugin
184 1 arkeon
############################################################
185 1 arkeon
186 1 arkeon
#Your project name
187 1 arkeon
PROJECT(myPLugin)
188 1 arkeon
189 1 arkeon
# define header and source files for the library
190 1 arkeon
set (MYPLUGIN_HEADER_FILES
191 1 arkeon
  include/myplugin.h
192 1 arkeon
)
193 1 arkeon
194 1 arkeon
set (MYPLUGIN_SOURCE_FILES
195 1 arkeon
  src/myplugin.cpp
196 1 arkeon
  src/scolplugin.cpp
197 1 arkeon
)
198 1 arkeon
199 1 arkeon
# Add includes directories from dependencies
200 1 arkeon
#  include_directories(include ${MYDEP_INCLUDE_DIRS})
201 1 arkeon
202 1 arkeon
# Add definition for P4 optimizations, warnings removal.
203 1 arkeon
add_definitions(-DOPTI_P4 -D_CRT_SECURE_NO_WARNINGS -D)
204 1 arkeon
205 1 arkeon
# Add dependencies libraries
206 1 arkeon
#  set(LIBRARIES
207 1 arkeon
#    ${MYDEP_LIBRARIES}
208 1 arkeon
#    ${ZLIB_LIBRARIES}
209 1 arkeon
#    ${PNG_LIBRARIES}
210 1 arkeon
#  )
211 1 arkeon
212 1 arkeon
# setup Scol plugin target
213 1 arkeon
add_library(myPLugin
214 1 arkeon
  ${Scol_LIB_TYPE}
215 1 arkeon
  ${MYPLUGIN_HEADER_FILES}
216 1 arkeon
  ${MYPLUGIN_SOURCE_FILES}
217 1 arkeon
)
218 1 arkeon
add_dependencies(myPLugin kernel)
219 1 arkeon
220 1 arkeon
# set the dll version.
221 1 arkeon
set_target_properties(myPLugin PROPERTIES VERSION ${Scol_VERSION} SOVERSION ${Scol_VERSION_MAJOR})
222 1 arkeon
target_link_libraries(myPLugin ${LIBRARIES})
223 1 arkeon
224 1 arkeon
# install Scol
225 1 arkeon
scol_config_plugin(myPLugin)
226 1 arkeon
install(FILES ${MYPLUGIN_HEADER_FILES} DESTINATION include/SCOL/plugins/myPLugin)
227 1 arkeon
</pre>
228 1 arkeon
229 1 arkeon
Now we need to declare this new plugin in the common Scol cmake files.
230 1 arkeon
Edit the trunk/scol/CMakeLists.txt file and add your plugin definition like the following.
231 1 arkeon
232 1 arkeon
If you don't have dependencies.
233 1 arkeon
<pre>
234 1 arkeon
option(Scol_BUILD_MYPLUGIN "Build myPluginplugin, my library" TRUE)
235 1 arkeon
</pre>
236 1 arkeon
237 1 arkeon
If you have depencies
238 1 arkeon
<pre>
239 1 arkeon
cmake_dependent_option(Scol_BUILD_MYPLUGIN "Build myPlugin, my library." TRUE "MYDEP_FOUND;ZLIB_FOUND;PNG_FOUND" FALSE)
240 1 arkeon
</pre>
241 1 arkeon
242 1 arkeon
Now edit the trunk/scol/plugin/CMakeLists.txt file and add the following.
243 1 arkeon
<pre>
244 1 arkeon
# Configure myPlugin plugin build
245 1 arkeon
if (Scol_BUILD_MYPLUGIN)
246 1 arkeon
  add_subdirectory(myPlugin)
247 1 arkeon
endif ()
248 1 arkeon
</pre>
249 1 arkeon
250 1 arkeon
Only if you have dependencies, edit the trunk/scol/CMake/ScolDependencies.cmake file and add the dependencies resolution as the following
251 1 arkeon
252 1 arkeon
<pre>
253 1 arkeon
# Find MyDep
254 1 arkeon
find_package(MYDEP)
255 1 arkeon
macro_log_feature(MYDEP_FOUND "Mydep" "MydepLibrary" "http://Mydep.org/" FALSE "" "")
256 1 arkeon
</pre>
257 1 arkeon
258 1 arkeon
h2. Almost done
259 1 arkeon
260 1 arkeon
Open the CMAKE-gui again.
261 1 arkeon
Hit the "Configure button" and check if you found your plugin in the scol group.
262 1 arkeon
Then hit the generate button, and open the scol.sln project again.
263 1 arkeon
264 1 arkeon
You should have the project added in Visual Studio.