Box Outlines Api

This is an api for one of my other mod client-tweaks.

It allows the server to summon box outlines from client-tweaks for a tick to those with both mods installed.

Usage

Commands

/boxoutline 0.0 0.0 0.0 1.0 1.0 1.0 red

this draws a box for a single tick from 0 0 0 to 1 1 1. Be aware that box outlines api, unlike client tweaks, uses decimals for the coordinates.

Java Code

first publish this mod’s source code to your local maven

# clone the repo
git clone [email protected]:Spit365/box-outlines-api-1.21.6.git
# publish to maven
cd box-outlines-api-1.21.6
./gradlew publishToMavenLocal

then include Box Outlines Api in your mod

build.gradle:

repositories {
  mavenLocal()
}

dependencies {
  modImplementation("net.spit365:box-outlines-api:1.0.0")
}

fabric.mod.json:

"depends": {
  "client-tweaks": "*"
}

Finally, you can use the following methods in your mod:

import net.spit365.boa.BoxOutline;
import net.minecraft.util.math.Box;
import java.util.Collection;

BoxOutline.add(Box box, int color /* argb */)
BoxOutline.addAll(Collection<Box> box, int color /* argb */)
 

This acts the same way, first specify a box, and then a color in hexadecimal format (0xFFFF0000 -> red, full opacity). Again, this will persist a single tick, so for continuous rendering put it in a tick callback

Building

to build this mod from scratch, first clone both this mod’s and client-tweaks’ repositories. Then, in the directory of client-tweaks run

./gradlew publishToMavenLocal

This will publish it to your local maven. Then run

./gradlew build

in the box outlines api directory

Why this extra step before building? Box Outlines Api needs the source code of client-tweaks available to compile. I did not set up a global maven, hosting client-tweaks, so you need to do it locally.

Other

Install this mod, if you find any of the above features intriguing.

If you dont know how to install mods / the fabric loader / anything else fabric modding related visit this amazing page from the official fabric wiki.

If you have any issues, wishes, etc, go to the source code on github and open up an issue.