Lemmix JS+VR

This is a fork of LemmingsJS, the Lemmings reimplementation in HTML5 / JavaScript, adding a 3D view, VR support (WebXR) and Lemmix engine compatibility - the NeoLemmix level packs and styles play here. The game is playable at https://lemmix.spd13.us. It ships no game data: see setup.md for what to download, where, and how to install it, the original games' own files included.

Features

• Lemmix engine - the NeoLemmix game mechanics, so its styles and level packs from https://www.neolemmix.com play here as they do in the original, along with the classic DOS games
• 2D and 3D rendering - the original 2D page, and a 3D view of the same levels
• VR support (WebXR) - play the 3D view in a headset, with an external viewer view for a screen next to it and pointer-based skill assignment
• Fully web based - serve it on your own network with the launcher (see Releases), or play the static version at https://lemmix.spd13.us with nothing to install

Levels and assets

Git ships the engine only - no copyrighted asset is part of the distribution; setup.md is the player's guide to what to download, where, and how to install it, the original games' own files included. The game data - the level packs under levels/ and NeoLemmix's own files under neolemmix/ (styles, panel graphics, masks, sound effects, music) - comes from elsewhere, in one of two asset modes the 3D page chooses with the URL (?assets=static or ?assets=server forces one, and the pages carry the flag along while it is set; without either it takes server when the launcher answers its health check, static otherwise):

• static - the files live in the browser's own storage (IndexedDB), installed from the setup page (setup.html, the Setup button on the right edge of the 3D page; the page also opens by itself the first time nothing is installed). A service worker at the repo root (sw.js) serves them to the game, so the site can be hosted with nothing but the engine - GitHub Pages, say. The setup page shows what is installed (a green or red dot for NeoLemmix and for the styles package, the list of level directories with a delete button each), and installs:
  • NeoLemmix and the styles package from https://www.neolemmix.com - which does not send the CORS headers a page needs to download them itself, so the button saves the official zip through the browser and a second one unpacks the zip you saved (or drop it on the row);
  • the Lemmings Plus packs the same way, the two classic games in one click from the LemmingsJS repository on GitHub (through jsDelivr), any other pack as a zip or an uploaded folder. Everything is kept per browser and per site address (localhost and 127.0.0.1 are two sites), and goes with the site's data if the browser clears it; the page asks for persistent storage. Service workers only run on localhost or over HTTPS (the launcher serves HTTPS, so a headset on the LAN works); a hard reload bypasses the worker for that one load. The same page downloads and uploads the player's configuration as JSON files: the controller bindings, the preferences (everything the 3D page keeps in localStorage) and the level progress (clears, best times, most lemmings saved, talismans - merged on upload, never losing a clear).
• server - today's layout: the files are folders on the web server.
  • NeoLemmix packs (.nxlv levels): copy the pack folder into levels/ as downloaded, e.g. levels/LemmingsPlus_All_20201114/. The Lemmings Plus packs by namida are published on the NeoLemmix site and the Lemmings Forums (https://www.neolemmix.com, https://www.lemmingsforums.net, "NeoLemmix Level Packs"); the classic games (levels/lemmings, levels/lemmings_ohNo, registered in config.json) are the folders of https://github.com/oklemenz/LemmingsJS.
  • NeoLemmix itself: the neolemmix/ folder is laid out like a NeoLemmix install, so the NeoLemmix zip and the styles package from https://www.neolemmix.com/?page=neolemmix unpack straight into it, giving neolemmix/styles/, neolemmix/gfx/, neolemmix/sound/ and neolemmix/music/. See neolemmix/README.md. .gitignore excludes everything under levels/ and neolemmix/ but their READMEs. In this mode the launcher also keeps the player's configuration - the same three JSON files the setup page downloads and uploads - in config/ at the repo root: the game writes them whenever a setting, a binding or the progress changes, reads them at start, and they take precedence over the browser's own copy (config/README.md; the folder is in git, its files are not). The setup page's NeoLemmix rows and Levels section work on the server's neolemmix/ and levels/ folders in this mode - state, install, delete - through the launcher; each row is marked server or browser.

Tracker music (.it/.xm/.mod) plays through libopenmpt via chiptune3, vendored under lemmix/vendor/chiptune3/ (MIT, libopenmpt BSD); the setup page unpacks zips with fflate, vendored as 3d/lib/fflate.min.js (MIT).

The level browser reads levels/index.json, the sprite galleries (galleries.html) neolemmix/styles/index.json. In static mode the setup page writes both into the browser's storage after every change. On disk, regenerate them after adding or removing a pack or unpacking the styles:

node tools/levels-index.js
node tools/styles-index.js

Releases

The site carries a release version: version.json at the repo root, and the same number stamped as a marker into every page (<meta name="lem3d-version">) and into sw.js. The Electron builder (builder/, npm install && npm start there; or node builder/version.js minor|major|set X.Y.Z without Electron) steps it - minor the last number, major the middle one - and writes all of those files; commit them, then its Publish button pushes the committed tree to the gh-pages branch of origin (switching GitHub Pages on through gh when the repository has no site yet), which serves the static asset mode at https://<owner>.github.io/<repo>/. A page fetches version.json on load, past every cache, and when the server's number differs from its own marker it shows a yellow warning asking for a hard reload, since the browser's cache is what holds an old page back. The version in force shows in the 3D page's footer next to the asset mode. See builder/README.md.

The Electron launcher (launcher/) serves both indexes live from the folders, so with it no regeneration step is needed; it is also what saves the tagging done in the piece editor and the galleries page (3d/profiles/). node launcher/server.js [port] runs the same server from a terminal without Electron, over plain HTTP.

Credits

• https://github.com/oklemenz/LemmingsJS - the LemmingsJS engine this repository forks: the DOS games' reimplementation, the 2D page
• https://github.com/tomsoftware - the original Lemmings.js the engine descends from
• https://www.neolemmix.com - NeoLemmix, whose engine the Lemmix code follows, and whose styles, level packs and music the game plays
• Eric Langedijk (for Lemmix), Stephan Neupert and Namida Verasche - the authors of NeoLemmix, whose source is licensed CC BY-NC 4.0 and asks that the three of them be credited; its graphics, music and sounds remain their creators' copyright and are not distributed here
• This project was developed with the help of Claude Code - https://claude.com/claude-code