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