fix: key stealing, disable Emscripten module, disable colored ANSI for emscripten builds

.cargo/config.toml

@@ -1,4 +1,5 @@
 [target.wasm32-unknown-emscripten]
+# TODO: Document what the fuck this is.
 rustflags = [
     "-O", "-C", "link-args=-O2 --profiling",
     #"-C", "link-args=-O3 --closure 1",

.github/workflows/deploy.yaml

@@ -1,28 +1,38 @@
 name: Github Pages
-
 on: [push]
-
 permissions:
   contents: write
-
 jobs:
-  build-github-pages:
+  deploy:
     runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
     steps:
       - uses: actions/checkout@v2 # repo checkout
+
       - uses: mymindstorm/setup-emsdk@v11 # setup emscripten toolchain
         with:
           version: 1.39.20
+
       - uses: actions-rs/toolchain@v1 # get rust toolchain for wasm
         with:
           toolchain: stable
           target: wasm32-unknown-emscripten
           override: true
+
+      # TODO: Update to v2
       - name: Rust Cache # cache the rust build artefacts
         uses: Swatinem/rust-cache@v1
+
       - name: Build # build
-        run: ./build.sh
+        run: ./scripts/build-wasm.sh
-      - name: Deploy
+
-        uses: JamesIves/github-pages-deploy-action@v4
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v2
         with:
-          folder: dist
+          path: './dist/'
+          retention-days: 7
+
+      - name: Deploy
+        uses: actions/deploy-pages@v2

BUILD.md

@@ -0,0 +1,7 @@
+# Building Pac-Man
+
+## GitHub Actions Workflow
+
+1. Build workflow produces executables & WASM files for all platforms
+2. Uploaded as artifacts
+3. Deployment workflow downloads artifacts and uploads to GitHub Pages

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/

assets/index.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+</head>
+<style>
+    body {
+        margin: 0;
+        padding: 0;
+        background: #000;
+    }
+    canvas {
+        display: block;
+        margin: 0 auto;
+        background: #000;
+    }
+</style>
+<body>
+    <canvas id="canvas"></canvas>
+    <script>
+        var Module = {
+            'canvas': document.getElementById('canvas'),
+        };
+    </script>
+    <script src="pacman.js"></script>
+</body>
+</html>

build.ps1

@@ -1,7 +0,0 @@
-& cargo build --target=wasm32-unknown-emscripten --release
-
-mkdir -p dist -Force
-
-cp ./target/wasm32-unknown-emscripten/release/Pac_Man.wasm ./dist
-cp ./target/wasm32-unknown-emscripten/release/Pac-Man.js ./dist
-cp index.html dist

build.sh

@@ -1,10 +0,0 @@
-#!/bin/sh
-set -eux
-
-cargo build --target=wasm32-unknown-emscripten --release
-
-mkdir -p dist
-
-cp target/wasm32-unknown-emscripten/release/Pac_Man.wasm dist
-cp target/wasm32-unknown-emscripten/release/Pac-Man.js dist
-cp index.html dist

index.html

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-</head>
-<body>
-    <canvas id="canvas"></canvas>
-    <script type="text/javascript">
-        let Module = {
-            canvas: (function () {
-                // this is how we provide a canvas to our sdl2
-                return document.getElementById("canvas");
-            })(),
-            preRun: [function () {
-                ENV.RUST_LOG = "info,wgpu=warn"
-            }]
-        };
-    </script>
-    <script src="Pac-Man.js"></script>
-</body>
-</html>

scripts/build-wasm.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+# 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
+cp $output_folder/deps/pacman.data dist
+cp assets/index.html dist

scripts/build-windows.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+set -eu
+
+SDL_VERSION="2.28.3"
+SDL_IMAGE_VERSION="2.6.3"
+SDL_MIXER_VERSION="2.6.3"
+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"
+
+# Verify that toolchain is installed
+
+
+# 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
+
+echo "Downloading..."
+curl -L -o ./sdl2.tar.gz $SDL
+curl -L -o ./sdl2_image.tar.gz $SLD_IMAGE
+echo "Done."

serve.ps1

@@ -1,3 +0,0 @@
-& ./build.ps1
-cd ./dist
-python -m http.server

src/animation.rs

@@ -92,6 +92,7 @@ impl<'a> AnimatedTexture<'a> {
         direction: Direction,
         frame: u32,
     ) {
+        // TODO: If the frame we're targeting is in the opposite direction (due to self.reverse), we should pre-emptively reverse.
         let current = self.current_frame();
         self.render_static(canvas, position, direction, Some(current));
 

src/game.rs

@@ -5,7 +5,6 @@ use sdl2::keyboard::Keycode;
 use sdl2::render::{Texture, TextureCreator};
 use sdl2::video::WindowContext;
 use sdl2::{pixels::Color, render::Canvas, video::Window};
-use tracing::event;
 
 use crate::constants::{MapTile, BOARD_HEIGHT, BOARD_WIDTH, RAW_BOARD};
 use crate::direction::Direction;

src/main.rs

@@ -8,9 +8,6 @@ use tracing::event;
 use tracing_error::ErrorLayer;
 use tracing_subscriber::layer::SubscriberExt;
 
-#[cfg(target_os = "emscripten")]
-pub mod emscripten;
-
 mod animation;
 mod constants;
 mod direction;
@@ -20,15 +17,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());
@@ -80,6 +75,7 @@ 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 {
                 // Handle quitting keys or window close
                 Event::Quit { .. }
@@ -150,13 +146,6 @@ pub fn main() {
         true
     };
 
-    #[cfg(target_os = "emscripten")]
-    use emscripten::emscripten;
-
-    #[cfg(target_os = "emscripten")]
-    emscripten::set_main_loop_callback(main_loop);
-
-    #[cfg(not(target_os = "emscripten"))]
     loop {
         if !main_loop() {
             break;