aboutsummaryrefslogtreecommitdiff
path: root/COMPILE.md
diff options
context:
space:
mode:
Diffstat (limited to 'COMPILE.md')
-rw-r--r--COMPILE.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/COMPILE.md b/COMPILE.md
index b62c9575..86fb5cee 100644
--- a/COMPILE.md
+++ b/COMPILE.md
@@ -3,7 +3,9 @@
## Visual Studio (`.sln`)
1. Open `MinecraftConsoles.sln` in Visual Studio 2022.
-2. Set `Minecraft.Client` as the Startup Project.
+2. Set Startup Project:
+ - Client: `Minecraft.Client`
+ - Dedicated server: `Minecraft.Server`
3. Select configuration:
- `Debug` (recommended), or
- `Release`
@@ -12,6 +14,17 @@
- `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`
+
## CMake (Windows x64)
Configure (use your VS Community instance explicitly):
@@ -32,6 +45,18 @@ Build Release:
cmake --build build --config Release --target MinecraftClient
```
+Build Dedicated Server (Debug):
+
+```powershell
+cmake --build build --config Debug --target MinecraftServer
+```
+
+Build Dedicated Server (Release):
+
+```powershell
+cmake --build build --config Release --target MinecraftServer
+```
+
Run executable:
```powershell
@@ -39,6 +64,13 @@ cd .\build\Debug
.\MinecraftClient.exe
```
+Run dedicated server:
+
+```powershell
+cd .\build\Debug
+.\Minecraft.Server.exe -port 25565 -bind 0.0.0.0 -name DedicatedServer
+```
+
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.