isle-portable

isle-portable is a community PC port of LEGO Island in the Quiver Launcher catalog.

README

LEGO Island, portable

Development Vlog | Contributing | Matrix | Forums | Patreon

This initiative is a portable version of LEGO Island (Version 1.1, English) based on the decompilation project. Our primary goal is to transform the codebase to achieve platform independence, thereby enhancing compatibility across various systems while preserving the original game's experience as faithfully as possible.

Please note: this project is primarily dedicated to achieving platform independence without altering the core gameplay or rewriting code for improvement's sake. While those are worthwhile objectives, they are not within the scope of this project. isle-portable offers support for light modding using extensions.

Status

PlatformStatus
Windows (x86, x64, arm64)CI
MacOS (arm64, x64)CI
Linux (x64, arm64)CI
FreeBSD (x64)CI
DOS (x86)CI
WebCI
iOSCI
AndroidCI
Xbox OneCI
Playstation VitaCI
Nintendo SwitchCI
Nintendo 3DSCI

We are actively working to support more platforms. If you have experience with a particular platform, we encourage you to contribute to isle-portable. You can find a list of ongoing efforts in our Wiki.

Usage

An existing copy of LEGO Island is required to use this project.

The guided installer walks you through the installation on every supported platform, step by step, using the builds from the Releases tab. These are continuous builds of the latest master, so an occasional regression is possible; if something does not work for you, please open an issue. Developers can also build the project from source, see below.

The installer's source lives in installer/ and is deployed to GitHub Pages from master.

Library substitutions

To achieve our goal of platform independence, we need to replace any Windows-only libraries with platform-independent alternatives. This ensures that our codebase remains versatile and compatible across various systems. The following table serves as an overview of major libraries / subsystems and their chosen replacements. For any significant changes or additions, it's recommended to discuss them with the team on the Matrix chat first to ensure consistency and alignment with our project's objectives.

Library/subsystemSubstitutionStatus
Window, EventsSDL3✅Remarks
Windows Registry (Configuration)libiniparser✅Remarks
FilesystemSDL3✅Remarks
Threads, Mutexes (Synchronization)SDL3✅Remarks
Keyboard/Mouse, DirectInput (Input)SDL3✅Remarks
Joystick/Gamepad, DirectInput (Input)SDL3✅Remarks
WinMM, DirectSound (Audio)SDL3, miniaudio✅Remarks
DirectDraw (2D video)SDL3✅Remarks
Smackerlibsmacker✅Remarks
Direct3D (3D video)SDL3 (Vulkan, Metal, D3D12), D3D9, OpenGL 1.1, OpenGL ES 2.0, OpenGL ES 3.0, Software✅Remarks
Direct3D Retained ModeCustom re-implementation✅Remarks
SmartHeapDefault memory allocator--

Building

This project uses the CMake build system, which allows for a high degree of versatility regarding compilers and development environments. Please refer to the GitHub action for guidance.

Contributing

If you're interested in helping or contributing to this project, check out the CONTRIBUTING page.