irtimaled / BoundingBoxOutlineReloaded

MIT License
162 stars 66 forks source link

BoundingBoxOutlineReloaded

BoundingBoxOutlineReloaded is a mod for Minecraft Vanilla, Forge, LiteLoader, Rift, and Fabric

What it does

This mod highlights in a variety of colours and styles the different structures & features of the game:-

(*) Prior to 1.14.4, due to how Minecraft generates these structures they will initially float above where they should be, however upon re-loading the world they should drop down to the correct height. Unfortunately (or fortunately?) buried treasure will always appear at y-90. This works as expected in 1.14.4. (+) In 1.14 and above the concept of a village based on doors being involved in iron golem spawning has gone away, so this feature goes away too.

Why did I make it?

I loved 4poc's BBOutline mod but the only version I could get to work consistently was for Minecraft 1.6.4. This is fine if you want Nether Fortress bounding boxes but if you need witch huts the new block types can cause Minecraft 1.6.4 to crash horribly; and don't get me started on item frames crashing Minecraft 1.6.4!

In addition to this not working with newer worlds, the way it bounds villages lacks the finesse of KaboPC's VillageMarker mod, and any new structures introduced in Minecraft are missing entirely.

How it works

As chunks are loaded the game provides metadata about all the different structures & features in those chunks. The mod interprets this meta data, caches the results, and renders the bounding boxes to the screen. In an SMP environment this data is not present on the clients so the mod needs to run on the server where the processing happens and then the relevant metadata is sent to the clients for them to render.

Installing (Forge/LiteLoader/Rift/Fabric)

Make sure you have the relevant mod loader installed then drop the mod file into the appropriate mods folder. This approach can be used for client and server deployments where needed.

Installing (Vanilla)

Double-click the jar file and a client profile for the relevant version of Minecraft will be created/updated in the launcher.

Running a server (Vanilla)

To start a vanilla server with the mod loaded, copy the relevant jar file to a folder, and run:-

java -jar BBOutlineReloaded-{version}.jar --server

Running this will download the necessary pre-requisities and start the server.

Configuring

The keyboard shortcuts can be configured in the standard Controls screen.

Most of the options are available for configuration on the client through a configuration Gui. On Vanilla, Rift & Fabric there is a BBOR button on the options screen, alternatively press and hold B key when in game.

In the table below are a couple of old config options that can only be edited by opening the config/BBOutlineReloaded.cfg file with a text editor. The Minecraft Client will need to be restarted for the settings changed this way to take effect.

Option Description Cfg File Key Cfg File Values Default
Always Visible Bounding boxes are visible through blocks - kinda messes with perspective tho! alwaysVisible true/false false
Keep Cache Between Sessions Bounding box caches are not cleared when disconnecting from single or multiplayer worlds. keepCacheBetweenSessions true/false false

Using

Bounding boxes when connected to servers

There are a couple of options when you want bounding boxes to show whilst accessing servers:-

Links