Wisp Forest Docs

https://github.com/wisp-forest/docs
Admin
Wisp Forest is a collection of open-source Minecraft mods and developer tools, including oωo-lib,...
Tokens:35,477
Snippets:484
Trust Score:6.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run local development server

Source: https://github.com/wisp-forest/docs/blob/vitepress/README.md

Start the VitePress development server to preview changes locally.

```sh
$ npm run dev
```

--------------------------------

### Install project dependencies

Source: https://github.com/wisp-forest/docs/blob/vitepress/README.md

Install required packages using npm. The --legacy-peer-deps flag is currently necessary due to dependency constraints.

```sh
$ npm install --legacy-peer-deps
```

--------------------------------

### Basic Forging Recipe

Source: https://github.com/wisp-forest/docs/blob/vitepress/alloy-forgery/adding-recipes-and-fuels.md

A standard recipe example using item tags as input and a fixed item count as output.

```JSON
{
  "type": "alloy_forgery:forging",
  "inputs": [
    {
      "tag": "minecraft:copper_ores"
    }
  ],
  "output": {
    "item": "minecraft:copper_ingot",
    "count": 3
  },
  "overrides": {
    "2": {
      "item": "minecraft:copper_ingot",
      "count": 4
    },
    "3+": {
      "item": "minecraft:copper_ingot",
      "count": 5
    }
  },
  "min_forge_tier": 1,
  "fuel_per_tick": 5
}
```

--------------------------------

### Construct a complex UI layout in XML

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Example demonstrating nested flow layouts, button components, padding, and surface styling.

```xml
<owo-ui xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/wisp-forest/owo-lib/1.20/owo-ui.xsd">
    <components>
        <flow-layout direction="vertical">
            <children> <!--(1)-->
                <flow-layout direction="vertical"> <!--(2)-->
                    <children>
                        <button id="the-button"> <!--(3)-->
                            <text>A Button</text> <!--(6)-->
                        </button>
                    </children>

                    <horizontal-alignment>center</horizontal-alignment>
                    <vertical-alignment>center</vertical-alignment>

                    <!--(4)-->
                    <padding>
                        <all>10</all>
                    </padding>

                    <surface>
                        <panel dark="true"/>
                    </surface>
                </flow-layout>
            </children>

            <vertical-alignment>center</vertical-alignment>
            <horizontal-alignment>center</horizontal-alignment>

            <!--(5)-->
            <surface>
                <vanilla-translucent/>
            </surface>
        </flow-layout>
    </components>
</owo-ui>
```

--------------------------------

### Tagged Output Forging Recipe

Source: https://github.com/wisp-forest/docs/blob/vitepress/alloy-forgery/adding-recipes-and-fuels.md

A recipe example using a priority list for output selection and load conditions.

```JSON
{
  "fabric:load_conditions": [
    {
      "condition": "fabric:item_tags_populated",
      "values": [
        "c:raw_lead_ores",
        "c:lead_ingots"
      ]
    }
  ],
  "type": "alloy_forgery:forging",
  "inputs": [
    {
      "tag": "c:raw_lead_ores",
      "count": 2
    }
  ],
  "output": {
    "priority": [
      "techreborn:lead_ingot",
      "indrev:lead_ingot",
      "modern_industrialization:lead_ingot"
    ],
    "default": "c:lead_ingots",
    "count": 3
  },
  "overrides": {
    "2+": {
      "count": 4
    }
  },
  "min_forge_tier": 1,
  "fuel_per_tick": 5
}
```

--------------------------------

### Custom Starting Index

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/data-extensions/nested-lang.md

Specifying a custom starting index for the array by placing a number inside the curly braces.

```json
{
    "owo:nested_lang": true,
    "item.modid.overlyToolTippedItem.tooltip.{5}": [ // [!code highlight]
        "This is the fifth line of the tooltip",
        "This is the sixth line of the tooltip",
        "This is the seventh line of the tooltip",
        "This is the eighth line of the tooltip",
        "This is the ninth line of the tooltip",
        "This is the tenth line of the tooltip"
    ]
}
```

--------------------------------

### Define an accessory slot via JSON

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/general/slot_types.md

Example configuration for a 'back' slot, defining its display order, size calculation, and icon resource location.

```json
{
  "replace": false,
  "amount": 1,
  "operation": "set",
  "order": 1000,
  "icon": "accessories:gui/slot/back"
}
```

--------------------------------

### Implement UniqueSlotHandling.RegistrationCallback

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/general/slot_types.md

Example implementation of a unique slot registration class, including predicate registration and the required initialization method.

```java
public class UniqueSlotExample implements UniqueSlotHandling.RegistrationCallback  {
	private static final ResourceLocation MAGIC_BALL_PREDICATE = ResourceLocation.fromNamespaceAndPath("example", "magic_ball");
    
    public static final UniqueSlotExample INSTANCE = new UniqueSlotExample();

    private UniqueSlotExample(){
        SlotPredicateRegistry.registerPredicate(slotPredicate1, SlotBasedPredicate.ofItem(item -> item.equals(ExampleItems.MAGIC_BALL)));
    }

    private static SlotTypeReference MAGIC_BALL_REFERENCE;

    @Override
    public void registerSlots(UniqueSlotHandling.UniqueSlotBuilderFactory factory) {
        MAGIC_BALL_REFERENCE = factory.create(ResourceLocation.fromNamespaceAndPath("example", "magic_ball"), 1)
                .slotPredicates(MAGIC_BALL_PREDICATE)
                .validTypes(EntityType.PLAYER)
                .build();
    }

    @Nullable
    public static SlotTypeReference magicBallRef() {
        return MAGIC_BALL_REFERENCE;
    }

	// Call init method within your mods initializer to add the class to the main Unique Slot Handling event
	public static void init() {
		UniqueSlotHandling.EVENT.register(UniqueSlotTest.INSTANCE);
	}
}
```

--------------------------------

### Define structure keys in JSON

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/structures.md

Initial setup for a structure definition file, mapping single-character keys to specific block states.

```json
{
  "keys": {
    "c": "minecraft:chiseled_stone_bricks",
    "s": "minecraft:stone_brick_stairs[facing=north]",
    "u": "minecraft:stone_brick_stairs[facing=south]",
    "e": "minecraft:stone_brick_stairs[facing=east]",
    "t": "minecraft:stone_brick_stairs[facing=west]",
    "l": "minecraft:smooth_stone_slab",
    "b": "minecraft:stone_bricks",
    "w": "minecraft:stone_brick_wall",
    "a": "minecraft:lantern"
  },
  "layers": []
}
```

--------------------------------

### Configure Multiloader Dependencies in Groovy

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Specific dependency configurations for Arch Loom and Vanilla Gradle multiloader setups.

```groovy
dependencies {
    modImplementation("io.wispforest:accessories-common:${project.accessories_version}")
}
```

```groovy
dependencies {
    modImplementation("io.wispforest:accessories-neoforge:${project.accessories_version}")

    // Required due to issues with JIJ dependency resolving in arch or something
    forgeRuntimeLibrary("blue.endless:jankson:1.2.2")

    // For versions greater than or equal to 1.21.4
    forgeRuntimeLibrary("io.wispforest:endec:0.1.9")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.6")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.6")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.5")

    // For versions less than or equal to 1.21.1
    forgeRuntimeLibrary("io.wispforest:endec:0.1.5.1")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.3.1")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.3.1")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.2")
}
```

```groovy
dependencies {
    // Yarn Intermediary 
    compileOnly("io.wispforest:accessories-common:${project.accessories_version}")
    
    // Mojang Mappings
    compileOnly("io.wispforest:accessories-common:${project.accessories_version}-mojmap")
}
```

--------------------------------

### Configure Multiloader Dependencies in Kotlin

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Specific dependency configurations for Arch Loom and Vanilla Gradle multiloader setups using Kotlin DSL.

```kotlin
dependencies {
    modImplementation("io.wispforest:accessories-common:${properties["accessories_version"]}")
}
```

```kotlin
dependencies {
    modImplementation("io.wispforest:accessories-neoforge:${properties["accessories_version"]}")

    // Required due to issues with JIJ dependency resolving in arch or something
    forgeRuntimeLibrary("blue.endless:jankson:1.2.2")

    // For versions greater than or equal to 1.21.4
    forgeRuntimeLibrary("io.wispforest:endec:0.1.9")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.6")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.6")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.5")

    // For versions less than or equal to 1.21.1
    forgeRuntimeLibrary("io.wispforest:endec:0.1.5.1")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.3.1")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.3.1")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.2")
}
```

```kotlin
dependencies {
    // Yarn Intermediary 
    compileOnly("io.wispforest:accessories-common:${properties["accessories_version"]}")
    
    // Mojang Mappings
    compileOnly("io.wispforest:accessories-common:${properties["accessories_version"]}-mojmap")
}
```

--------------------------------

### Define a single structure layer

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/structures.md

Example of defining a single layer of a structure using row-by-row string representation.

```json
{
  "keys": { ... },
  "layers": [
    [
      "bbbbb",
      "bcbcb",
      "bbbbb",
      "bcbcb",
      "bbbbb"
    ]
  ]
}
```

--------------------------------

### Build and preview site

Source: https://github.com/wisp-forest/docs/blob/vitepress/README.md

Compile the documentation for production and verify the build output.

```sh
$ npm run build
$ npm run preview # to verify the build works properly using a local server
```

--------------------------------

### Define a section header in config

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Apply the @SectionHeader annotation to a field to start a new section in the configuration screen.

```java
@Config(name = "my-config", wrapperName = "MyConfig")
public class MyConfigModel {
    public String firstOption = "1";
    ... // many more options

    @SectionHeader("someSection")
    public String someLaterOption = "42";
}
```

--------------------------------

### Initialize the UI Adapter

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Implement the createAdapter method to initialize the UI system using a vertical FlowLayout.

```java
@Override
protected @NotNull OwoUIAdapter<FlowLayout> createAdapter() {
    return OwoUIAdapter.create(this, Containers::verticalFlow);
}
```

--------------------------------

### Configure build.gradle dependencies

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Add the owo-lib annotation processor to your build environment.

```groovy
dependencies {
    annotationProcessor modImplementation("io.wispforest:owo-lib:${project.owo_version}")
}
```

--------------------------------

### Configure a dropdown using Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/dropdown.md

Use the fluent API to define dropdown entries and behavior programmatically.

```java
Components.dropdown(Sizing.content())
    .button(Text.literal("Option 1"), button -> {
        // Handle button click event
    })
    .checkbox(Text.literal("Option 2"), false, ignored -> {})
    .nested(Text.literal("Submenu"), Sizing.content(), submenu -> {
        submenu.button(Text.literal("Submenu Option"), button -> {
            // Handle submenu button click event
        });
    })
    .closeWhenNotHovered(false)
    .padding(Insets.of(5))
    .surface(Surface.TOOLTIP)
```

--------------------------------

### Initialize UI Model with Asset DataSource

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Configures the screen constructor to load the UI model from game assets using an Identifier.

```java
public MyScreen() {
    super(FlowLayout.class, DataSource.asset(new Identifier("mymod", "my_ui_model")));
}
```

--------------------------------

### Build a UI Layout with Containers

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Demonstrates nesting components within a vertical flow container and applying surface styling and alignment.

```java
@Override
protected void build(FlowLayout rootComponent) {
    rootComponent
                .surface(Surface.VANILLA_TRANSLUCENT)
                .horizontalAlignment(HorizontalAlignment.CENTER)
                .verticalAlignment(VerticalAlignment.CENTER);
    
    rootComponent.child(
            Containers.verticalFlow(Sizing.content(), Sizing.content()) // 1
                .child(Components.button(Text.literal("A Button"), button -> { System.out.println("click"); }))
                .padding(Insets.of(10)) // 2
                .surface(Surface.DARK_PANEL)
                .verticalAlignment(VerticalAlignment.CENTER)
                .horizontalAlignment(HorizontalAlignment.CENTER)
    );
}
```

--------------------------------

### Define a minimal book

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/getting-started.md

Create a basic book definition file to register a new book with Lavender.

```json
{}
```

--------------------------------

### Create an OwoNetChannel

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/networking.md

Initialize a new networking channel using a unique identifier.

```java
...
// as long as you use your mod's id here, the path doesn't actually
// matter - it really could be anything
public static final OwoNetChannel MY_CHANNEL = OwoNetChannel.create(new Identifier("my_mod", "main"));
...
```

--------------------------------

### Declare Dependencies and Version

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/setup.md

Add the Lavender dependency to build.gradle and define the version in gradle.properties.

```groovy
dependencies {
    modImplementation "io.wispforest:lavender:${project.lavender_version}"
    include "io.wispforest:owo-sentinel:${project.owo_version}" // check owo's page for this version
}
```

```properties
# https://maven.wispforest.io/io/wispforest/lavender/
lavender_version=...
```

--------------------------------

### Send Packets via OwoNetChannel

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/networking.md

Use serverHandle or clientHandle to obtain a handle for sending packets. Handles should not be stored as they are reused and rebound.

```java
// to send to a certain player
var player = <some server player>;
MyModInitializer.MY_CHANNEL.serverHandle(player).send(new MyPacket(1, "this", new Identifier("is", "podge")));

// to send to all players watching a block entity
var blockEntity = <some block entity>;
MyModInitializer.MY_CHANNEL.serverHandle(blockEntity).send(new MyPacket(1, "this", new Identifier("is", "podge")));
```

```java
MyModInitializer.MY_CHANNEL.clientHandle().send(new MyPacket(1, "this", new Identifier("is", "podge")));
```

--------------------------------

### Access and configure UI components in Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Retrieve a component by ID from the root layout and assign an event listener.

```java
@Override
protected void build(FlowLayout rootComponent) {
    rootComponent.childById(ButtonComponent.class, "the-button").onPress(button -> {
        System.out.println("click");
    });
}
```

--------------------------------

### Standard JSON Language File

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/data-extensions/nested-lang.md

A standard language file requiring explicit keys for every tooltip line.

```json
{
    "item.modid.overlyToolTippedItem": "Overly Tool Tipped Item",
    "item.modid.overlyToolTippedItem.tooltip.1": "This is the first line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.2": "This is the second line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.3": "This is the third line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.4": "This is the fourth line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.5": "This is the fifth line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.6": "This is the sixth line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.7": "This is the seventh line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.8": "This is the eighth line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.9": "This is the ninth line of the tooltip",
    "item.modid.overlyToolTippedItem.tooltip.10": "This is the tenth line of the tooltip"
}
```

--------------------------------

### Expand and configure a template in Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/templates.md

Use the expandTemplate method within the screen's init method to add template components to the UI and configure them.

```java
public class Example extends BaseUIModelScreen<FlowLayout> {
    public Example() {
        super(FlowLayout.class, new Identifier("your-namespace-here", "your-ui-file-path-here"));
    }

    @Override
    protected void build(FlowLayout rootComponent) {
        // Your regular code
    }

    @Override
    protected void init() {
        super.init();

        if (this.uiAdapter == null) return;

        this.uiAdapter.rootComponent.child(
            this.model.expandTemplate(
                FlowLayout.class,
                "my-template@examples:example_ui",
                Map.of()
            ).childById(ButtonComponent.class, "the-click-me-button")
            .configure(component -> {
                System.out.println("Button clicked!");
            })
        );
    }
}
```

--------------------------------

### Create a basic OwoItemGroup

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/item-groups.md

Use the builder pattern to define an item group with a unique identifier and an icon.

```java
public static final OwoItemGroup GROUP = OwoItemGroup
    .builder(new Identifier("mod-id", "item_group"), () -> Icon.of(Mod.ITEM))
    // additional builder configuration goes between these lines
    .build();
```

--------------------------------

### Configure a dropdown using XML

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/dropdown.md

Define the dropdown structure and properties declaratively using XML tags.

```xml
<dropdown>
    <close-when-not-hovered>false</close-when-not-hovered>
    <entries>
        <button>
            <text>Option 1</text>
        </button>
        <checkbox>
            <text>Option 2</text>
            <checked>false</checked>
        </checkbox>
        <nested name="Submenu" translate="false">
            <button>
                <text>Submenu Option</text>
            </button>
        </nested>
    </entries>
    <padding>
        <all>5</all>
    </padding>
    <surface>
        <tooltip/>
    </surface>
</dropdown>
```

--------------------------------

### Manual Registry Initialization

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/registration.md

Standard approach for registering items by manually calling Registry.register in an init method.

```java
public class ItemInit {

    public static final Item BLACKBERRY = new Item(...);
    public static final Item BANANA = new Item(...);
    ...

    public static void init() {
        Registry.register(Registry.ITEM, Mod.id("blackberry"), BLACKBERRY);
        Registry.register(Registry.ITEM, Mod.id("banana"), BANANA);
        ...
    }

}
```

--------------------------------

### Load config in mod initializer

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Initialize and load the generated config class in your mod's entry point.

```java
public class MyModInitializer implements ModInitializer {
    ...
    public static final MyConfig CONFIG = MyConfig.createAndLoad();
    ...
}
```

--------------------------------

### Configure Maven Repositories in Kotlin

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Add these repositories to your build.gradle.kts file to resolve Accessories dependencies.

```kotlin
    maven("https://maven.wispforest.io/releases")
    maven("https://maven.su5ed.dev/releases")
    maven("https://maven.fabricmc.net")
```

--------------------------------

### Batch Render Namespaces

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Renders all items or blocks belonging to a specific namespace.

```mcfunction
# render an atlas of every single item in minecraft
/isorender namespace minecraft atlas

# render each block in minecraft individually
/isorender namespace minecraft batch blocks
```

--------------------------------

### Configure Maven Repositories in Groovy

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Add these repositories to your build.gradle file to resolve Accessories dependencies.

```groovy
    maven { url 'https://maven.wispforest.io/releases' }
    maven { url 'https://maven.su5ed.dev/releases' }
    maven { url 'https://maven.fabricmc.net' }
```

--------------------------------

### Add Accessories Dependencies in Kotlin

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Define the project dependencies for Fabric and Neoforge platforms using Kotlin DSL.

```kotlin
dependencies {
    modImplementation("io.wispforest:accessories-fabric:${properties["accessories_version"]}")
}
```

```kotlin
dependencies {
    implementation("io.wispforest:accessories-neoforge:${properties["accessories_version"]}")
}
```

--------------------------------

### Complete structure definition

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/structures.md

Full structure definition including multiple layers. Use spaces for 'anything goes' and underscores for empty air.

```json
{
  "keys": {
    "c": "minecraft:chiseled_stone_bricks",
    "s": "minecraft:stone_brick_stairs[facing=north]",
    "u": "minecraft:stone_brick_stairs[facing=south]",
    "e": "minecraft:stone_brick_stairs[facing=east]",
    "t": "minecraft:stone_brick_stairs[facing=west]",
    "l": "minecraft:smooth_stone_slab",
    "b": "minecraft:stone_bricks",
    "w": "minecraft:stone_brick_wall",
    "a": "minecraft:lantern"
  },
  "layers": [
    [
      "bbbbb",
      "bcbcb",
      "bbbbb",
      "bcbcb",
      "bbbbb"
    ],
    [
      "culuc",
      "e   t",
      "l b l",
      "e   t",
      "cslsc"
    ],
    [
      "w   w",
      "     ",
      "  c  ",
      "     ",
      "w   w"
    ],
    [
      "a   a",
      "     ",
      "  b  ",
      "     ",
      "a   a"
    ]
  ]
}
```

--------------------------------

### Define a config model class

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Create a class annotated with @Config to define the structure of your configuration.

```java
@Config(name = "my-config", wrapperName = "MyConfig")
public class MyConfigModel {
    ...
}
```

--------------------------------

### Define a Code-Driven Screen Class

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Create a class extending BaseOwoScreen with a FlowLayout root component to begin the code-driven UI implementation.

```java
public class MyFirstScreen extends BaseOwoScreen<FlowLayout> {

    @Override
    protected @NotNull OwoUIAdapter<FlowLayout> createAdapter() {
        // TODO
    }

    @Override
    protected void build(FlowLayout rootComponent) {
        // TODO
    }
}
```

--------------------------------

### Insert oωo-ui templates

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/markdown-syntax.md

Use these tags to insert UI models into markdown. Escape commas in parameters with a backslash.

```text
<|template-name@ui-model-id|>
```

```text
<|template-name@ui-model-id|param1=value1,param2=value2|>
```

--------------------------------

### Create a Grid Layout in Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/grid-layout.md

Use the Containers.grid method to programmatically define a grid layout with specific sizing and child components.

```java
Containers.grid(Sizing.content(), Sizing.content(), 2, 2)
    .child(Components.label(Text.literal("Cell 1")), 0, 0)
    .child(Components.label(Text.literal("Cell 2")), 0, 1)
    .child(Components.label(Text.literal("Cell 3")), 1, 0)
    .child(Components.label(Text.literal("Cell 4")), 1, 1)
    .padding(Insets.of(10))
    .surface(Surface.PANEL)
    .horizontalAlignment(HorizontalAlignment.CENTER)
    .verticalAlignment(VerticalAlignment.CENTER)
```

--------------------------------

### Add Accessories Dependencies in Groovy

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/developer/dev_setup.md

Define the project dependencies for Fabric and Neoforge platforms.

```groovy
dependencies {
    modImplementation("io.wispforest:accessories-fabric:${project.accessories_version}")
}
```

```groovy
dependencies {
    implementation("io.wispforest:accessories-neoforge:${project.accessories_version}")
}
```

--------------------------------

### Create a button with Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/button.md

Use the Components.button method to define a button with a text label and a click event handler.

```java
Components.button(Text.literal("Click me!"), button -> {
    // Handle button click event
})
```

--------------------------------

### Nested Language File Structure

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/data-extensions/nested-lang.md

Using the {} placeholder to nest common key prefixes.

```json
{
    "owo:nested_lang": true,
    "item.modid.{}": { // [!code highlight]
        "firstItem": "First Item",
        "secondItem": "Second Item",
        "thirdItem": "Third Item",
        "fourthItem": "Fourth Item",
        "fifthItem": "Fifth Item",
        "sixthItem": "Sixth Item",
        "seventhItem": "Seventh Item",
        "eighthItem": "Eighth Item",
        "ninthItem": "Ninth Item",
        "tenthItem": "Tenth Item"
    }
}
```

--------------------------------

### Create a Label using Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/label.md

Use the Components.label method to programmatically define a label with text, color, shadow, and alignment settings.

```java
Components.label(Text.literal("Hello, World!"))
    .color(Color.ofRgb(0xffffff))
    .shadow(true)
    .horizontalTextAlignment(HorizontalAlignment.CENTER)
    .verticalTextAlignment(VerticalAlignment.CENTER)
```

--------------------------------

### Define a Label using XML

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/label.md

Use the <label> XML tag to define label properties in a data-driven configuration.

```xml
<label>
    <text>Hello, World!</text>
    <color>#ffffff</color>
    <shadow>true</shadow>
    <horizontal-text-alignment>center</horizontal-text-alignment>
    <vertical-text-alignment>center</vertical-text-alignment>
</label>
```

--------------------------------

### Insert manual page breaks

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/markdown-syntax.md

Use the ;;;;; sequence to force a page break. Ensure two blank lines are included above and below the syntax.

```markdown
...page 1 content here...

;;;;;

...page 2 content here...
```

--------------------------------

### Create unordered lists

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/markdown-syntax.md

Use dashes for unordered list items, supporting nested structures.

```markdown
- an element
- another one
    - and a nested one
        - deeper
- and back to base
```

--------------------------------

### Components.dropdown()

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/dropdown.md

The Java API for programmatically constructing a dropdown menu.

```APIDOC
## Components.dropdown(Sizing sizing)

### Description
Creates a new dropdown component instance with the specified sizing.

### Parameters
- **sizing** (Sizing) - Required - The sizing constraints for the dropdown.

### Methods
- **button(Text text, Consumer<Button> action)**: Adds a button entry.
- **checkbox(Text text, boolean checked, Consumer<Checkbox> action)**: Adds a checkbox entry.
- **nested(Text text, Sizing sizing, Consumer<Dropdown> submenu)**: Adds a nested dropdown menu.
- **closeWhenNotHovered(boolean value)**: Sets whether the dropdown closes when not hovered.
- **padding(Insets insets)**: Sets the padding around entries.
- **surface(Surface surface)**: Sets the background surface of the dropdown.
```

--------------------------------

### Global Recipe Remainders

Source: https://github.com/wisp-forest/docs/blob/vitepress/alloy-forgery/adding-recipes-and-fuels.md

Configuration for global recipe remainders, allowing input items to be replaced by specific outputs upon recipe completion.

```JSON
{
  "remainders": {
    // Count is supported
    "minecraft:iron_ore": {
      "item": "minecraft:cobblestone",
      "count": 4
    },

    // Turn copper in input to sand
    "minecraft:copper_ore": "minecraft:sand",
  }
}
```

--------------------------------

### /isorender tooltip

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Renders the tooltip for a specific item or the player's current item.

```APIDOC
## /isorender tooltip

### Description
Renders the tooltip of the specified item. If no item is provided, it renders the tooltip of the player's current item.

### Parameters
- **item** (string) - Optional - The resource location of the item.
- **nbt** (string) - Optional - NBT data for the item.
```

--------------------------------

### Define a Template with Placeholders

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/templates.md

Use double curly braces within XML components to define placeholders for later replacement.

```xml
<owo-ui xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/wisp-forest/owo-lib/1.20/owo-ui.xsd">
    <components>
        <!-- Your main UI components go here -->
    </components>
    <templates>
        <template name="my-template">
            <flow-layout direction="vertical">
                <children>
                    <label>
                        <text>{{custom-text}}</text>
                    </label>
                    <button id="the-click-me-button">
                        <text>Click me!</text>
                    </button>
                </children>
            </flow-layout>
        </template>
    </templates>
</owo-ui>
```

--------------------------------

### Define a button with XML

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/button.md

Configure button properties such as text and active state using XML tags.

```xml
<button>
    <text>Click me!</text>
    <active>true</active>
</button>
```

--------------------------------

### Components.button(text, callback)

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/button.md

Creates a button component using the Java API with a specified text label and a click event handler.

```APIDOC
## Components.button(text, callback)

### Description
Creates a new button component with the provided text and a callback function to handle click events.

### Signature
`Components.button(Text text, Consumer<Button> callback)`

### Parameters
- **text** (Text) - Required - The text to display on the button.
- **callback** (Consumer<Button>) - Required - The function to execute when the button is clicked.

### Example
```java
Components.button(Text.literal("Click me!"), button -> {
    // Handle button click event
})
```
```

--------------------------------

### Add Components to the Layout

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Configure alignment and add interactive components like buttons to the root layout.

```java
@Override
protected void build(FlowLayout rootComponent) {
    rootComponent
                .surface(Surface.VANILLA_TRANSLUCENT)
                .horizontalAlignment(HorizontalAlignment.CENTER)
                .verticalAlignment(VerticalAlignment.CENTER);

    rootComponent.child(
        Components.button(
                Text.literal("A Button"),
                button -> { System.out.println("click"); }
            )
    );
}
```

--------------------------------

### Apply a Surface to the Root Component

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Set a background surface for the root component to provide visual structure to the screen.

```java
@Override
protected void build(FlowLayout rootComponent) {
    rootComponent.surface(Surface.VANILLA_TRANSLUCENT);
}
```

--------------------------------

### Nested Language with Prefix and Suffix

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/data-extensions/nested-lang.md

Using the {} placeholder to wrap both a prefix and a suffix.

```json
{
    "owo:nested_lang": true,
    "item.modid.{}Item": { // [!code highlight]
        "first": "First Item",
        "second": "Second Item",
        "third": "Third Item",
        "fourth": "Fourth Item",
        "fifth": "Fifth Item",
        "sixth": "Sixth Item",
        "seventh": "Seventh Item",
        "eighth": "Eighth Item",
        "ninth": "Ninth Item",
        "tenth": "Tenth Item"
    }
}
```

--------------------------------

### Configure Maven Repository

Source: https://github.com/wisp-forest/docs/blob/vitepress/lavender/setup.md

Add the Wisp Forest Maven repository to the repositories block in build.gradle.

```groovy
repositories {
    maven { url 'https://maven.wispforest.io' }
}
```

--------------------------------

### Implement a checkbox using Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/checkbox.md

Use the Components.checkbox method to programmatically create a checkbox instance.

```java
Components.checkbox(Text.literal("Option"))
    .checked(false)
```

--------------------------------

### Initialize Slider via Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/slider.md

Use the Components.slider method to programmatically create a slider with specific sizing and state.

```java
Components.slider(Sizing.fill(50))
    .message(s -> Text.literal("Volume"))
    .active(true)
```

--------------------------------

### Define an owo-ui XML model

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Initial XML structure for an owo-ui model, including the schema location for IDE autocomplete.

```xml
<owo-ui xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/wisp-forest/owo-lib/1.20/owo-ui.xsd">
    <components>

    </components>
</owo-ui>
```

--------------------------------

### Register with ModMenu

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Apply the @Modmenu annotation to your config model to enable integration.

```java
@Modmenu(modId = "mymodid")
@Config(name = "my-config", wrapperName = "MyConfig")
public class MyConfigModel {
    ...
}
```

--------------------------------

### Configuring Global Slot Amounts

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/general/adjusting_slot_amount.md

Defines global slot modifiers in the accessories configuration file using the modifiers array.

```json
{
	//...
	"modifiers": [ // Array of json objects comprising the below structure
		{
			"slotType": "test", // Targeted Slot Name
			"amount": 23 // The Amount to shoot for as the base
		}
	]
}
```

--------------------------------

### Expand Template with Values

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/templates.md

Pass a map of key-value pairs to the expandTemplate method to replace placeholders during component initialization.

```java
@Override
protected void init() {
    super.init();

    if (this.uiAdapter == null) return;

    this.uiAdapter.rootComponent.child(
        this.model.expandTemplate(
            FlowLayout.class,
            "my-template@examples:example_ui",
            Map.of("custom-text", "Hello, World!")
        )
    );
}
```

--------------------------------

### Render Tooltips with /isorender tooltip

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Renders the tooltip of a specific item or the player's held item.

```mcfunction
# render the tooltip of your current item
/isorender tooltip 

# render the tooltip of a netherite pickaxe enchanted with efficiency 5
/isorender tooltip minecraft:netherite_pickaxe{Enchantments:[{id:"efficiency",lvl:5}]}
```

--------------------------------

### Add options to config model

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Define configuration fields and enums within your model class.

```java
@Config(name = "my-config", wrapperName = "MyConfig")
public class MyConfigModel {
    public int anIntOption = 16;
    public boolean aBooleanToggle = false;

    public Choices anEnumOption = Choices.ANOTHER_CHOICE;

    public enum Choices {
        A_CHOICE, ANOTHER_CHOICE;
    }
}
```

--------------------------------

### Define a Data-Driven Screen

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/getting-started.md

Initial structure for a screen class extending BaseUIModelScreen, requiring a root component type.

```java
public class MyScreen extends BaseUIModelScreen<FlowLayout> {

    public MyScreen() {
        super(FlowLayout.class, /* TODO */);
    }

    @Override
    protected void build(FlowLayout rootComponent) {
        // TODO
    }
}
```

--------------------------------

### Define a Slot Group JSON

Source: https://github.com/wisp-forest/docs/blob/vitepress/accessories/general/slot_groups.md

Create a JSON file in the data/{namespace}/accessories/group/ directory to define a new slot group.

```json
{
  "replace": false,
  "order": 120,
  "slots": [
    "charm"
  ],
  "icon": "accessories:gui/group/any"
}
```

--------------------------------

### Create a vertical flow layout in Java

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/flow-layout.md

Constructs a vertical flow layout with specified sizing, child components, and styling properties.

```java
Containers.verticalFlow(Sizing.fill(100), Sizing.content())
    .child(Components.label(Text.literal("Item 1")))
    .child(Components.label(Text.literal("Item 2")))
    .gap(10)
    .padding(Insets.of(20))
    .surface(Surface.PANEL)
    .horizontalAlignment(HorizontalAlignment.CENTER)
    .verticalAlignment(VerticalAlignment.CENTER)
```

--------------------------------

### Standard Language File Structure

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/data-extensions/nested-lang.md

A typical language file without nesting, containing repetitive key prefixes.

```json
{
    "item.modid.firstItem": "First Item",
    "item.modid.secondItem": "Second Item",
    "item.modid.thirdItem": "Third Item",
    "item.modid.fourthItem": "Fourth Item",
    "item.modid.fifthItem": "Fifth Item",
    "item.modid.sixthItem": "Sixth Item",
    "item.modid.seventhItem": "Seventh Item",
    "item.modid.eighthItem": "Eighth Item",
    "item.modid.ninthItem": "Ninth Item",
    "item.modid.tenthItem": "Tenth Item"
}
```

--------------------------------

### /isorender entity

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Renders a specific entity or the entity the player is looking at.

```APIDOC
## /isorender entity

### Description
Renders the specified entity. If no entity is provided, it renders the entity the player is currently looking at.

### Parameters
- **entity** (string) - Optional - The resource location of the entity.
- **nbt** (string) - Optional - NBT data for the entity.
```

--------------------------------

### Declare oωo Dependencies

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/setup.md

Specify the oωo library dependencies for different project environments and define the version in gradle.properties.

```groovy
dependencies {
    modImplementation "io.wispforest:owo-lib:${project.owo_version}"
    include "io.wispforest:owo-sentinel:${project.owo_version}"
}
```

```groovy
dependencies {
    // Moddev Projects - Neoforge
    implementation "io.wispforest:owo-lib-neoforge:${project.owo_version}"
    accessTransformer "io.wispforest:owo-lib-neoforge:${project.owo_version}"
    interfaceInjectionData "io.wispforest:owo-lib-neoforge:${project.owo_version}"

    // Arch Loom Projects - Neoforge
    modImplementation "io.wispforest:owo-lib-neoforge:${project.owo_version}"

    // Required due to issues with Arch Loom and JIJ within neo. May require bumping the version every once and awhile.
    forgeRuntimeLibrary("blue.endless:jankson:1.2.2")

    // For versions greater than or equal to 1.21.4
    forgeRuntimeLibrary("io.wispforest:endec:0.1.9")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.5")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.6")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.6")

    // For versions less than or equal to 1.21.1
    forgeRuntimeLibrary("io.wispforest:endec:0.1.5.1")
    forgeRuntimeLibrary("io.wispforest.endec:netty:0.1.2")
    forgeRuntimeLibrary("io.wispforest.endec:gson:0.1.3.1")
    forgeRuntimeLibrary("io.wispforest.endec:jankson:0.1.3.1")
}
```

```groovy
dependencies {
    // Moddev Projects - Neoforge
    compileOnly "io.wispforest:owo-lib-neoforge:${project.owo_version}"
    accessTransformer "io.wispforest:owo-lib-neoforge:${project.owo_version}"
    interfaceInjectionData "io.wispforest:owo-lib-neoforge:${project.owo_version}"

    // Arch Loom Projects - Neoforge
    // Don't worry about loading issues as it will only be present to get the arch interface injection and Access Widener 
    modImplementation "io.wispforest:owo-lib-fabric:${project.owo_version}" 
}
```

```properties
# https://maven.wispforest.io/io/wispforest/owo-lib/
owo_version=...
```

--------------------------------

### /isorender item

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Renders a specific item or the player's current item, including NBT data.

```APIDOC
## /isorender item

### Description
Renders the specified item. If no item is provided, it renders the item currently held by the player.

### Parameters
- **item** (string) - Optional - The resource location of the item (e.g., minecraft:diamond).
- **nbt** (string) - Optional - NBT data for the item.
```

--------------------------------

### Custom AutoRegistryContainer Implementation

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/registration.md

Creating a custom container for registries that do not have pre-defined implementations by extending AutoRegistryContainer.

```java
public class BlockEntityInit implements AutoRegistryContainer<BlockEntityType<?>> {
    
    public static final BlockEntityType<ModBlockEntity> MOD_BLOCK_ENTITY = FabricBlockEntityTypeBuilder.create(...).build();
    
    @Override
    public Registry<BlockEntityType<?>> getRegistry() {
        return Registry.BLOCK_ENTITY_TYPE;
    }

    @Override
    @SuppressWarnings("unchecked")
    public Class<BlockEntityType<?>> getTargetFieldType() {
        return (Class<BlockEntityType<?>>) (Object) BlockEntityType.class;
    }
}
```

--------------------------------

### <dropdown>

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/ui/components/dropdown.md

The XML schema for defining a dropdown component in UI layouts.

```APIDOC
## <dropdown>

### Description
XML element to define a dropdown menu structure.

### Supported Elements
- **close-when-not-hovered** (boolean): Configures auto-close behavior.
- **entries**: Container for menu items.
  - **button**: Defines a button entry.
  - **checkbox**: Defines a checkbox entry.
  - **nested**: Defines a sub-menu.
- **padding**: Defines padding using <all> or specific sides.
- **surface**: Defines the background surface (e.g., <tooltip/>).
```

--------------------------------

### Configure Eclipse IDE source sets

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/config/getting-started.md

Required configuration for Eclipse users to recognize generated config classes.

```groovy
sourceSets.main.java.srcDirs += [ 'src/main/generatedJava' ]
compileJava.options.generatedSourceOutputDirectory = file("${projectDir}/src/main/generatedJava/<your config class package>")
```

--------------------------------

### Batch Render Operations

Source: https://github.com/wisp-forest/docs/blob/vitepress/isometric-renders/slash_isorender.md

Commands to render sets of items using creative tabs, tags, or namespaces.

```APIDOC
## Batch Render Operations

### Description
Batch commands select a set of items and perform a render task: 'atlas', 'batch items', or 'batch blocks'.

### Commands
- **/isorender creative_tab <tab> <task>**
- **/isorender tag <tag> <task>**
- **/isorender namespace <namespace> <task>**
```

--------------------------------

### Implement annotation-based block item registration

Source: https://github.com/wisp-forest/docs/blob/vitepress/owo/registration.md

Override postProcessField to check for annotations on fields and conditionally apply Item.Settings.

```java
public class BlockInit implements BlockRegistryContainer {

    public static final Block CLEAR_GLASS = new Block(...);

    @NoItemGroup
    public static final Block DEBUG_BLOCK = new Block(...);

    @Override
    public void postProcessField(String namespace, Block value, String identifier, Field field) {
        // preserve normal traversal behaviour
        if (field.isAnnotationPresent(NoBlockItem.class)) return;

        // create basic item settings
        var settings = new Item.Settings();

        // check if our annotation is present and only 
        // assign the itemgroup if it is not
        if (!field.isAnnotationPresent(NoItemGroup.class)){
            settings.group(Mod.MOD_GROUP)
        }

        // finally, create and register the block item
        Registry.register(Registry.ITEM, new Identifier(namespace, identifier), new BlockItem(value, settings)));
    }
}
```
Tokens:
Raw