Port to web

.github/workflows/build-engine-web.yml

@@ -0,0 +1,72 @@
+name: 🌐 Build Engine Web
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+env:
+  BUILD_TYPE: Release
+  CCACHE_BASEDIR: ${{ github.workspace }}
+  CCACHE_DIR: "${{ github.workspace }}/.ccache"
+  CCACHE_COMPILERTYPE: emcc
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install ccache
+
+    - name: Install emsdk
+      uses: mymindstorm/setup-emsdk@v14
+
+    - name: Get timestamp
+      shell: bash
+      id: ccache_vars
+      run: |
+        echo "timestamp=$(date +%s)" >> $GITHUB_OUTPUT
+
+    - uses: actions/cache@v4
+      with:
+        path: ${{ env.CCACHE_DIR }}
+        key: ccache-${{ env.CCACHE_COMPILERTYPE }}-${{ env.BUILD_TYPE }}-${{ github.ref }}-${{ steps.ccache_vars.outputs.timestamp }}
+        restore-keys: |
+          ccache-${{ env.CCACHE_COMPILERTYPE }}-${{ env.BUILD_TYPE }}-${{ github.ref }}-
+          ccache-${{ env.CCACHE_COMPILERTYPE }}-${{ env.BUILD_TYPE }}-
+          ccache-${{ env.CCACHE_COMPILERTYPE }}-
+          ccache-
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCUBOS_CORE_SAMPLES=ON  -DCUBOS_ENGINE_SAMPLES=ON -DCMAKE_TOOLCHAIN_FILE=${EMSDK}/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake
+      shell: bash
+
+    - name: CCache Prolog
+      run: |-
+        ccache -s # Print current cache stats
+        ccache -z # Zero cache entry
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --target all
+
+    - name: CCache Epilog
+      run: |
+        ccache -s # Print current cache stats
+
+    - name: Copy results
+      run: |
+          mkdir -p ${{github.workspace}}/results
+          cp ${{github.workspace}}/build/*.{js,wasm,html} ${{github.workspace}}/results
+
+    - name: Upload results
+      uses: actions/upload-artifact@v4
+      with:
+        name: emscripten
+        path: ${{github.workspace}}/results

.gitignore

@@ -403,4 +403,6 @@ imgui.ini
 /.envrc
 /.direnv
 
-.DS_store
+.DS_store
+
+.em_cache

CHANGELOG.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Audio Plugin (#1004, **@Dageus**, **@diogomsmiranda**).
 - Contact caching for collision between box shapes (#1355, **@fallenatlas**).
 - Template Cubos project (#1009, **@RiscadoA**).
+- Web support, through Emscripten (#465, **@luishfonseca**, **@RiscadoA**).
 
 ### Changed
 

CMakeLists.txt

@@ -124,6 +124,22 @@ function(cubos_common_target_options target)
             set_target_properties(${target} PROPERTIES CXX_CLANG_TIDY "${CLANG_TIDY_COMMAND}")
         endif()
     endif()
+
+    if(EMSCRIPTEN)
+        target_link_options(${target} PUBLIC
+            -sASSERTIONS=1
+            -pthread
+            -sPTHREAD_POOL_SIZE=navigator.hardwareConcurrency
+            -sENVIRONMENT=web,worker
+            -sMINIFY_HTML=0
+            -sINITIAL_MEMORY=128MB
+            -sSTACK_SIZE=1MB
+        )
+
+        target_compile_options(${target} PUBLIC -pthread)
+
+        set_target_properties(${target} PROPERTIES SUFFIX ".html")
+    endif()
 endfunction()
 
 # -------------- Fetch dependencies common to multiple libraries --------------

api/core/CMakeLists.txt

@@ -1,6 +1,11 @@
 option(BUILD_API_CORE_SAMPLES "Build cubos core c api samples" OFF)
 option(BUILD_API_CORE_SHARED "Build cubos core c api as shared library?" ON)
 
+if (EMSCRIPTEN AND BUILD_API_CORE_SHARED)
+	message(WARNING "Cannot build API core as shared library on Emscripten")
+	set(BUILD_API_CORE_SHARED OFF)
+endif()
+
 message("# Building core c api samples: " ${BUILD_API_CORE_SAMPLES})
 message("# Building core c api as shared library: " ${BUILD_API_CORE_SHARED})
 

api/engine/CMakeLists.txt

@@ -5,6 +5,11 @@ set(CUBOS_API_ENGINE_SOURCE
 option(BUILD_API_ENGINE_SAMPLES "Build cubos engine c api samples" OFF)
 option(BUILD_API_ENGINE_SHARED "Build cubos engine c api as shared library?" ON)
 
+if (EMSCRIPTEN AND BUILD_API_ENGINE_SHARED)
+	message(WARNING "Cannot build API engine as shared library on Emscripten")
+	set(BUILD_API_ENGINE_SHARED OFF)
+endif()
+
 message("# Building engine c api samples: " ${BUILD_API_ENGINE_SAMPLES})
 message("# Building engine c api as shared library: " ${BUILD_API_ENGINE_SHARED})
 

cmake/cubos-config.cmake.in

@@ -2,21 +2,28 @@ include(CMakeFindDependencyMacro)
 
 if(NOT @CUBOS_CORE_SHARED@)
     find_dependency(Threads)
-    find_dependency(cpptrace REQUIRED)
-
-    if(@CUBOS_CORE_OPENGL@)
-        find_dependency(glad REQUIRED)
-    endif()
 
-    if(@CUBOS_CORE_GLFW@)
-        find_dependency(glfw3 REQUIRED)
+    if(NOT EMSCRIPTEN)
+        find_dependency(cpptrace REQUIRED)
+
+        if(@CUBOS_CORE_OPENGL@)
+            find_dependency(glad REQUIRED)
+        endif()
+
+        if(@CUBOS_CORE_GLFW@)
+            find_dependency(glfw3 REQUIRED)
+        endif()
     endif()
 endif()
 
 find_dependency(stduuid REQUIRED)
 find_dependency(nlohmann_json REQUIRED)
 find_dependency(glm REQUIRED)
 
+if(NOT @CUBOS_ENGINE_SHARED@)
+    find_dependency(msdf-atlas-gen REQUIRED)
+endif()
+
 set(CUBOS_ENGINE_ASSETS_PATH "${CMAKE_CURRENT_LIST_DIR}/@CUBOS_ENGINE_ASSETS_INSTALL_RELPATH@")
 
 if(NOT TARGET cubos::core)

core/CMakeLists.txt

@@ -18,6 +18,11 @@ message("# Building cubos::core samples: " ${CUBOS_CORE_SAMPLES})
 message("# Building cubos::core tests: " ${CUBOS_CORE_TESTS})
 message("# Building cubos::core as shared library: " ${CUBOS_CORE_SHARED})
 
+if (EMSCRIPTEN AND CUBOS_CORE_SHARED)
+	message(WARNING "Cannot build core as shared library on Emscripten")
+	set(CUBOS_CORE_SHARED OFF CACHE BOOL "Build cubos::core as shared library?" FORCE)
+endif()
+
 # --------------------- Define core library source files ----------------------
 
 set(CUBOS_CORE_SOURCE
@@ -178,67 +183,84 @@ endif()
 target_compile_options(cubos-core PRIVATE -DCUBOS_CORE_METRIC_MAX_ENTRIES=${CUBOS_CORE_METRIC_MAX_ENTRIES})
 
 # Link small libraries
-set(THREADS_PREFER_PTHREAD_FLAG ON)
-find_package(Threads REQUIRED)
 target_link_libraries(cubos-core PUBLIC ${CMAKE_DL_LIBS})
-target_link_libraries(cubos-core PRIVATE Threads::Threads)
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+if(NOT EMSCRIPTEN)
+	find_package(Threads REQUIRED)
+	target_link_libraries(cubos-core PRIVATE Threads::Threads)
+endif()
 
 # ------------- Fetch and link core private library dependencies --------------
 
 include(FetchContent)
 
-# Fetch and link cpptrace
-FetchContent_Declare(
-    cpptrace
-    GIT_REPOSITORY https://github.com/jeremy-rifkin/cpptrace.git
-    GIT_TAG        v0.7.1
-	SYSTEM
-	FIND_PACKAGE_ARGS
-)
-FetchContent_MakeAvailable(cpptrace)
-target_link_libraries(cubos-core PRIVATE cpptrace::cpptrace)
-
-# If OpenGL support is enabled, fetch and link glad
-if(CUBOS_CORE_OPENGL)
+if(NOT EMSCRIPTEN)
+	# Fetch and link cpptrace - only available (and needed) on non-Emscripten platforms
 	FetchContent_Declare(
-		glad
-		GIT_REPOSITORY https://github.com/GameDevTecnico/cubos-glad.git
-		GIT_TAG        496c56587442591557a89551d90906b1c53f639f
+		cpptrace
+		GIT_REPOSITORY https://github.com/jeremy-rifkin/cpptrace.git
+		GIT_TAG        v0.7.1
 		SYSTEM
+		FIND_PACKAGE_ARGS
 	)
-	if(CUBOS_CORE_SHARED)
-		set(GLAD_INSTALL OFF CACHE BOOL "Don't install glad" FORCE)
+	FetchContent_MakeAvailable(cpptrace)
+	target_link_libraries(cubos-core PRIVATE cpptrace::cpptrace)
+endif()
+
+# If OpenGL support is enabled, fetch and link glad
+if(CUBOS_CORE_OPENGL)
+	if(EMSCRIPTEN)
+		# Unless we're on Emscripten, which statically links to OpenGL for us, and is thus more efficient
+		# than using glad
+		target_link_libraries(cubos-core PRIVATE GL)
+		target_link_options(cubos-core PUBLIC -sMIN_WEBGL_VERSION=2 -sMAX_WEBGL_VERSION=2)
 	else()
-		set(GLAD_INSTALL ${CUBOS_ENABLE_INSTALL} CACHE BOOL "Install glad" FORCE)
-	endif()
-	FetchContent_MakeAvailable(glad)
-	if(CUBOS_CORE_SHARED)
-		set_target_properties(glad PROPERTIES POSITION_INDEPENDENT_CODE ON)
+		FetchContent_Declare(
+			glad
+			GIT_REPOSITORY https://github.com/GameDevTecnico/cubos-glad.git
+			GIT_TAG        bdf4d66072830f9822512f8f7dc3ca3fd72d9f69
+			SYSTEM
+		)
+		if(CUBOS_CORE_SHARED)
+			set(GLAD_INSTALL OFF CACHE BOOL "Don't install glad" FORCE)
+		else()
+			set(GLAD_INSTALL ${CUBOS_ENABLE_INSTALL} CACHE BOOL "Install glad" FORCE)
+		endif()
+		FetchContent_MakeAvailable(glad)
+		if(CUBOS_CORE_SHARED)
+			set_target_properties(glad PROPERTIES POSITION_INDEPENDENT_CODE ON)
+		endif()
+		target_link_libraries(cubos-core PRIVATE glad)
+		target_compile_definitions(cubos-core PRIVATE GLAD_GLAPI_EXPORT GLAD_GLAPI_EXPORT_BUILD)
 	endif()
-	target_link_libraries(cubos-core PRIVATE glad)
-	target_compile_definitions(cubos-core PRIVATE CUBOS_CORE_OPENGL GLAD_GLAPI_EXPORT GLAD_GLAPI_EXPORT_BUILD)
+	target_compile_definitions(cubos-core PRIVATE CUBOS_CORE_OPENGL)
 endif()
 
 # If GLFW support is enabled, fetch and link it
 if(CUBOS_CORE_GLFW)
-	FetchContent_Declare(
-		glfw
-		GIT_REPOSITORY https://github.com/glfw/glfw.git
-		GIT_TAG        3.3.8
-		SYSTEM 
-		FIND_PACKAGE_ARGS NAMES glfw3
-	)
-
-	set(GLFW_BUILD_EXAMPLES OFF CACHE BOOL "Don't build GLFW examples" FORCE)
-	set(GLFW_BUILD_TESTS OFF CACHE BOOL "Don't build GLFW tests" FORCE)
-	set(GLFW_BUILD_DOCS OFF CACHE BOOL "Don't build GLFW documentation" FORCE)
-	if(CUBOS_CORE_SHARED)
-		set(GLFW_INSTALL OFF CACHE BOOL "Don't install GLFW" FORCE)
+	if(EMSCRIPTEN)
+		# Emscripten ships its own GLFW
+        target_link_options(cubos-core PUBLIC -sUSE_GLFW=3)
 	else()
-		set(GLFW_INSTALL ${CUBOS_ENABLE_INSTALL} CACHE BOOL "Don't install GLFW" FORCE)
+		FetchContent_Declare(
+			glfw
+			GIT_REPOSITORY https://github.com/glfw/glfw.git
+			GIT_TAG        3.3.8
+			SYSTEM 
+			FIND_PACKAGE_ARGS NAMES glfw3
+		)
+
+		set(GLFW_BUILD_EXAMPLES OFF CACHE BOOL "Don't build GLFW examples" FORCE)
+		set(GLFW_BUILD_TESTS OFF CACHE BOOL "Don't build GLFW tests" FORCE)
+		set(GLFW_BUILD_DOCS OFF CACHE BOOL "Don't build GLFW documentation" FORCE)
+		if(CUBOS_CORE_SHARED)
+			set(GLFW_INSTALL OFF CACHE BOOL "Don't install GLFW" FORCE)
+		else()
+			set(GLFW_INSTALL ${CUBOS_ENABLE_INSTALL} CACHE BOOL "Don't install GLFW" FORCE)
+		endif()
+		set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build GLFW as a static library" FORCE)
+		FetchContent_MakeAvailable(glfw)
 	endif()
-	set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build GLFW as a static library" FORCE)
-	FetchContent_MakeAvailable(glfw)
 
 	target_link_libraries(cubos-core PRIVATE glfw)
 	target_compile_definitions(cubos-core PRIVATE CUBOS_CORE_GLFW)

core/include/cubos/core/ecs/cubos.hpp

@@ -90,6 +90,10 @@ namespace cubos::core::ecs
         /// @param argv Argument array.
         Cubos(int argc, char** argv);
 
+        /// @brief Move constructs.
+        /// @param other Other application.
+        Cubos(Cubos&& other) noexcept;
+
         /// @name Forbid copying.
         /// @{
         Cubos(const Cubos&) = delete;
@@ -324,7 +328,7 @@ namespace cubos::core::ecs
         /// @param plugin Plugin.
         void uninstall(Plugin plugin);
 
-        World mWorld;
+        World* mWorld;
         SystemRegistry mSystemRegistry;
         State* mState{nullptr};
 
@@ -397,7 +401,7 @@ namespace cubos::core::ecs
         TagBuilder& runIf(auto func)
         {
             auto conditionId = mCubos.mSystemRegistry.add(mName + "#condition",
-                                                          System<bool>::make(mCubos.mWorld, std::move(func), {}));
+                                                          System<bool>::make(*mCubos.mWorld, std::move(func), {}));
             mPlanner.onlyIf(mTagId, conditionId);
             return *this;
         }
@@ -408,7 +412,7 @@ namespace cubos::core::ecs
         TagBuilder& repeatWhile(auto func)
         {
             auto conditionId =
-                mCubos.mSystemRegistry.add(mName, System<bool>::make(mCubos.mWorld, std::move(func), {}));
+                mCubos.mSystemRegistry.add(mName, System<bool>::make(*mCubos.mWorld, std::move(func), {}));
             CUBOS_ASSERT(mPlanner.repeatWhile(mTagId, conditionId), "Tag was already set to repeating");
             return *this;
         }
@@ -544,15 +548,15 @@ namespace cubos::core::ecs
         SystemBuilder&& onlyIf(auto function) &&
         {
             CUBOS_ASSERT(!mCondition.contains(), "Only one condition can be set per system");
-            mCondition.replace(System<bool>::make(mCubos.mWorld, std::move(function), {}));
+            mCondition.replace(System<bool>::make(*mCubos.mWorld, std::move(function), {}));
             return std::move(*this);
         }
 
         /// @brief Finishes building the system with the given function.
         /// @param function System function.
         void call(auto function) &&
         {
-            this->finish(System<void>::make(mCubos.mWorld, std::move(function), mOptions));
+            this->finish(System<void>::make(*mCubos.mWorld, std::move(function), mOptions));
         }
 
     private:
@@ -687,7 +691,7 @@ namespace cubos::core::ecs
         /// @param function System function.
         void call(auto function) &&
         {
-            this->finish(System<void>::make(mCubos.mWorld, std::move(function), mOptions));
+            this->finish(System<void>::make(*mCubos.mWorld, std::move(function), mOptions));
         }
 
     private:

core/include/cubos/core/ecs/system/registry.hpp

@@ -45,6 +45,9 @@
         /// @brief Constructs.
         SystemRegistry() = default;
 
+        /// @brief Move constructs.
+        SystemRegistry(SystemRegistry&&) = default;
+
         /// @brief Forbid copying.
         SystemRegistry(const SystemRegistry&) = delete;