2026-03-01 15:07:50 -07:00
# Compile Instructions
## Visual Studio (`.sln`)
2026-03-01 15:26:34 -07:00
1. Open `MinecraftConsoles.sln` in Visual Studio 2022.
2026-03-01 15:07:50 -07:00
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.
2026-03-03 05:43:32 +08:00
- 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.
2026-03-01 15:07:50 -07:00
- 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.