diff --git a/COMPILE.md b/COMPILE.md index 8947cecb..b62c9575 100644 --- a/COMPILE.md +++ b/COMPILE.md @@ -41,5 +41,6 @@ cd .\build\Debug Notes: - The CMake build is Windows-only and x64-only. +- Contributors on macOS or Linux need a Windows machine or VM to build the project. Running the game via Wine is separate from having a supported build environment. - Post-build asset copy is automatic for `MinecraftClient` in CMake (Debug and Release variants). - The game relies on relative paths (for example `Common\Media\...`), so launching from the output directory is required. diff --git a/README.md b/README.md index 61730d6b..4b395b3e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ This project contains the source code of Minecraft Legacy Console Edition v1.3.0 [Nightly Build](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly) +## Platform Support + +- **Windows**: Supported for building and running the project +- **macOS / Linux**: The Windows nightly build may run through Wine or CrossOver based on community reports, but this is unofficial and not currently tested by the maintainers + ## Features - Fixed compilation and execution in both Debug and Release mode on Windows using Visual Studio 2022 @@ -59,8 +64,7 @@ For more information, see [COMPILE.md](COMPILE.md) ## Known Issues -- Builds for other platforms have not been tested and are most likely non-functional -- There are some render bugs in the Release mode build +- Native builds for platforms other than Windows have not been tested and are most likely non-functional. The Windows nightly build may still run on macOS and Linux through Wine or CrossOver, but that path is unofficial and not currently supported ## Star History