EssentialGUI Readme

                                                   =========================
                                                   EssentialGUI-1.8.4+1.19.3
                                                   =========================

At any time during the game, you can access the EssentialGUI Options Menu by pressing the F12 key. Also you can access by pressing the button located at Minecraft's Options Menu Screen.

[CONTENTS]
==============================
1. HUD SECTIONS MENU
2. VANILLA HUD CHANGES
3. BLOCK OUTLINE CUSTOMIZATION
4. OTHER FEATURES
5. AUTHOR NOTES
==============================

1. HUD SECTIONS
1.1. CLIENT/PLAYER & WORLD (HUD with different styles, toggleable through F12 options)
1.1.1. CLIENT PERFORMANCE:

· CLIENT FPS: Shows client frames per second.
· CLIENT CPU LOAD: Shows the recent CPU usage by the system.
· CLIENT LATENCY: Shows client latency (Multiplayer only).
· CLIENT MEMORY: Shows the total amount of memory in use by Minecraft.
· NETWORK PACKETS: Shows sent and received packets (Multiplayer only).

1.1.2. PLAYER POSITION:

· PLAYER COORDINATES: Shows player's coordinates.
· DIMENSIONAL COORDINATES: Shows player's Overworld coordinates when in The Nether.
· STAND-BLOCK CHUNK: Shows player's within a chunk position.
· PLAYER FACING: Shows where player is facing at.
· FACING AXIS INFO: Shows player's facing axis.
· PLAYER ROTATION: Shows player's yaw and pitch degrees.
· STAND-BLOCK LIGHT: Shows the light level of the block at player position.
· PLAYER SPEED: Shows current player speed in blocks per second.

1.1.3. WORLD INFO:

· BIOME NAME: Shows current biome name.
· LOADED ENTITIES: Shows rendered / total entities loaded.
· LOADED BLOCK ENTITIES: Shows total block entities loaded.
· WORLD TIME: Shows current world time. The format can be toggled (hour / ticks).
· WORLD DAYS: Shows total days of the current world.

1.2. PLAYER WARNING (Bottom-Left)

· TIME SINCE LAST REST: Shows number of days the player has not slept. Phantoms will appear past 3 days.
· HEALTH WARNING: A warning heart icon will show up when player's health <= 10.
· HUNGER WARNING: A warning hunger icon will show up when player's hunger <= 10.
· OXYGEN LEVEL: When oxygen begins to drop, a warning icon and seconds counter will appear. A secondary hud will also show up near the cursor (toggleable through F12 options).
· FREEZING WARNING: A warning frozen heart icon will show up when player is inside Powder Snow block. After 7 seconds inside this block, the player will start getting damage.
· CRITICAL HEALTH WARNING: When player's health drop to 10 or less, cursor texture will change to red. Also this option removes alpha transparency to default crosshair texture.
· SATURATION WARNING: When your hunger saturation is > 0, a green + (plus) will shown in your hunger bar.

1.3. POINTED BLOCK (Top-Center)

· BLOCK NAME & COORDS: It will show block name and coordinates.
· COLORED TEXTS: It will change block name and coordinates text colors. Some of them identify the block state (blue, waterlogged).
· BREAKING PROGRESS: If enabled a breaking progress will appear at block name.
· HARVEST ICONS: A check will indicate that player can mine the block. Also it will show the appropiate tool and if needs Silk Touch.
· PROPERTIES ICONS: Various block properties will show up as icons.
· ADVANCED PROPERTIES: If you press and hold contextual menu <Left-Alt> by default (configurable) while pointing to a block, it will show advanced properties like block states, growing stages...

1.4. POINTED ENTITY (Top-Center)

· ENTITY NAME & HEALTH/COORDINATES: Will show entity name and health or coordinates (toggleable).
· COLORED TEXTS: It will change entity name and coordinates text colors. Some of them identify the type of entity (red, monster).
· HEALTH & OXYGEN BARS: It will show entity health and oxygen meter bars (toggleable location).
· ENTITIES EQUIPMENT: Shows current entity equipment while pointing at any entity and holding down Left-Alt (if applicable).
· ADVANCED PROPERTIES: If you press and hold contextual menu <Left-Alt> by default (configurable) while pointing to a entity, it will show advanced properties.
· INTERACT ICONS: Various entity actions will show as icons.
· PROPERTIES ICONS: Various entity properties will show up as icons.
· MULTIPLAYER EQUIPMENT: Shows other players equipment and enchantments.

1.5. PLAYER EQUIPMENT:

· QUIVER HUD: While wielding a bow/crossbow, a quiver hud will appear near the action bar showing your arrows amount. If crosshair Hud Mode selected, hold Shift to show the Hud.
· FOOD STATS HUD: When holding a food, a hunger slot will appear right of the hotbar indicating the amount that satiates.
· LOW DURABILITY HUD: When the equiped tool/weapon durability drops to 20 or more, it will show a blinking icon near the crosshair.

· EQUIPMENT: Shows your equipped armor, sword/tool and shield. Also will show your arrows amount (quiver).
	· XP STATS: Shows your current xp level and total score points.
	· HEALTH & HUNGER STATS: Shows your health value and hunger / saturation levels.
	· ENCHANTMENT PROTECTION FACTOR (EPF): Shows your total armor points / Tough armor value and your enchantment protection factor, it 					 	depends on the enchantments on your armor. (see https://minecraft.fandom.com/wiki/Armor).
	· ATTACK STATS: Shows your attack damage and attack speed values.
	· STATUS EFFECTS: It will show your active status effects and duration in text format.

· SHULKER BOX & BUNDLE HUD: If you press and hold contextual menu <Left-Alt> by default (configurable) while holding a non-empty Shulker Box/Bundle, a hud will pop up showing his contents.
· ITEM STOCK HUD: When holding a item/block, a bundle hud will appear right of the hotbar showing the total amount in your inventory.

· ON-SCREEN EQUIPMENT: It will show equipped armor and tools.
	· ITEM DURABILITY: It will show the durability of the armor pieces.
	· DURABILITY FORMAT: Toggle between damage of percent format.
	· ARMS EQUIPMENT: Shows the equipment of your arms.
	· TEXTURE TYPE: Cycles between EssentilaGUI, Vanilla and none texture.

1.6. BIOME/WEATHER/TIME (Top-Left, toggleable)

· This section will show a HUD with day, night, biome and weather icons. In addition and if the moon phase is appropiate, will show an icon indicating the spawning quality of the slimes in the swamps.

1.7. ADVANCED ITEM TOOLTIPS:

· ADVANCED ITEM DURABILITY: Will show the item durability and percent without F3+H enabled.
· ITEM PENALTY: This option will show and indicate the penalty level of the item (times repaired/enchanted).
· LODESTONE COMPASS INFO: This option will show the coordinates and dimension of the linked Lodestone.
· BUNDLE CAPACITY INFO: When hovering this will show the bundle capacity percent.
· AXOLOTL BUCKET INFO: This option will show the variant and health of the captured axolotl.
· RECOVERY COMPASS INFO: When hovering in survival and when in the inventory screen, this will show your last death coordinates.
· TROPICAL FISH BUCKET INFO: Shows extended info about the variant of the fish.
· ENHANCED BOOKS INFO: Will show number of pages.
· MILK BUCKET INFO: Will show the effects of the Milk when drinking.
· TURTLE HELMET INFO: Will show the effects of the helmet when equipped.
· ENHANCED MAPS INFO: When hovering any map, it will show more properties and treasure coordinates (if applicable).
· ITEM COMPARISON: When hovering any armor or tool item and if we have any similar item equipped, a tooltip will show.
· ADVANCED FOOD STATS: When hovering a food item, it will show Restored Hunger, Saturation and Restored Saturation values.
	· SHOW PLAYER HUNGER INFO: When hovering a food the player hunger will appear for comparison.
	· FOOD STATUS EFFECTS: Will show if the food will apply any Status Effect when consumed.
· ADVANCED BLOCK NBT:
	· BEE NEST/BEEHIVE INFO: When hovering, it will show Honey Level and Bees amount.
	· SHOW CONTAINER CONTENTS: When hovering a container (chest, furnace, Shulker Box) if the item contains items NBT, it will show the contents in a GUI.
	· LECTERN BOOK INFO: When hovering, it will show all information about the book.
	· JUKEBOX DISC INFO: When hovering, it will show information about the disc inside.
	· SIGN TEXT INFO: Will print all text lines in GUI.
	· BEACON EFFECTS INFO: Will show the beacon item effects and pyramid level.
	· MOB SPAWNER INFO: Will show the advanced nbt tags of this block.
· FUEL STATS INFO: When hovering any item that can be burn as fuel, it will show fuel properties and stats.

2. VANILLA HUD CHANGES:

· PUMPKIN OVERLAY: This option removes the first-person overlay texture of the pumpkin.
· VIGNETTE OVERLAY: This option removes the overlay corners texture (this texture darkens the screen angles).
· WITHER DARKEN SKY: This option disables the sky darkening when the player is near a Wither Boss.
· RAIN & SNOW PARTICLES: Toggle the rendering of the rain and snow particles.
· OTHER PARTICLES: Toggle the rendering of miscelaneous particles (block breaking, potion effects...).
· MOUNT HEALTH IN CREATIVE: Toggles the horse health bar when player is in creative.
· BETTER HELD ITEM TOOLTIP: Improves and add background to Held Item Text.
· ACTION BAR BACKGROUND FIX: Fixes action bar background height.
· STATUS EFFECTS: This option controls the rendering, position and duration of the active Status Effects.
	· HUD LOCATION: Choose the location of the Status Effects.
	· TEXTURE TYPE: Choose between vanilla and colored textures representing the effect type.
	· SHOW EFFECTS DURATION: Toggle to show Effects duration.
	· COLORED DURATION: Toggle if the text duration will show in colors or gray.
· ADVANCED FURNACE STATS: This option controls the rendering, position and texture type for Advanced Furnace and Fuel Stats.
	· HUD LOCATION: Choose between right and left position.
	· TEXTURE TYPE: Choose between vailla colors or dark alternative.
· INVENTORY SLOT HIGHLIGHT: Allows to customize Inventory Slot Highlight gradient color and border.

3. BLOCK OUTLINE CUSTOMIZATION

· This section allows you to change the block outline color and transparency that appears when you look at it.

4. OTHER FEATURES:

· NIGHT VISION HACK: While in-game if you press <F8> key, it will apply infinite night vision effect.
· TOGGLE SMOOTH LIGHTING: While in-game if you press <F9> key, it will toggle the different lighting modes.
· DEBUG LOADED ENTITIES: While in-game if you press <F10> key, a screen will appear showing all the entities loaded.
· ZOOM: Press and hold the <z> key.
· GAMMA LEVEL: During the game, if you press <+> and/or <-> keys, the gamma level will increase or decrease.
· BUCKET OF AXOLOTL VARIANTS: Depending of the Axolotl captured, it will change the item texture.
· BUCKET OF TROPICAL FISH VARIANTS: Added common 22 fish item variants.

5. AUTHOR NOTES:

#1: If something goes wrong and any section or option does not work properly, try to remove the configuration file located at "your_minecraft_folder\config\essentialgui.json".