Ultimate Lemmings

Ultimate Lemmings is a native Swift port of the 2D Lemmings games for PC and iOS, featuring support for multiple Lemmings titles and fan packs.

README

Ultimate Lemmings

The 21 October merge combines the two Mole runtime changes. Earlier L3 trace scores describe their recorded source snapshots. See the merge validation for the combined runtime and replay identities.

Ultimate Lemmings is an unofficial native Swift port of the 2D Lemmings games. Start with the developer handover to build and test the source without private game data. Current feed versions, package evidence and completion limits are recorded in release scope. An update-feed entry is not acceptance evidence for its binary. Version 1.3 added an iPhone/iPad development target. The separate mobile 2.0 work targets a full iOS release for iPad, iPhone and iPhone Duo, including Classic, Lemmings 2 and Lemmings 3. The app uses native interpreters and does not run DOS code through an emulator. Commercial game data is not committed to this repository; local builds use the assets supplied in Sources/Ports, Sources/Music and Content/ when present.

The project is not affiliated with, endorsed by or licensed by Sony Interactive Entertainment. Read THIRD_PARTY_NOTICES.md before distributing a build.

Download

Find published downloads on the releases page. Installed Mac copies use the update feed. The release-note index links current and earlier notes. Read release scope for the distinction between advertised versions and retained acceptance evidence, and the tester guide for manual testing.

iPhone and iPad users can add the app source in AltStore Classic, SideStore or Feather, or download the IPA from the release. See the installation guide for signing and device-check limits, and the iOS distribution register for other stores and outstanding submissions.

Use this repository for project source, bug reports and release downloads, including supplemental artwork handoffs. See the repository layout for the archived download repository and the pending private artwork migration.

Collections keeps each player's favourite levels and the last 50 distinct levels played. Bookmark levels from Level Select or their result screens across Classic, fan packs, NeoLemmix, Lemmings 2 and 3.

Start here

Historical iPhone/iPad 1.3 source and Simulator gates pass for their recorded commits. The 2.0 source connects Classic, Lemmings 2, Lemmings 3 and supported NeoLemmix packs to mobile libraries and sessions. L2 and L3 have native scene renderers, campaign records and checkpoint routes. NeoLemmix import validates styles, sprites, rendering and supported simulation features. The 2.0 source snapshot at c7305724 passes the Xcode 27.2 source gate, the Mac workflow and the NeoLemmix gate. Its iPhone and iPad layout and lifecycle tests pass. That record also describes the older Xcode 26.6 SDK and Simulator limitations. The handover verification records the newer source-test toolchain separately. Real-data parity, physical-device and accessibility acceptance, audio, controller, Duo and distribution gates remain open. See the 2.0 release gate. The 1.9 release marks Lemmings 2: The Tribes Complete and Lemmings 3: Chronicles Beta. L2 records 120/120 standalone routes, 70 carry-over variants and 12 chains. Its Gold Ark and original-engine parity remain open. The 20 October current-source L3 audit on 4bf3bddc passes 399/416 exact double replays against installed build 76 resources. Four levels lack a verified route: 107, 206, 213 and 229. Coverage is 86/90 standalone levels and 313/326 carried fixtures. Mole parity, other source rules, media and transitions remain open. The build 76 resources have not been directly hash-linked to the 2.1 package. See the current-source audit.

The latest full strict audit covers all 6,020 source rows across 535 bundled fan packs. The 2.2 polish excludes four exact records with impossible rescue conditions from playable bundled scope, leaving 6,016 playable levels. The accepted count is 2,404 (40.0%), including one targeted route closure on 21 October. The full audit has not been rerun. Its historical rows include 3,599 levels without matching candidates and 18 failed candidate replays. The audit reports no load, decode or render failures. The audit evidence records identities and verified replays for 2,755 Classic routes. The new targeted replay is stored separately. This audit used the installed 1.9.1 build 76 resources. Its 535 LevelPacks archives match build 85, and build 86 records no non-localisation resource-index changes. It does not certify a 2.0.3 app binary. Imported levels remain outside the bundle and open-ended. See the current-main audit, exit-structure audit, build 85 content comparison and 2.0.3 release record. See the incremental route record and bundled closure velocity. The playable-scope decision retains the source row and excludes only the exact bundled archive member. The 2.2 preparation record extends this policy across Mac, iOS and TV browsing and shuffle. Imports and source archives remain unchanged. These exclusions add no winning routes.

The pinned NeoLemmix runnable gate passed 794 levels. Macintosh 2.0.2 build 85 passes the bundled-resource check for all 794 indexed levels and resolves all 719 levels supported by the 26 bundled DMA styles. The other 75 need 44 community styles whose rights remain unresolved. All 794 levels stay in bundled closure scope. Build 85 includes the packaging fix that links the existing Xmas group into the parent index. Exact-version winning replay evidence covers 158 levels; route and source-rule closure remain open. See the 2.0.2 release evidence, 2.0.1 content audit, NeoLemmix package audit, style rights inventory and release scope.

Translation work

English, Spanish (Latin America), German, French, Brazilian Portuguese, Italian, Dutch, Norwegian Bokmål and Tamil are included in the current Mac app. The eight translated language packs are AI-assisted drafts. Human language review and complete translated-screen and device validation remain open.

Start with the translation handover and the localisation architecture. Review the locale checkpoint files under Tools/Localisation/drafts/ before editing. Use python3 Tools/Localisation/install_drafts_for_testing.py --for-in-app-testing to refresh the runtime bundle. The owner approved inclusion in Macintosh 2.0. Complete the linguistic, font, layout and cross-platform checks before claiming fully reviewed language support. Structural coverage alone does not establish it.

Requirements

  • macOS 12.3 or later to run the distributed macOS app;
  • Apple Command Line Tools with Swift 6 support;
  • full Xcode with an iOS Simulator runtime for the 1.3 mobile build and tests;
  • Python 3;
  • ImageMagick (magick) for asset preparation;
  • unar for the supplied Holiday installer;
  • local game data for builds that package commercial content.

The repository's source and tests remain useful without the commercial data, but data-dependent build and evidence gates report their missing inputs. Use TEST_COMPILE_ONLY=1 TEST_SCOPE=dialogs zsh Scripts/run-app-integration-tests.sh to compile the dialog harness without running it. This does not validate a bundled app or any gameplay flow. Run zsh Scripts/run-dialog-cursor-tests.sh for the data-independent focus-order and cursor-policy checks.

Native UI tests use offscreen windows by default. They still render captures and exercise controls without covering the game. They need a logged-in macOS desktop. This is not a WindowServer-free CI mode. Mechanical tests also default to LEMMINGS_TEST_AUDIO=muted. The runner silences music, effects, replay audio and alert beeps without changing system volume or saved preferences. Playback clocks still run. Keep audio muted in every window mode. Use LEMMINGS_TEST_AUDIO=audible only for an explicitly requested listening test. Run zsh Scripts/run-ui-test-runner-tests.sh to check these safeguards. Keep automated runs headless while the user tests gameplay. Report failures and checks that require visible windows in the test output. Never switch to a visible mode automatically. The following visible modes require an explicit user request. Set LEMMINGS_TEST_WINDOWS=secondary to show test windows on the second display (offscreen if there is only one display or the window is too large). This mode allows composited captures and may activate the test app at launch. Set LEMMINGS_TEST_WINDOWS=foreground for desktop focus checks or manual inspection. The arcade suite reports its desktop focus check as skipped unless foreground mode is selected. Offscreen mode preserves bitmap rendering and responder-chain checks. Use TEST_SCOPE=selection-raster for selection checks across all three engines. Metal/HDR window-composition checks (TEST_SCOPE=selection-hdr) need secondary or foreground mode. The runner applies this policy to test processes only. Packaged-app launch smoke tests require LEMMINGS_TEST_WINDOWS=foreground because they exercise the signed app's real launch and full-screen presentation.

The iOS source target supports iOS 16 or later. The 2.0 source supports player-owned Classic, Lemmings 2, Lemmings 3 and supported NeoLemmix imports through the system document picker. It does not package commercial game data. Historical signed build 12 evidence covers Classic only. It does not certify later three-game packages. See the 2.0 release gate for current source evidence and open device and distribution checks.

Build and run

Game data and asset preparation

The Swift source can be compiled and checked without the original games, as described in the developer handover. Building the full, self-contained Mac app is different: its packaging scripts expect local game data, artwork, music and level packs that are not in a fresh checkout. The app interprets game data natively; you do not need to decompile or run the original game executables. Some artwork is extracted from original data and Lemmings 2 overlays during packaging.

Obtain compatible copies of the original games and media you are entitled to use. The DOS editions of Lemmings, Lemmings 2: The Tribes and Lemmings 3 (also sold as The Lemmings Chronicles or All New World of Lemmings) provide the principal game data. Original discs or existing installed copies are possible sources; check the edition and platform before buying second-hand media. We have not verified a current digital storefront for these DOS editions. Other artwork and music need the specific editions listed below. Owning a copy does not itself grant permission to redistribute its assets.

InputLocation expected in the checkoutPreparation
Classic DOS LemmingsSources/Ports/lemmings_dos_1991-07-30/Copy the installed game files, including MAIN.DAT, ODDTABLE.DAT, LEVEL000.DAT–LEVEL009.DAT, the GROUND, VGAGR and VGASPEC files.
Lemmings 2 DOSSources/Ports/Lemm2/Copy the complete installed game directory, preserving LEVELS, STYLES, FRONTEND, PROCESS.RKO and VGA.RKO. The build extracts animation data from the overlays; they are not shipped as executable code.
Lemmings 3 DOS CDSources/Ports/LEM3CD/Copy the game data directory, including LEVELS/LEVEL001.DAT, STYLES/ and GRAPHICS/.
Classic Mac and holiday artworkSources/Ports/lemmings_1_5_2/Lemmings_1_5_2.dsk, Sources/Ports/LemmingsONML.sit_.bin and Sources/Ports/mac_extracted/Holiday_Lem93_94/Supply the corresponding original Mac disk image, Oh No! More Lemmings archive and extracted Holiday Lemmings 1994 installer and Xmas 1992 demo. Preserve Macintosh resource forks. The packaging scripts extract and decode these at build time. The holiday conversion also reads MAIN.DAT, GROUND2O.DAT and VGAGR2.DAT from Sources/Ports/xmas_dos_XmasLemmingsV1.9a1/.
Amiga artworkSources/Ports/amiga_extracted/Extract the compatible original Amiga disk images using the one-time import below.
SoundtracksSources/Music/Supply the music files and catalogue metadata expected by Tools/MusicCatalogue/library.py. The full soundtrack is a separate collection of recordings and modules from multiple ports, not something the DOS game files alone generate.
Classic fan packsContent/LevelPacks/Supply the reviewed ZIP collection and packs.json index. The full packager also validates the reviewed pruning manifest. Individual packs can be sought from their creators and the Lemmings Forums; permissions vary.
NeoLemmix levels, styles and soundsContent/NeoLemmix/Generate these from the pinned NeoLemmix Community Edition source with the command below. See the Community Edition release thread. The script includes the selected DMA styles and stock sounds, not every community style.

The exact soundtrack collection, reviewed fan-pack set and a complete recipe for reconstructing the Mac holiday resource-fork tree are not currently provided by this repository. A fresh checkout and the three DOS games alone are therefore not yet sufficient to reproduce the full app bundle. Ask the project maintainers for the missing asset manifests and preparation details; do not assume another version of a file will pass the existing checks.

On a Mac, install Xcode and select its command-line tools. Install Python 3, ImageMagick, unar and CMake; for example, with Homebrew:

xcode-select --install
brew install python imagemagick unar cmake
zsh Scripts/prepare-neolemmix-content.sh
zsh Scripts/check-local-build.sh

Run these commands from the repository root. The NeoLemmix script downloads a pinned source revision and replaces its generated Content/NeoLemmix output; back up any local changes there first. check-local-build.sh checks tools and a few top-level inputs, not the completeness or compatibility of every asset. The build also fetches pinned Sparkle and