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 # You should not need to edit these manually, use util/bump_version.sh
  20 set(VERSION_MAJOR 5)
  21 set(VERSION_MINOR 7)
  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.0mt10)
 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 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
 140         if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "${GCC_MINIMUM_VERSION}")
 141                 message(FATAL_ERROR "Insufficient gcc version, found ${CMAKE_CXX_COMPILER_VERSION}. "
 142                         "Version ${GCC_MINIMUM_VERSION} or higher is required.")
 143         endif()
 144 elseif(CMAKE_CXX_COMPILER_ID MATCHES "(Apple)?Clang")
 145         if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS "${CLANG_MINIMUM_VERSION}")
 146                 message(FATAL_ERROR "Insufficient clang version, found ${CMAKE_CXX_COMPILER_VERSION}. "
 147                         "Version ${CLANG_MINIMUM_VERSION} or higher is required.")
 148         endif()
 149 endif()
 150
 151 # Installation
 152
 153 if(WIN32)
 154         set(SHAREDIR ".")
 155         set(BINDIR "bin")
 156         set(DOCDIR "doc")
 157         set(EXAMPLE_CONF_DIR ".")
 158         set(LOCALEDIR "locale")
 159 elseif(APPLE)
 160         set(BUNDLE_NAME ${PROJECT_NAME}.app)
 161         set(BUNDLE_PATH "${BUNDLE_NAME}")
 162         set(BINDIR ${BUNDLE_NAME}/Contents/MacOS)
 163         set(SHAREDIR ${BUNDLE_NAME}/Contents/Resources)
 164         set(DOCDIR "${SHAREDIR}/${PROJECT_NAME}")
 165         set(EXAMPLE_CONF_DIR ${DOCDIR})
 166         set(LOCALEDIR "${SHAREDIR}/locale")
 167 elseif(UNIX) # Linux, BSD etc
 168         if(RUN_IN_PLACE)
 169                 set(SHAREDIR ".")
 170                 set(BINDIR "bin")
 171                 set(DOCDIR "doc")
 172                 set(EXAMPLE_CONF_DIR ".")
 173                 set(MANDIR "unix/man")
 174                 set(XDG_APPS_DIR "unix/applications")
 175                 set(APPDATADIR "unix/metainfo")
 176                 set(ICONDIR "unix/icons")
 177                 set(LOCALEDIR "locale")
 178         else()
 179                 include(GNUInstallDirs)
 180                 set(SHAREDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME}")
 181                 set(BINDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}")
 182                 set(DOCDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DOCDIR}")
 183                 set(MANDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_MANDIR}")
 184                 set(EXAMPLE_CONF_DIR ${DOCDIR})
 185                 set(XDG_APPS_DIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/applications")
 186                 set(APPDATADIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/metainfo")
 187                 set(ICONDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATADIR}/icons")
 188                 set(LOCALEDIR "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LOCALEDIR}")
 189         endif()
 190 endif()
 191
 192 set(CUSTOM_SHAREDIR "" CACHE STRING "Directory to install data files into")
 193 if(NOT CUSTOM_SHAREDIR STREQUAL "")
 194         set(SHAREDIR "${CUSTOM_SHAREDIR}")
 195         message(STATUS "Using SHAREDIR=${SHAREDIR}")
 196 endif()
 197
 198 set(CUSTOM_BINDIR "" CACHE STRING "Directory to install binaries into")
 199 if(NOT CUSTOM_BINDIR STREQUAL "")
 200         set(BINDIR "${CUSTOM_BINDIR}")
 201         message(STATUS "Using BINDIR=${BINDIR}")
 202 endif()
 203
 204 set(CUSTOM_DOCDIR "" CACHE STRING "Directory to install documentation into")
 205 if(NOT CUSTOM_DOCDIR STREQUAL "")
 206         set(DOCDIR "${CUSTOM_DOCDIR}")
 207         if(NOT RUN_IN_PLACE)
 208                 set(EXAMPLE_CONF_DIR ${DOCDIR})
 209         endif()
 210         message(STATUS "Using DOCDIR=${DOCDIR}")
 211 endif()
 212
 213 set(CUSTOM_MANDIR "" CACHE STRING "Directory to install manpages into")
 214 if(NOT CUSTOM_MANDIR STREQUAL "")
 215         set(MANDIR "${CUSTOM_MANDIR}")
 216         message(STATUS "Using MANDIR=${MANDIR}")
 217 endif()
 218
 219 set(CUSTOM_EXAMPLE_CONF_DIR "" CACHE STRING "Directory to install example config file into")
 220 if(NOT CUSTOM_EXAMPLE_CONF_DIR STREQUAL "")
 221         set(EXAMPLE_CONF_DIR "${CUSTOM_EXAMPLE_CONF_DIR}")
 222         message(STATUS "Using EXAMPLE_CONF_DIR=${EXAMPLE_CONF_DIR}")
 223 endif()
 224
 225 set(CUSTOM_XDG_APPS_DIR "" CACHE STRING "Directory to install .desktop files into")
 226 if(NOT CUSTOM_XDG_APPS_DIR STREQUAL "")
 227         set(XDG_APPS_DIR "${CUSTOM_XDG_APPS_DIR}")
 228         message(STATUS "Using XDG_APPS_DIR=${XDG_APPS_DIR}")
 229 endif()
 230
 231 set(CUSTOM_ICONDIR "" CACHE STRING "Directory to install icons into")
 232 if(NOT CUSTOM_ICONDIR STREQUAL "")
 233         set(ICONDIR "${CUSTOM_ICONDIR}")
 234         message(STATUS "Using ICONDIR=${ICONDIR}")
 235 endif()
 236
 237 set(CUSTOM_LOCALEDIR "" CACHE STRING "Directory to install l10n files into")
 238 if(NOT CUSTOM_LOCALEDIR STREQUAL "")
 239         set(LOCALEDIR "${CUSTOM_LOCALEDIR}")
 240         message(STATUS "Using LOCALEDIR=${LOCALEDIR}")
 241 endif()
 242
 243
 244 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/builtin" DESTINATION "${SHAREDIR}")
 245 if(RUN_IN_PLACE)
 246         install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/mods/mods_here.txt" DESTINATION "${SHAREDIR}/mods")
 247         install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/textures/texture_packs_here.txt" DESTINATION "${SHAREDIR}/textures")
 248 endif()
 249
 250 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/games/minetest_game" DESTINATION "${SHAREDIR}/games/"
 251         COMPONENT "SUBGAME_MINETEST_GAME" OPTIONAL PATTERN ".git*" EXCLUDE )
 252
 253 set(INSTALL_DEVTEST FALSE CACHE BOOL "Install Development Test")
 254
 255 if(INSTALL_DEVTEST)
 256         install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/games/devtest" DESTINATION "${SHAREDIR}/games/"
 257                 PATTERN ".git*" EXCLUDE )
 258 endif()
 259
 260 if(BUILD_CLIENT)
 261         install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/client/shaders" DESTINATION "${SHAREDIR}/client")
 262         install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/textures/base/pack" DESTINATION "${SHAREDIR}/textures/base")
 263         if(RUN_IN_PLACE)
 264                 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/clientmods" DESTINATION "${SHAREDIR}")
 265                 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/client/serverlist" DESTINATION "${SHAREDIR}/client")
 266         endif()
 267 endif()
 268
 269 install(FILES "README.md" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 270 install(FILES "doc/lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 271 install(FILES "doc/client_lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 272 install(FILES "doc/menu_lua_api.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 273 install(FILES "doc/texture_packs.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 274 install(FILES "doc/world_format.txt" DESTINATION "${DOCDIR}" COMPONENT "Docs")
 275 install(FILES "minetest.conf.example" DESTINATION "${EXAMPLE_CONF_DIR}")
 276
 277 if(UNIX AND NOT APPLE)
 278         install(FILES "doc/minetest.6" "doc/minetestserver.6" DESTINATION "${MANDIR}/man6")
 279         install(FILES "misc/net.minetest.minetest.desktop" DESTINATION "${XDG_APPS_DIR}")
 280         install(FILES "misc/net.minetest.minetest.appdata.xml" DESTINATION "${APPDATADIR}")
 281         install(FILES "misc/minetest.svg" DESTINATION "${ICONDIR}/hicolor/scalable/apps")
 282         install(FILES "misc/minetest-xorg-icon-128.png"
 283                 DESTINATION "${ICONDIR}/hicolor/128x128/apps"
 284                 RENAME "minetest.png")
 285 endif()
 286
 287 if(APPLE)
 288         install(FILES "misc/minetest-icon.icns" DESTINATION "${SHAREDIR}")
 289         install(FILES "misc/Info.plist" DESTINATION "${BUNDLE_PATH}/Contents")
 290 endif()
 291
 292 # Library pack
 293 find_package(GMP REQUIRED)
 294 find_package(Json REQUIRED)
 295 find_package(Lua REQUIRED)
 296 if(NOT USE_LUAJIT)
 297         add_subdirectory(lib/bitop)
 298 endif()
 299
 300 if(BUILD_BENCHMARKS)
 301         add_subdirectory(lib/catch2)
 302 endif()
 303
 304 # Subdirectories
 305 # Be sure to add all relevant definitions above this
 306 add_subdirectory(src)
 307
 308 # CPack
 309
 310 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "A free open-source voxel game engine with easy modding and game creation.")
 311 set(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR})
 312 set(CPACK_PACKAGE_VERSION_MINOR ${VERSION_MINOR})
 313 set(CPACK_PACKAGE_VERSION_PATCH ${VERSION_PATCH})
 314 set(CPACK_PACKAGE_VENDOR "celeron55")
 315 set(CPACK_PACKAGE_CONTACT "Perttu Ahola <celeron55@gmail.com>")
 316
 317 include(CPackComponent)
 318
 319 cpack_add_component(Docs
 320         DISPLAY_NAME "Documentation"
 321         DESCRIPTION "Documentation about Minetest and Minetest modding"
 322 )
 323
 324 cpack_add_component(SUBGAME_MINETEST_GAME
 325         DISPLAY_NAME "Minetest Game"
 326         DESCRIPTION "The default game bundled in the Minetest engine. Mainly used as a modding base."
 327         GROUP "Games"
 328 )
 329
 330 cpack_add_component_group(Subgames
 331         DESCRIPTION "Games for the Minetest engine."
 332 )
 333
 334 if(WIN32)
 335         # Include all dynamically linked runtime libraries such as MSVCRxxx.dll
 336         include(InstallRequiredSystemLibraries)
 337
 338         if(RUN_IN_PLACE)
 339                 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 340                         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-win64")
 341                 else()
 342                         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-win32")
 343                 endif()
 344
 345                 set(CPACK_GENERATOR ZIP)
 346
 347         else()
 348                 set(CPACK_GENERATOR WIX)
 349                 set(CPACK_PACKAGE_NAME "${PROJECT_NAME_CAPITALIZED}")
 350                 set(CPACK_PACKAGE_INSTALL_DIRECTORY ".")
 351                 set(CPACK_PACKAGE_EXECUTABLES ${PROJECT_NAME} "${PROJECT_NAME_CAPITALIZED}")
 352                 set(CPACK_CREATE_DESKTOP_LINKS ${PROJECT_NAME})
 353                 set(CPACK_PACKAGING_INSTALL_PREFIX "/${PROJECT_NAME_CAPITALIZED}")
 354
 355                 set(CPACK_WIX_PRODUCT_ICON "${CMAKE_CURRENT_SOURCE_DIR}/misc/minetest-icon.ico")
 356                 # Supported languages can be found at
 357                 # http://wixtoolset.org/documentation/manual/v3/wixui/wixui_localization.html
 358                 #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")
 359                 set(CPACK_WIX_UI_BANNER "${CMAKE_CURRENT_SOURCE_DIR}/misc/CPACK_WIX_UI_BANNER.BMP")
 360                 set(CPACK_WIX_UI_DIALOG "${CMAKE_CURRENT_SOURCE_DIR}/misc/CPACK_WIX_UI_DIALOG.BMP")
 361
 362                 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/doc/lgpl-2.1.txt")
 363
 364                 # The correct way would be to include both x32 and x64 into one installer
 365                 # and install the appropriate one.
 366                 # CMake does not support that, so there are two separate GUID's
 367                 if(CMAKE_SIZEOF_VOID_P EQUAL 8)
 368                         set(CPACK_WIX_UPGRADE_GUID "745A0FB3-5552-44CA-A587-A91C397CCC56")
 369                 else()
 370                         set(CPACK_WIX_UPGRADE_GUID "814A2E2D-2779-4BBD-9ACD-FC3BD51FBBA2")
 371                 endif()
 372         endif()
 373 elseif(APPLE)
 374         set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY 0)
 375         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-osx")
 376         set(CPACK_GENERATOR ZIP)
 377 else()
 378         set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${VERSION_STRING}-linux")
 379         set(CPACK_GENERATOR TGZ)
 380         set(CPACK_SOURCE_GENERATOR TGZ)
 381 endif()
 382
 383 include(CPack)
 384
 385
 386 # Add a target to generate API documentation with Doxygen
 387 find_package(Doxygen)
 388 if(DOXYGEN_FOUND)
 389         configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile.in
 390                         ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile @ONLY)
 391         add_custom_target(doc
 392                 ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile
 393                 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc
 394                 COMMENT "Generating API documentation with Doxygen" VERBATIM
 395         )
 396 endif()