diff options
| author | Loki Rautio <lokirautio@gmail.com> | 2026-03-04 03:56:03 -0600 |
|---|---|---|
| committer | Loki Rautio <lokirautio@gmail.com> | 2026-03-04 03:56:03 -0600 |
| commit | 42aec6dac53dffa6afe072560a7e1d4986112538 (patch) | |
| tree | 0836426857391df1b6a83f6368a183f83ec9b104 /COMPILE.md | |
| parent | c9d58eeac7c72f0b3038e084667b4d89a6249fce (diff) | |
| parent | ef9b6fd500dfabd9463267b0dd9e29577eea8a2b (diff) | |
Merge branch 'main' into pr/win64-world-saves
# Conflicts:
# Minecraft.Client/MinecraftServer.cpp
# README.md
Diffstat (limited to 'COMPILE.md')
| -rw-r--r-- | COMPILE.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/COMPILE.md b/COMPILE.md new file mode 100644 index 00000000..b62c9575 --- /dev/null +++ b/COMPILE.md @@ -0,0 +1,46 @@ +# 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. +- 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. |
