Skip to content

Commit 1fbc2d1

Browse files
committed
docs: clarify platform support and building requirements in README.md and COMPILE.md
1 parent e53d41d commit 1fbc2d1

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

COMPILE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@ cd .\build\Debug
4141

4242
Notes:
4343
- The CMake build is Windows-only and x64-only.
44+
- 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.
4445
- Post-build asset copy is automatic for `MinecraftClient` in CMake (Debug and Release variants).
4546
- The game relies on relative paths (for example `Common\Media\...`), so launching from the output directory is required.

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ This project contains the source code of Minecraft Legacy Console Edition v1.3.0
1010

1111
[Nightly Build](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly)
1212

13+
## Platform Support
14+
15+
- **Windows**: Supported for building and running the project
16+
- **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
17+
1318
## Features
1419

1520
- 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)
5964

6065
## Known Issues
6166

62-
- Builds for other platforms have not been tested and are most likely non-functional
63-
- There are some render bugs in the Release mode build
67+
- 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
6468

6569
## Star History
6670

0 commit comments

Comments
 (0)