Emscripten support

Author: crudelios

.ci_scripts/build_upload.sh

@@ -62,10 +62,10 @@ case "$DEPLOY" in
   ;;
 "emscripten")
   PACKAGE=emscripten
-  if [ -f "${build_dir}/julius.zip" ]
+  if [ -f "${build_dir}/augustus.zip" ]
   then
-    DEPLOY_FILE=julius-$VERSION-emscripten.zip
-    cp "${build_dir}/julius.zip" "deploy/$DEPLOY_FILE"
+    DEPLOY_FILE=augustus-$VERSION-emscripten.zip
+    cp "${build_dir}/augustus.zip" "deploy/$DEPLOY_FILE"
   fi
   ;;
 *)

.ci_scripts/run_build.sh

@@ -65,7 +65,7 @@ case "$BUILD_TARGET" in
 	;;
 "emscripten")
 	cd build && make -j4
-	zip julius.zip julius.html
+	zip augustus.zip augustus.html augustus.data
 	;;
 *)
 	cd build && make -j4 && make

.github/workflows/main.yml

@@ -55,6 +55,14 @@ jobs:
             SDL_MIXER_VERSION: 2.0.4
             BUILD_TARGET: android
             DEPLOY: android
+          - name: Emscripten
+            os: ubuntu-20.04
+            cache-key: emscripten
+            SDL_VERSION: 2.0.14
+            SDL_MIXER_VERSION: 2.0.4
+            MPG123_VERSION: 1.26.5
+            BUILD_TARGET: emscripten
+            DEPLOY: emscripten
     name: ${{ matrix.name }}
     runs-on: ${{ matrix.os }}
     env:

CMakeLists.txt

@@ -8,6 +8,8 @@ string(TOLOWER ${TARGET_PLATFORM} TARGET_PLATFORM)
 
 option(DRAW_FPS "Draw FPS on the top left corner of the window." OFF)
 option(SYSTEM_LIBS "Use system libraries when available." ON)
+option(EMSCRIPTEN_LOAD_SDL_PORTS "Load SDL and SDL_mixer emscripten ports instead of compiling them" OFF)
+option(LINK_MPG123 "Link mpg123 statically to Julius instead of relying on a library." OFF)
 
 if(${TARGET_PLATFORM} STREQUAL "vita" AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
     if(DEFINED ENV{VITASDK})
@@ -26,6 +28,15 @@ if(${TARGET_PLATFORM} STREQUAL "switch" AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
     endif()
 endif()
 
+if(${TARGET_PLATFORM} STREQUAL "emscripten" AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
+    if(DEFINED ENV{EMSDK})
+        set(EMSDK $ENV{EMSDK})
+        set(CMAKE_TOOLCHAIN_FILE "$ENV{EMSDK}/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake" CACHE PATH "toolchain file")
+    else()
+        message(FATAL_ERROR "Please define EMSDK to point to your Emscripten SDK path!")
+    endif()
+endif()
+
 set(SHORT_NAME augustus)
 set(USER_FRIENDLY_NAME Augustus)
 project(${SHORT_NAME} C)
@@ -131,6 +142,10 @@ configure_file(${PROJECT_SOURCE_DIR}/gen/version.c.in ${PROJECT_SOURCE_DIR}/src/
 configure_file(${PROJECT_SOURCE_DIR}/gen/version.rc.in ${PROJECT_SOURCE_DIR}/res/version.rc)
 configure_file(${PROJECT_SOURCE_DIR}/gen/version.txt.in ${PROJECT_SOURCE_DIR}/res/version.txt)
 
+if(${TARGET_PLATFORM} STREQUAL "emscripten")
+    configure_file(${PROJECT_SOURCE_DIR}/gen/shell.html.in ${PROJECT_SOURCE_DIR}/res/shell.html)
+endif()
+
 if(DRAW_FPS)
   add_definitions(-DDRAW_FPS)
 endif()
@@ -633,6 +648,11 @@ if(APPLE)
     )
 endif()
 
+set(EMSCRIPTEN_FILES "")
+if(${TARGET_PLATFORM} STREQUAL "emscripten")
+    set(EMSCRIPTEN_FILES ${PROJECT_SOURCE_DIR}/res/shell.html)
+endif()
+
 set(SOURCE_FILES
     ${PLATFORM_FILES}
     ${CORE_FILES}
@@ -657,36 +677,54 @@ set(SOURCE_FILES
     ${MACOSX_FILES}
 )
 
-function(GET_SDL_EXT_DIR result module)
-    if(NOT module STREQUAL "")
-        set(module "_${module}")
-    endif()
-    set(SDL_LOCATION ${PROJECT_SOURCE_DIR}/ext/SDL2)
-    file(GLOB children
-        RELATIVE ${SDL_LOCATION}
-        CONFIGURE_DEPENDS
-        ${SDL_LOCATION}/SDL${module}
-        ${SDL_LOCATION}/SDL2${module}
-        ${SDL_LOCATION}/SDL${module}-*
-        ${SDL_LOCATION}/SDL2${module}-*
-    )
-    foreach(child ${children})
-        if(IS_DIRECTORY "${SDL_LOCATION}/${child}")
-            set(${result} "${SDL_LOCATION}/${child}" PARENT_SCOPE)
-            break()
+if(${TARGET_PLATFORM} STREQUAL "emscripten" AND EMSCRIPTEN_LOAD_SDL_PORTS)
+    set(USE_FLAGS "-s USE_SDL=2 -s USE_SDL_MIXER=2 -s SDL2_MIXER_FORMATS=[\"mp3\"] -s USE_MPG123=1")
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${USE_FLAGS}")
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${USE_FLAGS}")
+else()
+    function(GET_SDL_EXT_DIR result module)
+        if(NOT module STREQUAL "")
+            set(module "_${module}")
         endif()
-    endforeach()
-endfunction()
+        set(SDL_LOCATION ${PROJECT_SOURCE_DIR}/ext/SDL2)
+        file(GLOB children
+            RELATIVE ${SDL_LOCATION}
+            CONFIGURE_DEPENDS
+            ${SDL_LOCATION}/SDL${module}
+            ${SDL_LOCATION}/SDL2${module}
+            ${SDL_LOCATION}/SDL${module}-*
+            ${SDL_LOCATION}/SDL2${module}-*
+        )
+        foreach(child ${children})
+            if(IS_DIRECTORY "${SDL_LOCATION}/${child}")
+                set(${result} "${SDL_LOCATION}/${child}" PARENT_SCOPE)
+                break()
+            endif()
+        endforeach()
+    endfunction()
+
+    find_package(SDL2 REQUIRED)
+    find_package(SDL2_mixer REQUIRED)
+    if(${TARGET_PLATFORM} STREQUAL "emscripten")
+        set(LINK_MPG123 true)
+    endif()
+endif()
 
-find_package(SDL2 REQUIRED)
-find_package(SDL2_mixer REQUIRED)
+if(LINK_MPG123)
+    find_package(MPG123 REQUIRED)
+endif()
 
 if(${TARGET_PLATFORM} STREQUAL "android")
     add_library(${SHORT_NAME} SHARED ${SDL2_ANDROID_HOOK} ${SOURCE_FILES})
 else()
     add_executable(${SHORT_NAME} WIN32 ${SOURCE_FILES})
 endif()
 
+if(${TARGET_PLATFORM} STREQUAL "emscripten")
+    set(CMAKE_EXECUTABLE_SUFFIX .html)
+    set_target_properties(${SHORT_NAME} PROPERTIES LINK_FLAGS "-lidbfs.js -s SINGLE_FILE=1 -s DEMANGLE_SUPPORT=1 -s DYNCALLS=1 --shell-file ${PROJECT_SOURCE_DIR}/res/shell.html --preload-file ${PROJECT_SOURCE_DIR}/assets@/assets -s INITIAL_MEMORY=268435456 -s ALLOW_MEMORY_GROWTH=1 -s DISABLE_DEPRECATED_FIND_EVENT_TARGET_BEHAVIOR=0 -s SAFE_HEAP=1 -s INVOKE_RUN=0 -s EXPORTED_FUNCTIONS=[\"_main\"] -s EXPORTED_RUNTIME_METHODS=[\"callMain\",\"FS\"]  --bind")
+endif()
+
 if(MSVC)
     add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
 endif()
@@ -753,8 +791,12 @@ if(APPLE)
     " BUNDLE DESTINATION ${CMAKE_BINARY_DIR})
 endif()
 
-include_directories(${SDL2_INCLUDE_DIR})
-include_directories(${SDL2_MIXER_INCLUDE_DIR})
+if(SDL2_INCLUDE_DIR)
+    include_directories(${SDL2_INCLUDE_DIR})
+endif()
+if(SDL2_MIXER_INCLUDE_DIR)
+    include_directories(${SDL2_MIXER_INCLUDE_DIR})
+endif()
 
 if(SYSTEM_LIBS)
     find_package(ZLIB)
@@ -903,6 +945,9 @@ else()
         find_library(android-lib android)
         target_link_libraries(${SHORT_NAME} ${log-lib} ${android-lib})
     endif()
+    if(LINK_MPG123)
+        target_link_libraries(${SHORT_NAME} ${MPG123_LIBRARY})
+    endif()
     target_link_libraries (${SHORT_NAME} ${SDL2_LIBRARY} ${SDL2_MIXER_LIBRARY})
     if(NOT APPLE AND NOT ${TARGET_PLATFORM} STREQUAL "android")
         install(TARGETS ${SHORT_NAME} RUNTIME DESTINATION bin)

gen/shell.html.in

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Julius</title>
+    <title>Augustus</title>
     <script async src="https://cdnjs.cloudflare.com/ajax/libs/FileSaver.js/2.0.4/FileSaver.min.js"></script>
     <script async src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.5.0/jszip.min.js"></script>
     <style>
@@ -105,7 +105,7 @@
         background-position: center;
         background-repeat: no-repeat;
         background-size: contain;
-        background-image: url(https://raw.githubusercontent.com/bvschaik/julius/master/res/julius_512.png);
+        background-image: url(https://raw.githubusercontent.com/Keriew/augustus/master/res/augustus_512.png);
         opacity: 0.25;
         top: 0;
         left: 0;
@@ -239,15 +239,15 @@
   </head>
   <body>
     <div id="infoLocation">
-      <h1>Julius <small>online</small></h1>
+      <h1>Augustus <small>online</small></h1>
       <div id="middleElement">
         <div id="loadStatus">
           <div id="spinner" class="spinner"></div>
-          <div id="status"><noscript>Please enable JavaScript to play Julius</noscript>Waiting for JavaScript to load...</div>
+          <div id="status"><noscript>Please enable JavaScript to play Augustus</noscript>Waiting for JavaScript to load...</div>
           <progress id="progress"></progress>
         </div>
         <div id="startOptions">
-          <div id="play" onclick="Module.startGame()">Play Julius</div>
+          <div id="play" onclick="Module.startGame()">Play Augustus</div>
           <input type="button" id="downloadSaves" onclick="Module.downloadSaves()" value="Download Saves">
           <input type="button" class="red" onclick="Module.showSubWindow(confirmElement)" value="Delete all files">
         </div>
@@ -692,7 +692,7 @@
           var hasData = false;
           Module.setStatus('Checking for downloadable saves...');
           Object.keys(FS.lookupPath(C3Dir).node.contents).forEach(element => {
-            if (element.endsWith('.sav') || element.endsWith('.map')) {
+            if (element.endsWith('.sav') || element.endsWith('.svx') || element.endsWith('.map')) {
               var array = FS.readFile(C3Dir + '/' + element);
               zip.file(element, array);
               hasData = true;
@@ -706,7 +706,7 @@
           Module.setStatus('Creating zip file...');
           zip.generateAsync({type:"blob"}).then(function(blob) {
             Module.showFirstScreen();
-            saveAs(blob, 'julius savefiles.zip');
+            saveAs(blob, 'augustus savefiles.zip');
           }, function (err) {
             Module.setStatus('There was an error creating the zip file:<br><br>' + err +
               '<br><br><small>(Click to exit this prompt)</small>');

src/platform/file_manager.c

@@ -117,6 +117,9 @@ static int is_file(int mode)
 static const char *ASSET_DIRS[MAX_ASSET_DIRS] = {
 #ifdef _WIN32
     "***SDL_BASE_PATH***",
+#endif
+#ifdef __EMSCRIPTEN__
+    "",
 #endif
     ".",
 #ifdef __vita__
@@ -453,6 +456,13 @@ int platform_file_manager_remove_file(const char *filename)
     return 0;
 }
 
+FILE *platform_file_manager_open_asset(const char *asset, const char *mode)
+{
+    get_assets_directory();
+    const char *cased_asset_path = dir_get_asset(assets_directory, asset);
+    return fopen(cased_asset_path, mode);
+}
+
 #else
 
 FILE *platform_file_manager_open_file(const char *filename, const char *mode)