SulfurLab API

##SulfurLab API

The SulfurLab API lets you spawn fully configured Sulfur Cubes from your own plugin — no Bukkit boilerplate. It centers on a fluent SulfurCubeBuilder and the ready-made presets in SulfurCubes.

###Installation

Add the JitPack repository and the dependency. Replace the version with the latest published tag.

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.33drygo</groupId>
    <artifactId>SulfurLab</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>

repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    compileOnly("com.github.33drygo:SulfurLab:1.0.0")
}

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    compileOnly 'com.github.33drygo:SulfurLab:1.0.0'
}

Then soft-depend SulfurLab in your plugin.yml:

name: MyPlugin
main: com.example.MyPlugin
version: 1.0
softdepend:   # use depend instead if SulfurLab is required
  - SulfurLab

###Quick start

import dev.drygo.sulfurlab.api.SulfurCubes;
import org.bukkit.Material;
import org.bukkit.entity.SulfurCube;

// A bouncy cube wearing a slime block.
SulfurCube cube = SulfurCubes.bouncy()
        .block(Material.SLIME_BLOCK)
        .spawn(location);

###SulfurCubes

Convenience entry point and physics presets. Everything is static on dev.drygo.sulfurlab.api.SulfurCubes.

SulfurCube cube = SulfurCubes.spawn(location, Material.GOLD_BLOCK);

SulfurCube slider = SulfurCubes.slippery().spawn(location);

###SulfurCubeBuilder

A fluent builder to configure and spawn a cube, on dev.drygo.sulfurlab.api.SulfurCubeBuilder. Create one with SulfurCubeBuilder.create() or SulfurCubes.builder().

Defaults: bounciness 1.0, friction 1.0, airDrag 0.2, block minecraft:sulfur. size and glowing are left at the vanilla default unless set.

SulfurCube cube = SulfurCubeBuilder.create()
        .bounciness(1.0)
        .friction(0.1)
        .block(Material.SLIME_BLOCK)
        .spawn(location);

###How physics maps to Minecraft

Under the hood the builder sets vanilla entity attributes on the Sulfur Cube:

The same valid ranges as the commands apply — see the Getting Started table (bounciness 0.0–1.0, friction 0.0–10.0, air drag 0.0–100.0).

###Notes

• The API does not register cubes with the plugin — they won't appear in /sulfurlab list or persist across restarts. Manage those through the plugin commands instead.
• spawn(...) must run on the main thread, like any Bukkit entity spawn.
• block(Material) ignores non-item materials; block(String) matches via Material.matchMaterial(...).
• apply(...) only touches size / glowing when you've set them, so it's safe for partial reconfiguration.

###References

• SulfurLab GitHub Repository
• SulfurLab on Modrinth