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