CMakeLists.txt

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