Merge pull request #10 from isledecomp/svelte

Migrate frontend to Svelte 5

Author: foxtacles

.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: Build
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check for warnings
+        run: npm run check
+
+      - name: Build
+        run: npm run build:ci

.gitignore

@@ -1,3 +1,5 @@
+node_modules
+dist
 isle.wasm
 isle.wasm.map
 isle.js

README.md

@@ -1,5 +1,77 @@
-# [isle.pizza](https://isle.pizza) frontend
+# [isle.pizza](https://isle.pizza) Frontend
 
-This is a custom frontend for the Emscripten port of [isle-portable](https://github.com/isledecomp/isle-portable). To use this, build the Emscripten version of the game and couple `isle.js` as well as `isle.wasm` with the files in this repository, and open `index.html`.
+A custom web frontend for the Emscripten port of [isle-portable](https://github.com/isledecomp/isle-portable), allowing LEGO Island to run directly in modern web browsers.
 
-[A Docker image that bundles the runtime with this frontend is also available](https://github.com/isledecomp/isle-portable/wiki/Installation#web-port-emscripten).
+<img width="1209" height="792" alt="image" src="https://github.com/user-attachments/assets/b98f8fef-8f30-49be-b424-99c27ea552f3" />
+
+## Requirements
+
+- [Node.js](https://nodejs.org/)
+
+## Quick Start
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/isledecomp/isle.pizza.git
+   cd isle.pizza
+   ```
+
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+3. Obtain the game files (`isle.js` and `isle.wasm`) by building the Emscripten version of [isle-portable](https://github.com/isledecomp/isle-portable), then copy them to the project root.
+
+4. Start the development server:
+   ```bash
+   npm run dev
+   ```
+
+5. Open the URL shown in the terminal (usually `http://localhost:5173`).
+
+## Scripts
+
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Start development server with hot reload |
+| `npm run build` | Build for production (outputs to `dist/`) |
+| `npm run preview` | Preview the production build locally |
+
+## Project Structure
+
+```
+isle.pizza/
+├── src/
+│   ├── App.svelte         # Main application component
+│   ├── app.css            # Global styles
+│   ├── stores.js          # Svelte stores for state management
+│   ├── core/              # Core modules (audio, OPFS, service worker, etc.)
+│   └── lib/               # UI components
+├── public/                # Static assets (images, fonts, PDFs)
+├── scripts/               # Build scripts
+├── src-sw/                # Service worker source
+├── index.html             # HTML entry point
+├── isle.js                # Emscripten JS (not in repo, build from isle-portable)
+├── isle.wasm              # Emscripten WASM (not in repo, build from isle-portable)
+└── LEGO/                  # Game data directory (not in repo)
+```
+
+## Building the Game Files
+
+The `isle.js` and `isle.wasm` files are not included in this repository. To obtain them:
+
+1. Follow the [isle-portable build instructions](https://github.com/isledecomp/isle-portable#building) for the Emscripten target
+2. Copy the resulting `isle.js` and `isle.wasm` to this project's root directory
+
+Alternatively, a [Docker image that bundles the runtime with this frontend](https://github.com/isledecomp/isle-portable/wiki/Installation#web-port-emscripten) is available.
+
+## Tech Stack
+
+- [Svelte 5](https://svelte.dev/) - UI framework
+- [Vite](https://vitejs.dev/) - Build tool and dev server
+- [Workbox](https://developer.chrome.com/docs/workbox/) - Service worker and offline support
+
+## License
+
+See [LICENSE](LICENSE) for details.