diff --git a/COMPILE.md b/COMPILE.md index 05bf0898..5c3385de 100644 --- a/COMPILE.md +++ b/COMPILE.md @@ -3,26 +3,12 @@ ## Visual Studio 1. Clone the repo, including submodules. - - If you don't, the build will fail. `git clone --recurse-submodules https://github.com/MCLCE/MinecraftConsoles.git` + - If you don't, the build will fail. `git clone --recurse-submodules https://github.com/mclemp/MCLEClient.git` 2. Open the repo folder in Visual Studio 2022+. 3. Wait for cmake to configure the project and load all assets (this may take a few minutes on the first run). 4. Right click a folder in the solution explorer and switch to the 'CMake Targets View' -5. Select platform and configuration from the dropdown. EG: `Windows64 - Debug` or `Windows64 - Release` -6. Pick the startup project `Minecraft.Client.exe` or `Minecraft.Server.exe` using the debug targets dropdown -7. Build and run the project: - - `Build > Build Solution` (or `Ctrl+Shift+B`) - - Start debugging with `F5`. - -### Dedicated server debug arguments - -- Default debugger arguments for `Minecraft.Server`: - - `-port 25565 -bind 0.0.0.0 -name DedicatedServer` -- You can override arguments in: - - `Project Properties > Debugging > Command Arguments` -- `Minecraft.Server` post-build copies only the dedicated-server asset set: - - `Common/Media/MediaWindows64.arc` - - `Common/res` - - `Windows64/GameHDD` +5. Select platform and configuration from the dropdown. EG: `Windows64 - Release` +6. Pick the startup project `Minecraft.Client.exe` ## CMake (Windows x64) @@ -34,30 +20,12 @@ Open `Developer PowerShell for VS` and run: cmake --preset windows64 ``` -Build Debug: - -```powershell -cmake --build --preset windows64-debug --target Minecraft.Client -``` - Build Release: ```powershell cmake --build --preset windows64-release --target Minecraft.Client ``` -Build Dedicated Server (Debug): - -```powershell -cmake --build --preset windows64-debug --target Minecraft.Server -``` - -Build Dedicated Server (Release): - -```powershell -cmake --build --preset windows64-release --target Minecraft.Server -``` - Run executable: ```powershell @@ -65,13 +33,6 @@ cd .\build\windows64\Minecraft.Client\Debug .\Minecraft.Client.exe ``` -Run dedicated server: - -```powershell -cd .\build\windows64\Minecraft.Server\Debug -.\Minecraft.Server.exe -port 25565 -bind 0.0.0.0 -name DedicatedServer -``` - Notes: - Post-build asset copy is automatic for `Minecraft.Client` in CMake (Debug and Release variants). - The game relies on relative paths (for example `Common\Media\...`), so launching from the output directory is required. @@ -151,7 +112,6 @@ Build specific target: ```bash cmake --build build/windows64-clang --config Release --target Minecraft.Client -cmake --build build/windows64-clang --config Release --target Minecraft.Server ``` ### Run with Wine @@ -163,28 +123,6 @@ cd build/windows64-clang/Minecraft.Client wine ./Minecraft.Client.exe ``` -Run dedicated server: - -```bash -cd build/windows64-clang/Minecraft.Server -wine ./Minecraft.Server.exe -port 25565 -bind 0.0.0.0 -name DedicatedServer -``` - -### NixOS / Nix - -For NixOS or systems with Nix installed, use the provided flake: - -```bash -nix build .#client -nix build .#server -``` - -Or enter the development shell with all dependencies: - -```bash -nix develop -``` - Notes: - Requires LLVM 15+ with clang-cl, lld-link, llvm-rc, and llvm-mt. - The xwin tool downloads ~1GB of SDK files on first run. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92ebbea7..54b99941 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,6 @@ However, we would accept changes that... ## Current Goals -- Being a robust Desktop version of LCE - Having proper controller support across all types, brands on Desktop or Desktop-like platforms (Steam Deck) - Improving stability as much as possible - Fixing as many bugs as possible