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