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