Karutoh/MinecraftConsoles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify platform support and building requirements in README.md and COMPILE.md

Browse Source
This commit is contained in:
daoge_cmd
2026-03-03 05:43:32 +08:00
parent e53d41d333
commit 1fbc2d1eb8
2 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
COMPILE.md
View File

@@ -41,5 +41,6 @@ cd .\build\Debug
Notes: Notes:
- The CMake build is Windows-only and x64-only. - 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). - 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. - The game relies on relative paths (for example `Common\Media\...`), so launching from the output directory is required.

8
README.md
View File

@@ -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) [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 ## Features
- Fixed compilation and execution in both Debug and Release mode on Windows using Visual Studio 2022 - 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 ## Known Issues
- Builds for other platforms have not been tested and are most likely non-functional - 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
- There are some render bugs in the Release mode build
## Star History ## Star History