Skip to content

Latest commit

 

History

History
138 lines (94 loc) · 4.36 KB

README.md

File metadata and controls

138 lines (94 loc) · 4.36 KB
Raw

ChestESP

This mod highlights nearby chests so you can see them through walls. It's based on a Wurst Client feature of the same name.

A screenshot showing all of the different containers that ChestESP supports

Downloads

Download ChestESP

Installation

Important

Always make sure that your modloader and all of your mods are made for the same Minecraft version. Your game will crash if you mix different versions.

Installation using Fabric

  1. Install Fabric Loader.
  2. Add Fabric API to your mods folder.
  3. Add ChestESP to your mods folder.

Note

Older ChestESP versions also required that you add Cloth Config and ModMenu to your mods folder. As of ChestESP 1.2, you no longer need to do this.

Installation using NeoForge

  1. Install NeoForge.
  2. Add ChestESP to your mods folder.

Usage

Once installed, ChestESP will automatically highlight any nearby chests.

The mod also comes with an in-game settings menu that can be accessed through ModMenu in Fabric or the built-in mod list in NeoForge.

A screenshot showing ChestESP's settings menu, powered by Cloth Config

In the settings menu, you can:

  • Change the style of the highlights (boxes, lines, or both).
  • Customize the color of each container type.
  • Toggle on/off specific container types.
  • Enable/disable the entire mod.

There is also a "Toggle ChestESP" entry in the Options > Controls > Key Binds menu that allows you to quickly enable/disable the mod at the press of a button. This feature is not bound to any key by default.

Supported containers

ChestESP supports the following container types:

  • Chests
  • Trapped chests
  • Ender chests
  • Barrels
  • Shulker boxes
  • Decorated pots
  • Chest minecarts
  • Chest boats
  • Hopper minecarts
  • Hoppers
  • Droppers
  • Dispensers
  • Furnaces
  • Blast furnaces
  • Smokers

Not all of these containers are enabled by default to prevent cluttering your screen. Be sure to check the settings menu and enable all the ones you want.

Supported languages

Only English for now.

Development Setup

Important

Make sure you have Java Development Kit 21 installed. It won't work with other versions.

Development using Eclipse

  1. Clone the repository:

    git clone https://github.com/Wurst-Imperium/ChestESP.git
cd ChestESP

  2. Generate the sources:

    In Fabric versions:

    ./gradlew genSources eclipse

    In NeoForge versions:

    ./gradlew eclipse

  3. In Eclipse, go to Import... > Existing Projects into Workspace and select this project.

  4. Optional: Right-click on the project and select Properties > Java Code Style. Then under Clean Up, Code Templates, Formatter, import the respective files in the codestyle folder.

Development using VSCode / Cursor

Tip

You'll probably want to install the Extension Pack for Java to make development easier.

  1. Clone the repository:

    git clone https://github.com/Wurst-Imperium/ChestESP.git
cd ChestESP

  2. Generate the sources:

    In Fabric versions:

    ./gradlew genSources vscode

    In NeoForge versions:

    ./gradlew eclipse

    (That's not a typo. NeoForge doesn't have vscode, but eclipse works fine.)

  3. Open the ChestESP folder in VSCode / Cursor.

  4. Optional: In the VSCode settings, set java.format.settings.url to https://raw.githubusercontent.com/Wurst-Imperium/ChestESP/master/codestyle/formatter.xml and java.format.settings.profile to Wurst-Imperium.

Development using IntelliJ IDEA

I don't use or recommend IntelliJ, but the commands to run would be:

git clone https://github.com/Wurst-Imperium/ChestESP.git
cd ChestESP
./gradlew genSources idea