isle-portable/README.md
Christian Semmler 4258fb0deb Add back some stuff from decomp (#2)
* Add ncc script

* add requirements.txt

* Add other builds

* Add with submodules

* Comment out for now

* Add
2024-06-25 19:49:59 +02:00

3.8 KiB

LEGO Island Modernization

Development Vlog | Contributing | Matrix | Forums | Patreon

This initiative is a work-in-progress modernization 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 dedicated to achieving platform independence without altering the core gameplay, adding new features, enhancing visual quality, or rewriting code for improvement's sake. While those are worthwhile objectives, they are not within the scope of this project.

Status

Supported platforms

Platform Implementation status
Windows
Linux
macOS

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 Substitution Implementation status
Smacker libsmacker Open issues
Filesystem C standard library Open issues
Threads, Mutexes (Synchronization) SDL3 Open issues
Keyboard, Mouse, Joystick, DirectInput (Input) SDL3 Open issues
WinMM, DirectSound (Audio) SDL3 Open issues
DirectDraw (2D video) SDL3 Open issues
Direct3D (3D video) SDL3, OpenGL ES (TBD) Open issues
Direct3D Retained Mode Custom re-implementation (TBD) Open issues
SmartHeap Default 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.