CMakeLists.txt

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