aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorrtm516 <rtm516@users.noreply.github.com>2026-03-17 21:39:22 +0000
committerGitHub <noreply@github.com>2026-03-17 16:39:22 -0500
commit02a5961f39673be403fda3edbf6fb1265bd93477 (patch)
treeade5f3cfd70fcb6e0add6492f182cc571bec7f3a /README.md
parent1a3fcb5b2010fbbf5ef0ab52f7291a4129f05842 (diff)
Move project to CMake (#781)
* Move to cmake * Move sources to source_groups and ditch more old VS files * Add BuildVer.h generation * Break out cmake source lists to platforms * Don't copy swf files * Revert audio changes from merge * Add platform defines * Match MSBuild flags * Move BuildVer.h to common include and fix rebuild issue * Seperate projects properly * Exclude more files and make sure GameHDD exists * Missing line * Remove remaining VS project files * Update readme and actions * Use incremental LTCG * Update workflows * Update build workflows and output folder * Disable vcpkg checks * Force MSVC * Use precompiled headers * Only use PCH for cpp * Exclude compat_shims from PCH * Handle per-platform source includes * Copy only current platform media * Define Iggy libs per platform * Fix EnsureGameHDD check * Only set WIN32_EXECUTABLE on Windows * Correct Iggy libs path * Remove include of terrain_MipmapLevel * Correct path to xsb/xwb * Implement copilot suggestions * Add clang flags (untested) * Fix robocopy error checking * Update documentation * Drop CMakePresets.json version as we dont use v6 features * Always cleanup artifacts in nightly even if some builds fail * Re-work compiler target options * Move newer iggy dll into redist and cleanup * Fix typos * Remove 'Source Files' from all source groups * Remove old ps1 build scripts
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/README.md b/README.md
index 93a0187e..e011c1ea 100644
--- a/README.md
+++ b/README.md
@@ -204,17 +204,16 @@ Persistent files are bind-mounted to host:
## Build & Run
-1. Install [Visual Studio 2022](https://aka.ms/vs/17/release/vs_community.exe).
+1. Install [Visual Studio 2022](https://aka.ms/vs/17/release/vs_community.exe) or [newer](https://visualstudio.microsoft.com/downloads/).
2. Clone the repository.
-3. Open the project by double-clicking `MinecraftConsoles.sln`.
-4. Make sure `Minecraft.Client` is set as the Startup Project.
-5. Set the build configuration to **Debug** (Release is also ok but missing some debug features) and the target platform to **Windows64**, then build and run.
+3. Open the project folder from Visual Studio.
+4. Set the build configuration to **Windows64 - Debug** (Release is also ok but missing some debug features), then build and run.
### CMake (Windows x64)
```powershell
-cmake -S . -B build -G "Visual Studio 17 2022" -A x64
-cmake --build build --config Debug --target MinecraftClient
+cmake --preset windows64
+cmake --build --preset windows64-debug --target Minecraft.Client
```
For more information, see [COMPILE.md](COMPILE.md).