Windows: Supported for building and running the project
macOS / Linux: The Windows nightly build will run through Wine or CrossOver based on community reports, but this is unofficial and not currently tested by the maintainers when pushing updates
Android: The Windows nightly build does run but has stability / frametime pacing issues frequently reported
iOS: No current support
All Consoles: Console support remains in the code, but maintainers are not currently verifying console functionality / porting UI Changes to the console builds at this time.

Controls (Keyboard & Mouse)

Movement: W A S D
Jump / Fly (Up): Space
Sneak / Fly (Down): Shift (Hold)
Sprint: Ctrl (Hold) or Double-tap W
Inventory: E
Chat: T
Drop Item: Q
Crafting: C Use Q and E to move through tabs (cycles Left/Right)
Toggle View (FPS/TPS): F5
Fullscreen: F11
Pause Menu: Esc
Attack / Destroy: Left Click
Use / Place: Right Click
Select Item: Mouse Wheel or keys 1 to 9
Accept or Decline Tutorial hints: Enter to accept and B to decline
Game Info (Player list and Host Options): TAB
Toggle HUD: F1
Toggle Debug Info: F3
Open Debug Overlay: F4
Toggle Debug Console: F6

Contributors

Would you like to contribute to this project? Please read our Contributor's Guide before doing so! This document includes our current goals, standards for inclusions, rules, and more.

Client Launch Arguments

Argument	Description
`-name <username>`	Overrides your in-game username.
`-fullscreen`	Launches the game in Fullscreen mode

Example:

Minecraft.Client.exe -name Steve -fullscreen

LAN Multiplayer

LAN multiplayer is available on the Windows build

Hosting a multiplayer world automatically advertises it on the local network
Other players on the same LAN can discover the session from the in-game Join Game menu
Game connections use TCP port 25565 by default
LAN discovery uses UDP port 25566
Add servers to your server list with the in-game Add Server button (temp)
Rename yourself without losing data by keeping your uid.dat
Split-screen players can join in, even in Multiplayer

Dedicated Server Software

About `server.properties`

Minecraft.Server reads server.properties from the executable working directory (Docker image: /srv/mc/server.properties). If the file is missing or contains invalid values, defaults are auto-generated/normalized on startup.

Important keys:

Key	Values / Range	Default	Notes
`server-port`	`1-65535`	`25565`	Listen TCP port
`server-ip`	string	`0.0.0.0`	Bind address
`server-name`	string (max 16 chars)	`DedicatedServer`	Host display name
`max-players`	`1-8`	`8`	Public player slots
`level-name`	string	`world`	Display world name
`level-id`	safe ID string	derived from `level-name`	Save folder ID; normalized automatically
`level-seed`	int64 or empty	empty	Empty = random seed
`world-size`	`classic\|small\|medium\|large`	`classic`	World size preset for new worlds and expansion target for existing worlds
`log-level`	`debug\|info\|warn\|error`	`info`	Server log verbosity
`autosave-interval`	`5-3600`	`60`	Seconds between autosaves
`white-list`	`true/false`	`false`	Enable access list checks
`lan-advertise`	`true/false`	`false`	LAN session advertisement

Minimal example:

server-name=DedicatedServer
server-port=25565
max-players=8
level-name=world
level-seed=
world-size=classic
log-level=info
white-list=false
lan-advertise=false
autosave-interval=60

Dedicated Server launch arguments

The server loads base settings from server.properties, then CLI arguments override those values.

Argument	Description
`-port <1-65535>`	Override `server-port`
`-ip <addr>`	Override `server-ip`
`-bind <addr>`	Alias of `-ip`
`-name <name>`	Override `server-name` (max 16 chars)
`-maxplayers <1-8>`	Override `max-players`
`-seed <int64>`	Override `level-seed`
`-loglevel <level>`	Override `log-level` (`debug`, `info`, `warn`, `error`)
`-help` / `--help` / `-h`	Print usage and exit

Examples:

Minecraft.Server.exe -name MyServer -port 25565 -ip 0.0.0.0 -maxplayers 8 -loglevel info
Minecraft.Server.exe -seed 123456789

Dedicated Server in Docker (Wine)

This repository includes a lightweight Docker setup for running the Windows dedicated server under Wine.

Quick Start (No Build, Recommended)

No local build is required. The container image is pulled from GHCR.

./start-dedicated-server.sh

start-dedicated-server.sh does the following:

uses docker-compose.dedicated-server.ghcr.yml
pulls latest image, then starts the container

If you want to skip pulling and just start:

./start-dedicated-server.sh --no-pull

Equivalent manual command:

docker compose -f docker-compose.dedicated-server.ghcr.yml up -d

Local Build Mode (Optional)

Use this only when you want to run your own locally built Minecraft.Server binary in Docker. A local build of Minecraft.Server is required for this mode.

docker compose -f docker-compose.dedicated-server.yml up -d --build

Useful environment variables:

XVFB_DISPLAY (default: :99)
XVFB_SCREEN (default: 64x64x16, tiny virtual display used by Wine)

Fixed server runtime behavior in container:

executable path: /srv/mc/Minecraft.Server.exe
bind IP: 0.0.0.0
server port: 25565

Persistent files are bind-mounted to host:

./server-data/server.properties -> /srv/mc/server.properties
./server-data/GameHDD -> /srv/mc/Windows64/GameHDD

Build & Run

Install Visual Studio 2022 or newer.
Clone the repository.
Open the project folder from Visual Studio.
Set the build configuration to Windows64 - Debug (Release is also ok but missing some debug features), then build and run.

CMake (Windows x64)

cmake --preset windows64
cmake --build --preset windows64-debug --target Minecraft.Client

For more information, see COMPILE.md.

README.md

Minecraft Consoles Renewed (Renewed + LCE)

Platform Support