CMakeLists.txt

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