b1b622c303
* Fix overlapping debug menus and screens Also resolves a formatting issue with clang-format * Update readme
87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
# MinecraftConsoles
|
|
|
|
[](https://discord.gg/jrum7HhegA)
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
This project contains the source code of Minecraft Legacy Console Edition v1.6.0560.0 (TU19) from https://archive.org/details/minecraft-legacy-console-edition-source-code, with some fixes and improvements applied
|
|
|
|
[Nightly Build](https://github.com/smartcmd/MinecraftConsoles/releases/tag/nightly)
|
|
|
|
## Platform Support
|
|
|
|
- **Windows**: Supported for building and running the project
|
|
- **macOS / Linux**: The Windows nightly build may run through Wine or CrossOver based on community reports, but this is unofficial and not currently tested by the maintainers
|
|
|
|
## Features
|
|
|
|
- Fixed compilation and execution in both Debug and Release mode on Windows using Visual Studio 2022
|
|
- Added support for keyboard and mouse input
|
|
- Added fullscreen mode support (toggle using F11)
|
|
- Disabled V-Sync for better performance
|
|
- Added a high-resolution timer path on Windows for smoother high-FPS gameplay timing
|
|
- Device's screen resolution will be used as the game resolution instead of using a fixed resolution (1920x1080)
|
|
- LAN Multiplayer & Discovery
|
|
|
|
## Multiplayer
|
|
|
|
Basic 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`
|
|
- You can override your in-game username at launch with `username.txt`
|
|
|
|
This feature is based on [LCEMP](https://github.com/LCEMP/LCEMP/)
|
|
|
|
## 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`
|
|
- **Drop Item**: `Q`
|
|
- **Crafting**: `C`
|
|
- **Toggle View (FPS/TPS)**: `F5`
|
|
- **Fullscreen**: `F11`
|
|
- **Pause Menu**: `Esc`
|
|
- **Toggle Mouse Capture**: `Left Alt` (for debugging)
|
|
- **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`
|
|
|
|
## Build & Run
|
|
|
|
1. Install Visual Studio 2022
|
|
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 has some bugs) and the target platform to **Windows64**, 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
|
|
```
|
|
|
|
For more information, see [COMPILE.md](COMPILE.md)
|
|
|
|
## Known Issues
|
|
|
|
- Native builds for platforms other than Windows have not been tested and are most likely non-functional. The Windows nightly build may still run on macOS and Linux through Wine or CrossOver, but that path is unofficial and not currently supported
|
|
|
|
## Star History
|
|
|
|
[](https://www.star-history.com/?spm=a2c6h.12873639.article-detail.7.7b9d7fabjNxTRk#smartcmd/MinecraftConsoles&type=date&legend=top-left)
|