BlockStateLib

Introduction

This is a library for handling block state IDs according to the Minecraft protocol. It is designed to fetch Block State information.

Usage

To use this library, you can download the JAR as a dependency from releases.
Alternatively, use the repository as a dependency from here.

Example

public class TestExample {
    public static void main(String[] args){
        // 1. Initialize BlockStateLib. Requires your server version.
        BlockStateLib.init(Version.V1_21_6); // e.g., 1.21.6

        // Or load JSON from file.
        // BlockStateLib.initFromFile("block_states.json");

        // 2. Build metadata. (Using default block state of "acacia_door")
        // You can find states here: https://minecraft.wiki/w/Block_states
        BlockStateMeta meta = BlockStateMeta.builder()
                .addProperty("facing", "north")
                .addProperty("open", "false")
                .addProperty("half", "lower")
                .addProperty("hinge", "left")
                .addProperty("powered", "false")
                .build();

        // Empty metadata. This returns the default block state ID.
        BlockStateMeta emptyMeta = BlockStateMeta.builder().build();

        // 3. Get block state ID.
        int stateId = BlockStateLib.getStateId("acacia_door", meta);
        System.out.println("ID of 'acacia_door':\nState ID: " + stateId);

        // 4. Use map instead of builder().
        Map<String, String> properties = Map.of(
                "facing", "north",
                "open", "false"
        );
        // Case insensitive.
        int stateId2 = BlockStateLib.getStateId("ACACIA_DOOR", properties);
        System.out.println("Another state ID: " + stateId2);

        int stateId3 = BlockStateLib.getStateId("ACACIA_DOOR", emptyMeta);
        System.out.println("Default state ID: " + stateId3);

        // 5. Get more information.
        var result = BlockStateLib.getInstance().getStateResult("acacia_door", meta);
        System.out.println("Result: " + result);
    }
}

Example output: ↓

ID of 'acacia_door':
State ID: 12984
Another state ID: 12975
Default state ID: 12984
Result: BlockStateResult{stateId=12984, isDefault=true, normalizedBlockName='minecraft:acacia_door', appliedMeta=BlockStateMeta{{hinge=left, facing=north, half=lower, powered=false, open=false}}}