From bdc8fb5dfa9a111c230d7da5c3790fdb884e818d Mon Sep 17 00:00:00 2001 From: daoge <3523206925@qq.com> Date: Tue, 3 Mar 2026 03:04:10 +0800 Subject: docs: update README.md --- COMPILE.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ Compile.md | 45 --------------------------------------------- README.md | 4 +++- 3 files changed, 48 insertions(+), 46 deletions(-) create mode 100644 COMPILE.md delete mode 100644 Compile.md diff --git a/COMPILE.md b/COMPILE.md new file mode 100644 index 00000000..8947cecb --- /dev/null +++ b/COMPILE.md @@ -0,0 +1,45 @@ +# Compile Instructions + +## Visual Studio (`.sln`) + +1. Open `MinecraftConsoles.sln` in Visual Studio 2022. +2. Set `Minecraft.Client` as the Startup Project. +3. Select configuration: + - `Debug` (recommended), or + - `Release` +4. Select platform: `Windows64`. +5. Build and run: + - `Build > Build Solution` (or `Ctrl+Shift+B`) + - Start debugging with `F5`. + +## CMake (Windows x64) + +Configure (use your VS Community instance explicitly): + +```powershell +cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DCMAKE_GENERATOR_INSTANCE="C:/Program Files/Microsoft Visual Studio/2022/Community" +``` + +Build Debug: + +```powershell +cmake --build build --config Debug --target MinecraftClient +``` + +Build Release: + +```powershell +cmake --build build --config Release --target MinecraftClient +``` + +Run executable: + +```powershell +cd .\build\Debug +.\MinecraftClient.exe +``` + +Notes: +- The CMake build is Windows-only and x64-only. +- 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/Compile.md b/Compile.md deleted file mode 100644 index 8947cecb..00000000 --- a/Compile.md +++ /dev/null @@ -1,45 +0,0 @@ -# Compile Instructions - -## Visual Studio (`.sln`) - -1. Open `MinecraftConsoles.sln` in Visual Studio 2022. -2. Set `Minecraft.Client` as the Startup Project. -3. Select configuration: - - `Debug` (recommended), or - - `Release` -4. Select platform: `Windows64`. -5. Build and run: - - `Build > Build Solution` (or `Ctrl+Shift+B`) - - Start debugging with `F5`. - -## CMake (Windows x64) - -Configure (use your VS Community instance explicitly): - -```powershell -cmake -S . -B build -G "Visual Studio 17 2022" -A x64 -DCMAKE_GENERATOR_INSTANCE="C:/Program Files/Microsoft Visual Studio/2022/Community" -``` - -Build Debug: - -```powershell -cmake --build build --config Debug --target MinecraftClient -``` - -Build Release: - -```powershell -cmake --build build --config Release --target MinecraftClient -``` - -Run executable: - -```powershell -cd .\build\Debug -.\MinecraftClient.exe -``` - -Notes: -- The CMake build is Windows-only and x64-only. -- 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 abbbb2d5..f4629073 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This project contains the source code of Minecraft Legacy Console Edition v1.3.0494.0 from https://archive.org/details/minecraft-legacy-console-edition-source-code, with some fixes and improvements applied -[Download](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly) +[Nightly Build](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly) ## Features @@ -55,6 +55,8 @@ cmake -S . -B build -G "Visual Studio 17 2022" -A x64 cmake --build build --config Debug --target MinecraftClient ``` +For more informatio, see [COMPILE.md](COMPILE.md) + ## Known Issues - Builds for other platforms have not been tested and are most likely non-functional -- cgit v1.2.3