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