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