Minecraftconsoles Lce

1---2name: minecraftconsoles-lce3description: Expert skill for building, running, and extending MinecraftConsoles (Minecraft Legacy Console Edition) — a C++ multi-platform reimplementation with dedicated server, LAN multiplayer, and modding support.4triggers:5  - "help me build MinecraftConsoles"6  - "how do I run the Minecraft Legacy Console Edition project"7  - "set up dedicated server for MinecraftConsoles"8  - "add keyboard mouse controls to LCE"9  - "configure server.properties for MinecraftConsoles"10  - "compile MinecraftConsoles with CMake or Visual Studio"11  - "how do I mod or contribute to MinecraftConsoles"12  - "fix build errors in MinecraftConsoles C++ project"13---14 15# MinecraftConsoles (Legacy Console Edition) Skill16 17> Skill by [ara.so](https://ara.so) — Daily 2026 Skills collection.18 19## What This Project Is20 21MinecraftConsoles is a C++ reimplementation/continuation of **Minecraft Legacy Console Edition v1.6.0560.0 (TU19)**, targeting modern Windows (and unofficially macOS/Linux via Wine). Goals include:22 23- Multi-platform base for modding, backports, and LCE development24- Quality desktop experience with keyboard/mouse and controller support25- LAN multiplayer and dedicated server software26- Splitscreen multiplayer support27 28**Repository:** `smartcmd/MinecraftConsoles`  29**Primary language:** C++  30**Build system:** Visual Studio 2022 solution (`.sln`) + CMake support  31 32---33 34## Quick Start35 36### Prerequisites37 38- **Windows** (primary supported platform)39- [Visual Studio 2022](https://aka.ms/vs/17/release/vs_community.exe) with C++ desktop workload40- Git41 42### Clone43 44```bash45git clone https://github.com/smartcmd/MinecraftConsoles.git46cd MinecraftConsoles47```48 49### Build with Visual Studio50 511. Open `MinecraftConsoles.sln` in Visual Studio 2022522. Set **Startup Project** to `Minecraft.Client`533. Set configuration to **Debug** (or Release), platform to **Windows64**544. Press **F5** or **Ctrl+F5** to build and run55 56### Build with CMake (Windows x64)57 58```powershell59# Configure60cmake -S . -B build -G "Visual Studio 17 2022" -A x6461 62# Build the client63cmake --build build --config Debug --target MinecraftClient64 65# Build the dedicated server66cmake --build build --config Debug --target MinecraftServer67```68 69See `COMPILE.md` in the repo for additional platform-specific notes.70 71---72 73## Running the Client74 75### Nightly Build (No Compile Needed)76 77Download the `.zip` from the [Nightly Release](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly), extract, and run `Minecraft.Client.exe`.78 79### Setting Your Username80 81Create `username.txt` in the same directory as the executable:82 83```84Steve85```86 87Or use a launch argument:88 89```powershell90Minecraft.Client.exe -name Steve91Minecraft.Client.exe -name Steve -fullscreen92```93 94### Client Launch Arguments95 96| Argument | Description |97|---|---|98| `-name <username>` | Override in-game username |99| `-fullscreen` | Launch in fullscreen mode |100 101---102 103## Keyboard & Mouse Controls104 105| Action | Key/Button |106|---|---|107| Move | `W` `A` `S` `D` |108| Jump / Fly Up | `Space` |109| Sneak / Fly Down | `Shift` (hold) |110| Sprint | `Ctrl` (hold) or double-tap `W` |111| Inventory | `E` |112| Chat | `T` |113| Drop Item | `Q` |114| Crafting | `C` (tabs: `Q` / `E`) |115| Attack / Destroy | Left Click |116| Use / Place | Right Click |117| Select hotbar slot | `1`–`9` or Mouse Wheel |118| Pause | `Esc` |119| Fullscreen | `F11` |120| Toggle HUD | `F1` |121| Toggle Debug Info | `F3` |122| Debug Overlay | `F4` |123| Toggle Debug Console | `F6` |124| Toggle FPS/TPS view | `F5` |125| Player list / Host Options | `Tab` |126| Accept tutorial hint | `Enter` |127| Decline tutorial hint | `B` |128 129---130 131## LAN Multiplayer132 133LAN multiplayer works automatically on the Windows build:134 135- Hosting a world **auto-advertises** it on the local network136- Other players discover sessions via **Join Game** menu137- TCP port: **25565** (game connections)138- UDP port: **25566** (LAN discovery)139- Use the **Add Server** button to connect to known IPs140- Username changes are safe — keep `uid.dat` to preserve your data across renames141- Splitscreen players can join LAN/multiplayer sessions142 143---144 145## Dedicated Server146 147### Download Nightly Server Build148 149[Nightly Dedicated Server](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly-dedicated-server)150 151### Run Directly (Windows)152 153```powershell154Minecraft.Server.exe -name MyServer -port 25565 -ip 0.0.0.0 -maxplayers 8 -loglevel info155Minecraft.Server.exe -seed 123456789156```157 158### Server CLI Arguments159 160| Argument | Description |161|---|---|162| `-port <1-65535>` | Override `server-port` |163| `-ip <addr>` | Override `server-ip` (bind address) |164| `-bind <addr>` | Alias of `-ip` |165| `-name <name>` | Override `server-name` (max 16 chars) |166| `-maxplayers <1-8>` | Override `max-players` |167| `-seed <int64>` | Override `level-seed` |168| `-loglevel <level>` | `debug`, `info`, `warn`, `error` |169| `-help` / `--help` / `-h` | Print usage and exit |170 171### `server.properties` Configuration172 173Located in the same directory as `Minecraft.Server.exe`. Auto-generated with defaults if missing.174 175```properties176server-name=DedicatedServer177server-port=25565178server-ip=0.0.0.0179max-players=8180level-name=world181level-id=world182level-seed=183world-size=classic184log-level=info185white-list=false186lan-advertise=false187autosave-interval=60188```189 190**Key property notes:**191 192| Key | Values | Default | Notes |193|---|---|---|---|194| `server-port` | `1–65535` | `25565` | TCP listen port |195| `server-ip` | string | `0.0.0.0` | Bind address |196| `server-name` | string | `DedicatedServer` | Max 16 chars |197| `max-players` | `1–8` | `8` | Player slots |198| `level-seed` | int64 or empty | empty | Empty = random |199| `world-size` | `classic\|small\|medium\|large` | `classic` | New world size |200| `log-level` | `debug\|info\|warn\|error` | `info` | Verbosity |201| `autosave-interval` | `5–3600` | `60` | Seconds between autosaves |202| `white-list` | `true/false` | `false` | Enable whitelist |203| `lan-advertise` | `true/false` | `false` | LAN advertisement |204 205---206 207## Dedicated Server in Docker (Linux/Wine)208 209### Recommended: Pull from GHCR (No Local Build)210 211```bash212# Start (pulls latest image automatically)213./start-dedicated-server.sh214 215# Start without pulling216./start-dedicated-server.sh --no-pull217 218# Equivalent manual command219docker compose -f docker-compose.dedicated-server.ghcr.yml up -d220```221 222### Local Build Mode (Optional)223 224Requires a locally compiled `Minecraft.Server.exe`:225 226```bash227docker compose -f docker-compose.dedicated-server.yml up -d --build228```229 230### Docker Persistent Volumes231 232| Host Path | Container Path | Purpose |233|---|---|---|234| `./server-data/server.properties` | `/srv/mc/server.properties` | Server config |235| `./server-data/GameHDD` | `/srv/mc/Windows64/GameHDD` | World save data |236 237### Docker Environment Variables238 239| Variable | Default | Description |240|---|---|---|241| `XVFB_DISPLAY` | `:99` | Virtual display number |242| `XVFB_SCREEN` | `64x64x16` | Virtual screen size (tiny, Wine needs it) |243 244---245 246## Project Structure (Key Areas)247 248```249MinecraftConsoles/250├── MinecraftConsoles.sln       # Visual Studio solution251├── CMakeLists.txt              # CMake build definition252├── COMPILE.md                  # Detailed compile instructions253├── CONTRIBUTING.md             # Contributor guide and project goals254├── docker-compose.dedicated-server.ghcr.yml  # Docker (GHCR image)255├── docker-compose.dedicated-server.yml       # Docker (local build)256├── start-dedicated-server.sh   # Quick-start script257├── server-data/258│   ├── server.properties       # Server config (auto-generated)259│   └── GameHDD/                # World save data260└── .github/261    └── banner.png262```263 264---265 266## Common C++ Patterns in This Codebase267 268### Adding a New Key Binding (Keyboard Input)269 270The project added keyboard/mouse support on top of the original controller-only code. When extending input:271 272```cpp273// Typical pattern for checking key state in the input handler274// Find the keyboard input processing file and add your key check:275 276bool isKeyPressed(int virtualKey) {277    return (GetAsyncKeyState(virtualKey) & 0x8000) != 0;278}279 280// Example: adding a new toggle key281if (isKeyPressed(VK_F7)) {282    // toggle your feature283    myFeatureEnabled = !myFeatureEnabled;284}285```286 287### Registering a Launch Argument288 289Follow the existing `-name` / `-fullscreen` pattern:290 291```cpp292// In the argument parsing section (typically in main or init):293for (int i = 1; i < argc; i++) {294    std::string arg = argv[i];295 296    if (arg == "-name" && i + 1 < argc) {297        username = argv[++i];298    }299    else if (arg == "-fullscreen") {300        launchFullscreen = true;301    }302    // Add your argument:303    else if (arg == "-myoption" && i + 1 < argc) {304        myOption = argv[++i];305    }306}307```308 309### Reading `server.properties`310 311```cpp312#include <fstream>313#include <sstream>314#include <map>315#include <string>316 317std::map<std::string, std::string> loadServerProperties(const std::string& path) {318    std::map<std::string, std::string> props;319    std::ifstream file(path);320    std::string line;321 322    while (std::getline(file, line)) {323        if (line.empty() || line[0] == '#') continue;324        auto eq = line.find('=');325        if (eq == std::string::npos) continue;326        std::string key = line.substr(0, eq);327        std::string val = line.substr(eq + 1);328        props[key] = val;329    }330    return props;331}332 333// Usage:334auto props = loadServerProperties("server.properties");335int port = std::stoi(props.count("server-port") ? props["server-port"] : "25565");336std::string serverName = props.count("server-name") ? props["server-name"] : "DedicatedServer";337```338 339### Writing `server.properties` (Normalize / Auto-generate)340 341```cpp342void writeServerProperties(const std::string& path,343                            const std::map<std::string, std::string>& props) {344    std::ofstream file(path);345    for (auto& [key, val] : props) {346        file << key << "=" << val << "\n";347    }348}349 350// Normalize level-id from level-name351std::string normalizeLevelId(const std::string& levelName) {352    std::string id = levelName;353    // Remove unsafe characters, lowercase, replace spaces with underscores354    for (char& c : id) {355        if (!std::isalnum(c) && c != '_' && c != '-') c = '_';356    }357    return id;358}359```360 361---362 363## Troubleshooting364 365### Build Fails: Missing Windows SDK366 367- Open **Visual Studio Installer** → Modify → add **Windows 10/11 SDK**368- Make sure the platform is set to **Windows64** (not x86)369 370### CMake Can't Find Visual Studio Generator371 372```powershell373# Confirm VS 2022 is installed, then:374cmake -S . -B build -G "Visual Studio 17 2022" -A x64375# "17 2022" is the generator name for VS 2022376```377 378### Game Launches But No Display / Crashes Immediately379 380- Ensure you're running from the directory containing all game assets381- Check that your GPU drivers support the required DirectX version382- Try **Debug** build for more verbose error output383 384### Server Not Visible on LAN385 386- Check firewall rules allow **TCP 25565** and **UDP 25566**387- Verify `lan-advertise=true` is NOT required for dedicated servers (it's for LAN broadcast; clients discover via Join Game)388- Ensure both client and server are on the same subnet389 390### Docker Server: Wine Can't Display391 392- The `XVFB_DISPLAY` env var must match what Wine uses393- The container uses a minimal `64x64x16` virtual framebuffer — don't change this unless you have a reason394 395### Username Reset / UID Issues396 397- **Do not delete `uid.dat`** — it stores your unique player ID398- If you rename yourself via `-name` or `username.txt`, your existing `uid.dat` keeps world data linked to your account399 400### macOS / Linux (Wine)401 402- Download the Windows nightly `.zip`403- Run via `wine Minecraft.Client.exe` or CrossOver404- Stability issues (frametime pacing) are known and community-reported; not officially supported405 406---407 408## Contributing409 410Read [`CONTRIBUTING.md`](https://github.com/smartcmd/MinecraftConsoles/blob/main/CONTRIBUTING.md) before submitting PRs. Key points:411 412- Follow existing code style and naming conventions413- Console build compatibility should not be broken without discussion414- Security fixes are always welcome415- Check open issues (535+) for good first tasks416- Join the [Discord](https://discord.gg/jrum7HhegA) for contributor discussion417 418---419 420## Platform Support Summary421 422| Platform | Status |423|---|---|424| Windows (VS 2022) | ✅ Fully supported |425| macOS / Linux (Wine) | ⚠️ Community-reported working, unofficial |426| Android (Wine) | ⚠️ Runs with frametime issues |427| iOS | ❌ No support |428| Consoles | ⚠️ Code present, not actively maintained |