From b4091b8cc6ad11bb2552f9bdbda0ff8c424b2275 Mon Sep 17 00:00:00 2001 From: Parker Hawke Date: Mon, 31 Jul 2023 11:39:49 -0400 Subject: [PATCH] Update README with current enhancements and mods --- README.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 189d619..2732d46 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ Java Edition Beta 1.4's release. This can be seen because the cookie's texture i ### Patched bugs 1. Due to lack of initialization of memory, fire can potentially burn normally inflammable blocks. See [this video](https://www.youtube.com/watch?v=3hrz7KK2EJs) for a demo. -2. Due to SHAPE_FIRE not being implemented, fire is invisible in this version. Fire rendering was backported from v0.7.1 and can be disabled with the ORIGINAL_CODE define +2. Due to `SHAPE_FIRE` not being implemented, fire is invisible in this version. Fire rendering was backported from v0.7.1 and can be disabled with the `ORIGINAL_CODE` define 3. Due to `GL_BLEND` being disabled, the hotbar renders as fully opaque. 4. Memory is leaked when leaving a world with particles in it. 5. Stairs are invisible when held. To fix this, a fix has been backported from v0.1.1j 6. If the game is left on for approximately 1,242 days, the level will freeze, but the GUI will still be interactable. -The bugs can be "un-patched" by defining ORIGINAL_CODE. This allows compilation of an incomplete and mostly accurate recreation of MCPE for Xperia Play. +The bugs can be "un-patched" by defining `ORIGINAL_CODE`. This allows compilation of an incomplete and mostly accurate recreation of MCPE for Xperia Play. ### Unpatched bugs 1. Particles with render texture 3 are invisible. @@ -61,21 +61,34 @@ The bugs can be "un-patched" by defining ORIGINAL_CODE. This allows compilation 6. Due to inaccuracies in level generation, some blocks may be different in multiplayer between a player on this version, and a player on the original MCPE. ## Enhancements -The original Minecraft: Pocket Edition had some missing details that make it feel like MCPE. Here are some enhancements that I've done (these are all turned off with the -ORIGINAL_CODE define) +The original Minecraft: Pocket Edition had some missing details that make it feel like MCPE. Here are some enhancements that have been done: -* Make fire burn properly (see Patched bug #1) -* Allow fire to be rendered (see Patched bug #2) -* Allow instant breaking of blocks -* Make entity models have primitive shading -* Make in-hand items have shading -* Use a GUI scale of 2 instead of 3 (temporary) -* Allow enabling ambient occlusion (smooth lighting), using a hotkey (F4) -* Allow the hotbar to be transparent. Fixes Patched bug #3 -* Use Minecraft Java Edition Beta 1.6's light ramp code instead of the original (Max brightness was only 0.8 in early versions of PE for whatever reason) -* Hide particles from a camera's view. This hides the smoke particles that the camera emits, creating a clearer picture +* (`ENH_ENTITY_SHADING`) Make entity models have primitive shading +* (`ENH_SHADE_HELD_TILES`) Make in-hand block items have shading +* (`ENH_FIX_INVIS_STAIRS`) Fix 16x16x16 chunks of stairs rendering as invisible +* (`ENH_ALLOW_AO`) Allow enabling ambient occlusion (smooth lighting) using a hotkey (F4) +* (`ENH_TRANSPARENT_HOTBAR`) Allow the hotbar to be transparent. (See patched bugs #3) +* (`ENH_INSTA_BREAK`) Allow instant breaking of blocks +* (`ENH_CAMERA_NO_PARTICLES`) Hide particles from a camera's view. This hides the smoke particles that the camera emits, creating a clearer picture +* (`ENH_USE_JAVA_LIGHT_RAMP`) Use Minecraft: Java Edition Beta 1.6's light ramp code instead of the original (max brightness was only 0.8 in early versions of MC:PE for whatever reason) +* (`ENH_RUN_DAY_NIGHT_CYCLE`) Allow the day/night cycle to run +* (`ENH_ENABLE_9TH_SLOT`) Allow the 9th slot of the hotbar to be used instead of the unusable elipses (...) +* (`ENH_USE_OWN_AO`) Use a custom ambient occlusion engine (looks the same but fixes some corners) +* (`ENH_ADD_OPTIONS_PAUSE`) Add an "Options" button to the pause menu +* (`ENH_EXTRA_ITEMS_IN_INV`) Add extra items to a 5th row in the creative inventory +* (`ENH_HIGHLIGHT_BY_HOVER`) Highlight buttons when hovering over them instead of when using arrow keys +* (`ENH_ALLOW_SAND_GRAVITY`) Allow sand to fall +* (`ENH_USE_GUI_SCALE_2`) Use a GUI scale of 2 instead of 3 which looks better on PC (temporary) +* (`ENH_ALLOW_SCROLL_WHEEL`) Allow use of the scroll wheel to change selected inventory slots -They can be turned on/off in `source/Base/Utils.hpp`. They're disabled by default. +They can be turned on/off in `GameMods.hpp`. All enhancements are enabled by default unless explicitly disabled or `ORIGINAL_CODE` is defined. ### Known bugs with enhancements 1. The camera's white overlay is fully opaque in shaded entity mode. + +## Mods +In addition to enhancements, optional modifications to the base game were made. These mods are disabled by default but can be enabled in `GameMods.hpp`. + +* (`MOD_USE_FLAT_WORLD`) Use a flat world instead of regular world generation +* (`MOD_USE_BIGGER_SCREEN_SIZE`) Use a bigger screen size of 1280x720 instead of 854x480 +* (`MOD_DONT_COLOR_GRASS`) Don't tint the top of grass tiles with a different color (like Classic)