fix: minor comments, disable accelerated, use std sleep on web builds

.cargo/config.toml

@@ -4,6 +4,7 @@ rustflags = [
     "-O", "-C", "link-args=-O2 --profiling",
     #"-C", "link-args=-O3 --closure 1",
     "-C", "link-args=-sASYNCIFY -sALLOW_MEMORY_GROWTH=1",
-    "-C", "link-args=-sUSE_SDL=2 -sUSE_SDL_IMAGE=2 -sSDL_EMSCRIPTEN_KEYBOARD_ELEMENT -sSDL2_IMAGE_FORMATS=['png']",
-    "-C", "link-args=--preload-file assets/ -lidbfs.js",
+    "-C", "link-args=-sUSE_SDL=2 -sUSE_SDL_IMAGE=2 -sSDL2_IMAGE_FORMATS=['png']",
+    # USE_OGG, USE_VORBIS for OGG/VORBIS usage
+    "-C", "link-args=--preload-file assets/",
 ]

README.md

@@ -23,6 +23,9 @@ at.
 - More than 4 ghosts
 - Custom Level Generation
     - Multi-map tunnelling
+- Online Scoreboard
+    - WebAssembly build contains a special API key for communicating with server.
+    - To prevent abuse, the server will only accept scores from the WebAssembly build.
 
 ## Installation
 

STORY.md

@@ -0,0 +1,54 @@
+# Story
+
+This is living document that describes the story of the project, from inspiration to solution.
+When a website is available, this document will help curate it's content.
+
+## Inspiration
+
+I initially got the idea for this project after finding a video about another Pac-Man clone on YouTube.
+
+[![Code Review Thumbnail][code-review-thumbnail]][code-review-video]
+
+This implementation was written in C++, used SDL2 for graphics, and was kinda weird - but it worked.
+
+- I think it was weird because the way it linked files together is extremely non-standard.
+  Essentially, it was a single file that included all the other files. This is not how C++ projects are typically structured.
+- This implementation was also extremely dependent on OOP; Rust has no real counterpart for OOP code, so writing my own implementation would be a challenge.
+
+## Lifetimes
+
+Rust's SDL2 implementation is a wrapper around the C library, so it's not as nice as the C++ implementation.
+Additionally, lifetimes in this library are a bit weird, making them quite difficult to deal with.
+
+I found a whole blog post complaining about this ([1][fighting-lifetimes-1], [2][fighting-lifetimes-2], [3][fighting-lifetimes-3]), so I'm not alone in this.
+
+## Emscripten & RuggRogue
+
+One of the targets for this project is to build a web-accessible version of the game. If you were watching at all during
+the Rust hype, one of it's primary selling points was a growing community of Rust-based web applications, thanks to
+WebAssembly.
+
+The problem is that much of this work was done for pure-Rust applications - and SDL is C++.
+This requires a C++ WebAssembly compiler such as Emscripten; and it's a pain to get working.
+
+Luckily though, someone else has done this before, and they fully documented it - [RuggRouge][ruggrouge].
+- Built with Rust
+- Uses SDL2
+- Compiling for WebAssembly with Emscripten
+- Also compiles for Windows & Linux
+
+This repository has been massively helpful in getting my WebAssembly builds working.
+
+## Key Capturing Extensions in WASM Build
+
+Some extensions I had installed were capturing keys.
+The issue presented with some keys never being sent to the application.
+To confirm, enter safe mode or switch to a different browser without said extensions.
+If the issue disappears, it's because of an extension in your browser stealing keys in a way that is incompatible with the batshit insanity of Emscripten.
+
+[code-review-video]: https://www.youtube.com/watch?v=OKs_JewEeOo
+[code-review-thumbnail]: https://img.youtube.com/vi/OKs_JewEeOo/hqdefault.jpg
+[fighting-lifetimes-1]: https://devcry.heiho.net/html/2022/20220709-rust-and-sdl2-fighting-with-lifetimes.html
+[fighting-lifetimes-2]: https://devcry.heiho.net/html/2022/20220716-rust-and-sdl2-fighting-with-lifetimes-2.html
+[fighting-lifetimes-3]: https://devcry.heiho.net/html/2022/20220724-rust-and-sdl2-fighting-with-lifetimes-3.html
+[ruggrogue]: https://tung.github.io/ruggrogue/

scripts/build-wasm.sh

@@ -1,12 +1,11 @@
 #!/bin/sh
-set -eu
+# set -eu
 
 echo "Building WASM with Emscripten"
 cargo build --target=wasm32-unknown-emscripten --release
 
 echo "Copying release files to dist/"
 mkdir -p dist
-
 output_folder="target/wasm32-unknown-emscripten/release"
 cp $output_folder/pacman.wasm dist
 cp $output_folder/pacman.js dist

scripts/build-windows.sh

@@ -9,20 +9,50 @@ SDL_TTF_VERSION="2.20.2"
 SDL="https://github.com/libsdl-org/SDL/releases/download/release-${SDL_VERSION}/SDL2-devel-${SDL_VERSION}-mingw.tar.gz"
 SLD_IMAGE="https://github.com/libsdl-org/SDL_image/releases/download/release-${SDL_IMAGE_VERSION}/SDL2_image-devel-${SDL_IMAGE_VERSION}-mingw.tar.gz"
 SDL_MIXER="https://github.com/libsdl-org/SDL_mixer/releases/download/release-${SDL_MIXER_VERSION}/SDL2_mixer-devel-${SDL_MIXER_VERSION}-mingw.tar.gz"
-SDL_TTF="https://github.com/libsdl-org/SDL_ttf/releases/download/release-${SDL_TTF_VERSION}/SDL_ttf-devel-${SDL_TTF_VERSION}-mingw.tar.gz"
+SDL_TTF="https://github.com/libsdl-org/SDL_ttf/releases/download/release-${SDL_TTF_VERSION}/SDL2_ttf-devel-${SDL_TTF_VERSION}-mingw.tar.gz"
 
-# Verify that toolchain is installed
+EXTRACT_DIR="./target/x86_64-pc-windows-gnu/release/deps"
 
+if [ ! -f $EXTRACT_DIR/libSDL2.a ]; then
+    if [ ! -f ./sdl2.tar.gz ]; then
+        echo "Downloading SDL2@$SDL_VERSION..."
+        curl -L -o ./sdl2.tar.gz $SDL
+    fi
+    echo "Extracting SDL2..."
+    tar -xzf ./sdl2.tar.gz -C $EXTRACT_DIR --strip-components=3 "SDL2-$SDL_VERSION/x86_64-w64-mingw32/lib/libSDL2.a"
+    rm -f ./sdl2.tar.gz
+fi
 
-# EXTRACT_DIR="~/.rustup/"
-EXTRACT_DIR="~/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-pc-windows-gnu/lib/"
-# if [ ! -d "~/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/lib/rustlib/x86_64-pc-windows-gnu/lib/" ]; then
-    # ls $EXTRACT_DIR
-    # echo "Toolchain not installed. Run rustup target add x86_64-pc-windows-gnu. This may not work on environments besides Linux GNU."
-    # exit 1
-# fi
+if [ ! -f $EXTRACT_DIR/libSDL2_image.a ]; then
+    if [ ! -f ./sdl2_image.tar.gz ]; then
+        echo "Downloading SDL2_image@$SDL_IMAGE_VERSION..."
+        curl -L -o ./sdl2_image.tar.gz $SLD_IMAGE
+    fi
+    echo "Extracting SDL2_image..."
+    tar -xzf ./sdl2_image.tar.gz -C $EXTRACT_DIR --strip-components=3 "SDL2_image-$SDL_IMAGE_VERSION/x86_64-w64-mingw32/lib/libSDL2_image.a"
+fi
+rm -f ./sdl2_image.tar.gz
 
-echo "Downloading..."
-curl -L -o ./sdl2.tar.gz $SDL
-curl -L -o ./sdl2_image.tar.gz $SLD_IMAGE
-echo "Done."
+if [ ! -f $EXTRACT_DIR/libSDL2_mixer.a ]; then
+    if [ ! -f ./sdl2_mixer.tar.gz ]; then
+        echo "Downloading SDL2_mixer@$SDL_MIXER_VERSION..."
+        curl -L -o ./sdl2_mixer.tar.gz $SDL_MIXER
+    fi
+    echo "Extracting SDL2_mixer..."
+    tar -xzf ./sdl2_mixer.tar.gz -C $EXTRACT_DIR --strip-components=3 "SDL2_mixer-$SDL_MIXER_VERSION/x86_64-w64-mingw32/lib/libSDL2_mixer.a"
+    rm -f ./sdl2_mixer.tar.gz
+fi
+
+if [ ! -f $EXTRACT_DIR/libSDL2_ttf.a ]; then
+    
+    if [ ! -f ./sdl2_ttf.tar.gz ]; then
+        echo "Downloading SDL2_ttf@$SDL_TTF_VERSION..."
+        curl -L -o ./sdl2_ttf.tar.gz $SDL_TTF
+    fi
+    echo "Extracting SDL2_ttf..."
+    tar -xzf ./sdl2_ttf.tar.gz -C $EXTRACT_DIR --strip-components=3 "SDL2_ttf-$SDL_TTF_VERSION/x86_64-w64-mingw32/lib/libSDL2_ttf.a"
+    rm -f ./sdl2_ttf.tar.gz
+fi
+
+echo "Building..."
+cargo zigbuild --release --target x86_64-pc-windows-gnu

scripts/clean-windows.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+set -eux
+
+echo "Cleaning library files from ./target/x86_64-pc-windows-gnu/release/deps"
+rm -f ./target/x86_64-pc-windows-gnu/release/deps/libSDL2.a
+rm -f ./target/x86_64-pc-windows-gnu/release/deps/libSDL2_image.a
+rm -f ./target/x86_64-pc-windows-gnu/release/deps/libSDL2_mixer.a
+rm -f ./target/x86_64-pc-windows-gnu/release/deps/libSDL2_ttf.a
+echo "Done."

src/emscripten.rs

@@ -1,49 +0,0 @@
-// taken from https://github.com/Gigoteur/PX8/blob/master/src/px8/emscripten.rs
-#[cfg(target_os = "emscripten")]
-pub mod emscripten {
-    use std::cell::RefCell;
-    use std::ffi::{CStr, CString};
-    use std::os::raw::{c_char, c_float, c_int, c_void};
-    use std::ptr::null_mut;
-
-    #[allow(non_camel_case_types)]
-    type em_callback_func = unsafe extern "C" fn();
-
-    extern "C" {
-        // void emscripten_set_main_loop(em_callback_func func, int fps, int simulate_infinite_loop)
-        pub fn emscripten_set_main_loop(
-            func: em_callback_func,
-            fps: c_int,
-            simulate_infinite_loop: c_int,
-        );
-
-        pub fn emscripten_cancel_main_loop();
-        pub fn emscripten_pause_main_loop();
-        pub fn emscripten_get_now() -> c_float;
-    }
-
-    thread_local!(static MAIN_LOOP_CALLBACK: RefCell<*mut c_void> = RefCell::new(null_mut()));
-
-    pub fn set_main_loop_callback<F>(callback: F)
-    where
-        F: FnMut(),
-    {
-        MAIN_LOOP_CALLBACK.with(|log| {
-            *log.borrow_mut() = &callback as *const _ as *mut c_void;
-        });
-
-        unsafe {
-            emscripten_set_main_loop(wrapper::<F>, -1, 1);
-        }
-
-        unsafe extern "C" fn wrapper<F>()
-        where
-            F: FnMut(),
-        {
-            MAIN_LOOP_CALLBACK.with(|z| {
-                let closure = *z.borrow_mut() as *mut F;
-                (*closure)();
-            });
-        }
-    }
-}

src/game.rs

@@ -62,6 +62,8 @@ impl Game<'_> {
         self.canvas.set_draw_color(Color::RGB(0, 0, 0));
         self.canvas.clear();
 
+
+        // Render the map   
         self.canvas
             .copy(&self.map_texture, None, None)
             .expect("Could not render texture on canvas");
@@ -102,6 +104,7 @@ impl Game<'_> {
             self.draw_cell((next_cell.0 as u32, next_cell.1 as u32), Color::YELLOW);
         }
 
+        // Present the canvas
         self.canvas.present();
     }
 

src/main.rs

@@ -1,8 +1,7 @@
 use crate::constants::{WINDOW_HEIGHT, WINDOW_WIDTH};
 use crate::game::Game;
-use sdl2::event::Event;
+use sdl2::event::{Event, WindowEvent};
 use sdl2::keyboard::Keycode;
-use spin_sleep::sleep;
 use std::time::{Duration, Instant};
 use tracing::event;
 use tracing_error::ErrorLayer;
@@ -17,15 +16,13 @@ mod map;
 mod modulation;
 mod pacman;
 
-#[cfg(target_os = "emscripten")]
-mod emscripten;
-
 pub fn main() {
     let sdl_context = sdl2::init().unwrap();
     let video_subsystem = sdl_context.video().unwrap();
 
     // Setup tracing
     let subscriber = tracing_subscriber::fmt()
+        .with_ansi(cfg!(not(target_os = "emscripten")))
         .with_max_level(tracing::Level::DEBUG)
         .finish()
         .with(ErrorLayer::default());
@@ -40,7 +37,6 @@ pub fn main() {
 
     let mut canvas = window
         .into_canvas()
-        .accelerated()
         .build()
         .expect("Could not build canvas");
 
@@ -66,6 +62,7 @@ pub fn main() {
     let mut last_averaging_time = Instant::now();
     let mut sleep_time = Duration::ZERO;
     let mut paused = false;
+    let mut shown = false;
 
     event!(
         tracing::Level::INFO,
@@ -78,6 +75,19 @@ pub fn main() {
         // TODO: Fix key repeat delay issues by using VecDeque for instant key repeat
         for event in event_pump.poll_iter() {
             match event {
+                Event::Window { win_event, .. } => {
+                    match win_event {
+                        WindowEvent::Hidden => {
+                            event!(tracing::Level::DEBUG, "Window hidden");
+                            shown = false;
+                        },
+                        WindowEvent::Shown => {
+                            event!(tracing::Level::DEBUG, "Window shown");
+                            shown = true;
+                        },
+                        _ => {}
+                    }
+                }
                 // Handle quitting keys or window close
                 Event::Quit { .. }
                 | Event::KeyDown {
@@ -112,8 +122,13 @@ pub fn main() {
         }
 
         if start.elapsed() < loop_time {
-            let time = loop_time - start.elapsed();
-            sleep(time);
+            let time = loop_time.saturating_sub(start.elapsed());
+            #[cfg(not(target_os = "emscripten"))] {
+                spin_sleep::sleep(time);
+            }
+            #[cfg(target_os = "emscripten")] {
+                thread::sleep(time);
+            }
             sleep_time += time;
         } else {
             event!(
@@ -146,7 +161,7 @@ pub fn main() {
 
         true
     };
-    
+
     loop {
         if !main_loop() {
             break;