Merge pull request #72 from gh-fork-dump/cmake-fixups

CMake build fixes/improvements

CMakeLists.txt

@@ -1,6 +1,10 @@
 cmake_minimum_required(VERSION 3.13 FATAL_ERROR)
 project(wipeout-rewrite)
 
+if("${PROJECT_SOURCE_DIR}" STREQUAL "${PROJECT_BINARY_DIR}")
+	message(FATAL_ERROR "In-tree builds are not allowed.")
+endif()
+
 include(GNUInstallDirs)
 include(CMakeDependentOption)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
@@ -17,18 +21,27 @@ if(NOT PLATFORM IN_LIST platform_options)
 endif()
 
 set(renderer_options "GL" "GLES2" "SOFTWARE")
-set(gl_renderers "GL" "GLES2")
 set(RENDERER "GL" CACHE STRING "Graphics rendering backend")
 set_property(CACHE RENDERER PROPERTY STRINGS "${renderer_options}")
 if(NOT RENDERER IN_LIST renderer_options)
 	message(FATAL_ERROR "RENDERER must be one of ${renderer_options}")
 endif()
-if(RENDERER IN_LIST gl_renderers)
+if("${RENDERER}" MATCHES "GL(ES2)?")
 	set(using_gl true)
 endif()
+if("${CMAKE_SYSTEM_NAME}" MATCHES "(Linux|FreeBSD)")
+	set(has_glvnd true)
+endif()
 
-cmake_dependent_option(USE_GLVND "Link against modern GLVND ABIs" OFF "using_gl;LINUX" ON)
+cmake_dependent_option(USE_GLVND "Link against modern GLVND ABIs" ON "using_gl;has_glvnd" OFF)
 cmake_dependent_option(MINIMAL_BUNDLE "Do not include music/movies for web builds" OFF "EMSCRIPTEN" OFF)
+option(PATH_ASSETS "Path to where the game assets should be located.")
+option(PATH_USERDATA "Path to where user data (e.g. game saves) should be located.")
+option(DEV_BUILD "Set asset/userdata paths to the source directory for testing" OFF)
+if (DEV_BUILD)
+	set(PATH_ASSETS "${CMAKE_SOURCE_DIR}/")
+	set(PATH_USERDATA "${CMAKE_SOURCE_DIR}/")
+endif()
 
 find_package(OpenGL)
 find_package(GLEW)
@@ -102,6 +115,10 @@ target_compile_options(wipeout PRIVATE
 	$<$<CXX_COMPILER_ID:MSVC>:/W4>
 	$<$<NOT:$<CXX_COMPILER_ID:MSVC>>:-Wall -Wextra>
 )
+target_compile_definitions(wipeout PRIVATE
+	$<$<BOOL:${PATH_ASSETS}>:-DPATH_ASSETS=${PATH_ASSETS}>
+	$<$<BOOL:${PATH_USERDATA}>:-DPATH_USERDATA=${PATH_USERDATA}>
+)
 
 if(WIN32)
 	target_compile_definitions(wipeout PRIVATE
@@ -159,7 +176,7 @@ elseif(EMSCRIPTEN)
 	configure_file("${CMAKE_SOURCE_DIR}/src/wasm-index.html" "game.html" COPYONLY)
 elseif(UNIX)
 	target_link_libraries(wipeout PUBLIC m)
-	if ("${PLATFORM}" STREQUAL "SOKOL" AND UNIX)
+	if ("${PLATFORM}" STREQUAL "SOKOL" AND "${CMAKE_SYSTEM_NAME}" STREQUAL "Linux")
 		find_package(Threads REQUIRED)
 		find_package(X11 REQUIRED)
 		find_package(ALSA REQUIRED)
@@ -179,7 +196,7 @@ if(using_gl)
 	target_sources(wipeout PRIVATE src/render_gl.c)
 
 	target_include_directories(wipeout PUBLIC ${OPENGL_INCLUDE_DIR})
-	if (USE_GLES2)
+	if ("${RENDERER}" STREQUAL "GLES2")
 		target_compile_definitions(wipeout PRIVATE "USE_GLES2")
 		if (TARGET OpenGL::GLES2)
 			target_link_libraries(wipeout PUBLIC OpenGL::GLES2)

README.md

@@ -217,12 +217,14 @@ cmake --build path/to/build-dir
 The following is a table for project specific build flags using CMake:
 
 | Flag             | Description                                                                             | Options                                                                              | Default                                                                                     |
-|------------------|-----------------------------------------------------------------|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
+|------------------|-----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
 | `PLATFORM`       | The platform to build for.                                                              | `SDL2`, `SOKOL`                                                                      | `SDL2`                                                                                      |
 | `RENDERER`       | Graphics renderer.                                                                      | `GL` for OpenGL 3, `GLES2` for OpenGL ES 2, `SOFTWARE` for a pure software renderer. | `GL`                                                                                        |
 | `USE_GLVND`      | Link against the OpenGL Vendor Neutral Dispatch libraries.                              | `ON`, `OFF`                                                                          | `ON`, falling back to `OFF` if the libraries aren't found or an OpenGL renderer isn't used. |
 | `MINIMAL_BUNDLE` | Do not include the music/intro video when building for the web.                         | `ON`, `OFF`                                                                          | `OFF`                                                                                       |
-
+| `PATH_ASSETS`    | Set a static path where the game assets are loaded from.                                | Any valid filesystem path.                                                           | Unset                                                                                       |
+| `PATH_USERDATA`  | Set a static path where user data (e.g. game saves) are stored.                         | Any valid filesystem path.                                                           | Unset                                                                                       |
+| `DEV_BUILD`      | Sets the assets/userdata path to the source directory. Useful when testing any changes. | `ON`, `OFF`                                                                          | `OFF`                                                                                       |
 
 # Running