CMakeLists.txt

   1 cmake_minimum_required(VERSION 3.5)
   2
   3 # This can be read from ${PROJECT_NAME} after project() is called
   4 project(minetest)
   5 set(PROJECT_NAME_CAPITALIZED "Minetest")
   6
   7 set(CMAKE_CXX_STANDARD 11)
   8 set(GCC_MINIMUM_VERSION "4.8")
   9 set(CLANG_MINIMUM_VERSION "3.4")
  10
  11 # Also remember to set PROTOCOL_VERSION in network/networkprotocol.h when releasing
  12 set(VERSION_MAJOR 5)
  13 set(VERSION_MINOR 5)
  14 set(VERSION_PATCH 0)
  15 set(VERSION_EXTRA "" CACHE STRING "Stuff to append to version string")
  16
  17 # Change to false for releases
  18 set(DEVELOPMENT_BUILD TRUE)
  19
  20 set(VERSION_STRING "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}")
  21 if(VERSION_EXTRA)
  22         set(VERSION_STRING ${VERSION_STRING}-${VERSION_EXTRA})
  23 elseif(DEVELOPMENT_BUILD)
  24         set(VERSION_STRING "${VERSION_STRING}-dev")
  25 endif()
  26
  27 if (CMAKE_BUILD_TYPE STREQUAL Debug)
  28         # Append "-debug" to version string
  29         set(VERSION_STRING "${VERSION_STRING}-debug")
  30 endif()
  31
  32 message(STATUS "*** Will build version ${VERSION_STRING} ***")
  33
  34
  35 # Configuration options
  36 set(DEFAULT_RUN_IN_PLACE FALSE)
  37 if(WIN32)
  38         set(DEFAULT_RUN_IN_PLACE TRUE)
  39 endif()
  40 set(RUN_IN_PLACE ${DEFAULT_RUN_IN_PLACE} CACHE BOOL
  41         "Run directly in source directory structure")
  42
  43
  44 set(BUILD_CLIENT TRUE CACHE BOOL "Build client")
  45 set(BUILD_SERVER FALSE CACHE BOOL "Build server")
  46 set(BUILD_UNITTESTS TRUE CACHE BOOL "Build unittests")
  47
  48
  49 set(WARN_ALL TRUE CACHE BOOL "Enable -Wall for Release build")
  50
  51 if(NOT CMAKE_BUILD_TYPE)
  52         # Default to release
  53         set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type: Debug or Release" FORCE)
  54 endif()
  55
  56 # Included stuff
  57 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules/")
  58
  59
  60 # This is done here so that relative search paths are more reasonable
  61 if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/lib/irrlichtmt")
  62         message(STATUS "Using user-provided IrrlichtMt at subdirectory 'lib/irrlichtmt'")
  63         # tell IrrlichtMt to create a static library
  64         set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build shared library" FORCE)
  65         add_subdirectory(lib/irrlichtmt EXCLUDE_FROM_ALL)
  66         unset(BUILD_SHARED_LIBS CACHE)
  67
  68         if(NOT TARGET IrrlichtMt)
  69                 message(FATAL_ERROR "IrrlichtMt project is missing a CMake target?!")
  70         endif()
  71
  72         # set include dir the way it would normally be
  73         set(IRRLICHT_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/lib/irrlichtmt/include")
  74         set(IRRLICHT_LIBRARY IrrlichtMt)
  75 else()
  76         find_package(Irrlicht)
  77         if(BUILD_CLIENT AND NOT IRRLICHT_FOUND)
  78                 message(FATAL_ERROR "IrrlichtMt is required to build the client, but it was not found.")
  79         elseif(NOT IRRLICHT_INCLUDE_DIR)
  80                 message(FATAL_ERROR "Irrlicht or IrrlichtMt headers are required to build the server, but none found.")
  81         endif()
  82 endif()
  83
  84 include(CheckSymbolExists)
  85 set(CMAKE_REQUIRED_INCLUDES ${IRRLICHT_INCLUDE_DIR})
  86 unset(HAS_FORKED_IRRLICHT CACHE)
  87 check_symbol_exists(IRRLICHT_VERSION_MT "IrrCompileConfig.h" HAS_FORKED_IRRLICHT)
  88 if(NOT HAS_FORKED_IRRLICHT)
  89         string(CONCAT EXPLANATION_MSG
  90                 "Irrlicht found, but it is not IrrlichtMt (Minetest's Irrlicht fork). "
  91                 "The Minetest team has forked Irrlicht to make their own customizations. "
  92                 "It can be found here: https://github.com/minetest/irrlicht")
  93         if(BUILD_CLIENT)
  94                 message(FATAL_ERROR "${EXPLANATION_MSG}\n"
  95                         "Building the client with upstream Irrlicht is no longer possible.")
  96         else()
  97                 message(WARNING "${EXPLANATION_MSG}\n"
  98                         "The server can still be built with upstream Irrlicht but this is DISCOURAGED.")
  99         endif()
 100 endif()
 101
 102
 103 # Installation
 104
 105 if(WIN32)
 106         set(SHAREDIR ".")
 107         set(BINDIR "bin")
 108         set(DOCDIR "doc")
 109         set(EXAMPLE_CONF_DIR ".")
 110         set(LOCALEDIR "locale")
 111 elseif(APPLE)
 112         set(BUNDLE_NAME ${PROJECT_NAME}.app)
 113         set(BUNDLE_PATH "${BUNDLE_NAME}")
 114         set(BINDIR ${BUNDLE_NAME}/Contents/MacOS)
 115         set(SHAREDIR ${BUNDLE_NAME}/Contents/Resources)
 116         set(DOCDIR "${SHAREDIR}/${PROJECT_NAME}")
 117         set(EXAMPLE_CONF_DIR ${DOCDIR})
 118         set(LOCALEDIR "${SHAREDIR}/locale")
 119 elseif(UNIX) # Linux, BSD etc
 120         if(RUN_IN_PLACE)
 121                 set(SHAREDIR ".")
 122                 set(BINDIR "bin")
 123                 set(DOCDIR "doc")
 124                 set(EXAMPLE_CONF_DIR ".")
 125                 set(MANDIR "unix/man")
 126                 set(XDG_APPS_DIR "unix/applications")
 127                 set(APPDATADIR "unix/metainfo")
 128                 set(ICONDIR "unix/icons")
 129                 set(LOCALEDIR "locale")
 130         else()
 131                 set(SHAREDIR "${CMAKE_INSTALL_PREFIX}/share/${PROJECT_NAME}")
 132                 set(BINDIR "${CMAKE_INSTALL_PREFIX}/bin")
 133                 set(DOCDIR "${CMAKE_INSTALL_PREFIX}/share/doc/${PROJECT_NAME}")
 134                 set(MANDIR "${CMAKE_INSTALL_PREFIX}/share/man")
 135                 set(EXAMPLE_CONF_DIR ${DOCDIR})
 136                 set(XDG_APPS_DIR "${CMAKE_INSTALL_PREFIX}/share/applications")
 137                 set(APPDATADIR "${CMAKE_INSTALL_PREFIX}/share/metainfo")
 138                 set(ICONDIR "${CMAKE_INSTALL_PREFIX}/share/icons")
 139                 set(LOCALEDIR "${CMAKE_INSTALL_PREFIX}/share/locale")
 140         endif()
 141 endif()
 142
 143 set(CUSTOM_SHAREDIR "" CACHE STRING "Directory to install data files into")
 144 if(NOT CUSTOM_SHAREDIR STREQUAL "")
 145         set(SHAREDIR "${CUSTOM_SHAREDIR}")
 146         message(STATUS "Using SHAREDIR=${SHAREDIR}")
 147 endif()
 148
 149 set(CUSTOM_BINDIR "" CACHE STRING "Directory to install binaries into")
 150 if(NOT CUSTOM_BINDIR STREQUAL "")
 151         set(BINDIR "${CUSTOM_BINDIR}")
 152         message(STATUS "Using BINDIR=${BINDIR}")
 153 endif()
 154
 155 set(CUSTOM_DOCDIR "" CACHE STRING "Directory to install documentation into")
 156 if(NOT CUSTOM_DOCDIR STREQUAL "")
 157         set(DOCDIR "${CUSTOM_DOCDIR}")
 158         if(NOT RUN_IN_PLACE)
 159                 set(EXAMPLE_CONF_DIR ${DOCDIR})
 160         endif()
 161         message(STATUS "Using DOCDIR=${DOCDIR}")
 162 endif()
 163
 164 set(CUSTOM_MANDIR "" CACHE STRING "Directory to install manpages into")
 165 if(NOT CUSTOM_MANDIR STREQUAL "")
 166         set(MANDIR "${CUSTOM_MANDIR}")
 167         message(STATUS "Using MANDIR=${MANDIR}")
 168 endif()
 169
 170 set(CUSTOM_EXAMPLE_CONF_DIR "" CACHE STRING "Directory to install example config file into")
 171 if(NOT CUSTOM_EXAMPLE_CONF_DIR STREQUAL "")
 172         set(EXAMPLE_CONF_DIR "${CUSTOM_EXAMPLE_CONF_DIR}")
 173         message(STATUS "Using EXAMPLE_CONF_DIR=${EXAMPLE_CONF_DIR}")
 174 endif()
 175
 176 set(CUSTOM_XDG_APPS_DIR "" CACHE STRING "Directory to install .desktop files into")
 177 if(NOT CUSTOM_XDG_APPS_DIR STREQUAL "")
 178         set(XDG_APPS_DIR "${CUSTOM_XDG_APPS_DIR}")
 179         message(STATUS "Using XDG_APPS_DIR=${XDG_APPS_DIR}")
 180 endif()
 181
 182 set(CUSTOM_ICONDIR "" CACHE STRING "Directory to install icons into")
 183 if(NOT CUSTOM_ICONDIR STREQUAL "")
 184         set(ICONDIR "${CUSTOM_ICONDIR}")
 185         message(STATUS "Using ICONDIR=${ICONDIR}")
 186 endif()
 187
 188 set(CUSTOM_LOCALEDIR "" CACHE STRING "Directory to install l10n files into")
 189 if(NOT CUSTOM_LOCALEDIR STREQUAL "")
 190         set(LOCALEDIR "${CUSTOM_LOCALEDIR}")
 191         message(STATUS "Using LOCALEDIR=${LOCALEDIR}")
 192 endif()
 193
 194
 195 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/builtin" DESTINATION "${SHAREDIR}")
 196 if(RUN_IN_PLACE)
 197         install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/mods/mods_here.txt" DESTINATION "${SHAREDIR}/mods")
 198         install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/textures/texture_packs_here.txt" DESTINATION "${SHAREDIR}/textures")
 199 endif()
 200
 201 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/games/minetest_game" DESTINATION "${SHAREDIR}/games/"
 202         COMPONENT "SUBGAME_MINETEST_GAME" OPTIONAL PATTERN ".git*" EXCLUDE )
 203 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/games/devtest" DESTINATION "${SHAREDIR}/games/"
 204         COMPONENT "SUBGAME_MINIMAL" OPTIONAL PATTERN ".git*" EXCLUDE )
 205
 206 if(BUILD_CLIENT)
 207         install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/client/shaders" DESTINATION "${SHAREDIR}/client")
 208         install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/textures/base/pack" DESTINATION "${SHAREDIR}/textures/base")
 209         if(RUN_IN_PLACE)
 210                 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/clientmods" DESTINATION "${SHAREDIR}")
 211                 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/client/serverlist" DESTINATION "${SHAREDIR}/client")
 212         endif()
 213 endif()
 214
 215 install(FILES "README.md" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 216 install(FILES "doc/lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 217 install(FILES "doc/client_lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 218 install(FILES "doc/menu_lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 219 install(FILES "doc/texture_packs.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 220 install(FILES "doc/world_format.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 221 install(FILES "minetest.conf.example" DESTINATION "${EXAMPLE_CONF_DIR}")
 222
 223 if(UNIX AND NOT APPLE)
 224         install(FILES "doc/minetest.6" "doc/minetestserver.6" DESTINATION "${MANDIR}/man6")
 225         install(FILES "misc/net.minetest.minetest.desktop" DESTINATION "${XDG_APPS_DIR}")
 226         install(FILES "misc/net.minetest.minetest.appdata.xml" DESTINATION "${APPDATADIR}")
 227         install(FILES "misc/minetest.svg" DESTINATION "${ICONDIR}/hicolor/scalable/apps")
 228         install(FILES "misc/minetest-xorg-icon-128.png"
 229                 DESTINATION "${ICONDIR}/hicolor/128x128/apps"
 230                 RENAME "minetest.png")
 231 endif()
 232
 233 if(APPLE)
 234         install(FILES "misc/minetest-icon.icns" DESTINATION "${SHAREDIR}")
 235         install(FILES "misc/Info.plist" DESTINATION "${BUNDLE_PATH}/Contents")
 236 endif()
 237
 238 # Library pack
 239 find_package(GMP REQUIRED)
 240 find_package(Json REQUIRED)
 241 find_package(Lua REQUIRED)
 242
 243 # JsonCpp doesn't compile well on GCC 4.8
 244 if(NOT USE_SYSTEM_JSONCPP)
 245         set(GCC_MINIMUM_VERSION "4.9")
 246 endif()
 247
 248 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
 249         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "${GCC_MINIMUM_VERSION}")
 250                 message(FATAL_ERROR "Insufficient gcc version, found ${CMAKE_CXX_COMPILER_VERSION}. "
 251                         "Version ${GCC_MINIMUM_VERSION} or higher is required.")
 252         endif()
 253 elseif(CMAKE_CXX_COMPILER_ID MATCHES "(Apple)?Clang")
 254         if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "${CLANG_MINIMUM_VERSION}")
 255                 message(FATAL_ERROR "Insufficient clang version, found ${CMAKE_CXX_COMPILER_VERSION}. "
 256                         "Version ${CLANG_MINIMUM_VERSION} or higher is required.")
 257         endif()
 258 endif()
 259
 260 # Subdirectories
 261 # Be sure to add all relevant definitions above this
 262
 263 add_subdirectory(src)
 264
 265
 266 # CPack
 267
 268 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "A free open-source voxel game engine with easy modding and game creation.")
 269 set(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR})
 270 set(CPACK_PACKAGE_VERSION_MINOR ${VERSION_MINOR})
 271 set(CPACK_PACKAGE_VERSION_PATCH ${VERSION_PATCH})
 272 set(CPACK_PACKAGE_VENDOR "celeron55")
 273 set(CPACK_PACKAGE_CONTACT "Perttu Ahola <celeron55@gmail.com>")
 274
 275 include(CPackComponent)
 276
 277 cpack_add_component(Docs
 278         DISPLAY_NAME "Documentation"
 279         DESCRIPTION "Documentation about Minetest and Minetest modding"
 280 )
 281
 282 cpack_add_component(SUBGAME_MINETEST_GAME
 283         DISPLAY_NAME "Minetest Game"
 284         DESCRIPTION "The default game bundled in the Minetest engine. Mainly used as a modding base."
 285         GROUP "Games"
 286 )
 287
 288 cpack_add_component(SUBGAME_MINIMAL
 289         DISPLAY_NAME "Development Test"
 290         DESCRIPTION "A basic testing environment used for engine development and sometimes for testing mods."
 291         DISABLED #DISABLED does not mean it is disabled, and is just not selected by default.
 292         GROUP "Games"
 293 )
 294
 295 cpack_add_component_group(Subgames
 296         DESCRIPTION "Games for the Minetest engine."
 297 )
 298
 299 if(WIN32)
 300         # Include all dynamically linked runtime libaries such as MSVCRxxx.dll
 301         include(InstallRequiredSystemLibraries)
 302
 303         if(RUN_IN_PLACE)
 304                 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 305                         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-win64")
 306                 else()
 307                         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-win32")
 308                 endif()
 309
 310                 set(CPACK_GENERATOR ZIP)
 311
 312         else()
 313                 set(CPACK_GENERATOR WIX)
 314                 set(CPACK_PACKAGE_NAME "${PROJECT_NAME_CAPITALIZED}")
 315                 set(CPACK_PACKAGE_INSTALL_DIRECTORY ".")
 316                 set(CPACK_PACKAGE_EXECUTABLES ${PROJECT_NAME} "${PROJECT_NAME_CAPITALIZED}")
 317                 set(CPACK_CREATE_DESKTOP_LINKS ${PROJECT_NAME})
 318                 set(CPACK_PACKAGING_INSTALL_PREFIX "/${PROJECT_NAME_CAPITALIZED}")
 319
 320                 set(CPACK_WIX_PRODUCT_ICON "${CMAKE_CURRENT_SOURCE_DIR}/misc/minetest-icon.ico")
 321                 # Supported languages can be found at
 322                 # http://wixtoolset.org/documentation/manual/v3/wixui/wixui_localization.html
 323                 #set(CPACK_WIX_CULTURES "ar-SA,bg-BG,ca-ES,hr-HR,cs-CZ,da-DK,nl-NL,en-US,et-EE,fi-FI,fr-FR,de-DE")
 324                 set(CPACK_WIX_UI_BANNER "${CMAKE_CURRENT_SOURCE_DIR}/misc/CPACK_WIX_UI_BANNER.BMP")
 325                 set(CPACK_WIX_UI_DIALOG "${CMAKE_CURRENT_SOURCE_DIR}/misc/CPACK_WIX_UI_DIALOG.BMP")
 326
 327                 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/doc/lgpl-2.1.txt")
 328
 329                 # The correct way would be to include both x32 and x64 into one installer
 330                 # and install the appropriate one.
 331                 # CMake does not support that, so there are two separate GUID's
 332                 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 333                         set(CPACK_WIX_UPGRADE_GUID "745A0FB3-5552-44CA-A587-A91C397CCC56")
 334                 else()
 335                         set(CPACK_WIX_UPGRADE_GUID "814A2E2D-2779-4BBD-9ACD-FC3BD51FBBA2")
 336                 endif()
 337         endif()
 338 elseif(APPLE)
 339         set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY 0)
 340         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-osx")
 341         set(CPACK_GENERATOR ZIP)
 342 else()
 343         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-linux")
 344         set(CPACK_GENERATOR TGZ)
 345         set(CPACK_SOURCE_GENERATOR TGZ)
 346 endif()
 347
 348 include(CPack)
 349
 350
 351 # Add a target to generate API documentation with Doxygen
 352 find_package(Doxygen)
 353 if(DOXYGEN_FOUND)
 354         configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in
 355                         ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile @ONLY)
 356         add_custom_target(doc
 357                 ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile
 358                 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc
 359                 COMMENT "Generating API documentation with Doxygen" VERBATIM
 360         )
 361 endif()