Curios API Continuation

Important Note

This is an unofficial continuation of CuriosAPI by TheIllusiveC4 for NeoForge (in current state) and Forge (in future). Please do not report issues of this port to TheIllusiveC4, instead use the separate GitHub issues page or Discord invite. The mod description and documentation will be updated soon, so stay tuned!

Overview

Curios is a flexible and expandable accessory/equipment API designed for both users and developers. The main purpose is to provide developers with the ability to add additional accessory and equipment slots in a convenient and compatible manner, while also giving players the ability to customize these slots to their preferences. By default, Curios does not add any content except for an inventory GUI. Initially, there are no slots available, and there are only two items, the latter of which are only accessible through the creative menu and primarily serve as examples for developers when programming their own integration.

Features

• Expandable equipment slots through a central library. New equipment slots can be easily created and managed through an identifier registry. Identical identifiers will be merged to avoid functional duplication and ensure maximum compatibility with potential items, while unique identifiers can still be used to mark special types when appropriate.

• Slots are created only on demand. By default, no slots are included; all slots are created only as needed. This reduces instances where one or more unnecessary slots are present without suitable items to fill them.

• Slots are fully customizable and manageable. Slots can have custom backgrounds, different sizes, and can even be disabled or hidden by default. But how can a player access disabled slots? Through the API, developers can use functions to enable/disable player slots or add/remove a specific number of slots of a given type.

• Flexible item-curio relationships using the vanilla tag system. Potential curios are selected through the vanilla tag system, meaning that categorizing items into curio types is as simple as creating a .json file in the data/curios/tags folder. Items can be categorized into as many curio types as desired as long as they are tagged in the appropriate files, and these settings can even be completely overridden. For more information, see the vanilla tag system.

• Complete integration with other inventory mechanics. Mending and Curses will work with all applicable items equipped in curio slots. There are also various minor features for developers that make it easier to integrate their current items or mechanics into the curio system.

• Accessible from a single GUI. Curios comes with its own GUI accessible from the inventory that displays all available slots to a player. This allows players to see all extended equipment slots in a central location without needing to access different inventory GUIs. However, developers can still provide their own GUIs for their mod-specific slots if desired. The default keybinding for the GUI is 'g'.

Documentation

If you are a developer, add the following to your build.gradle file:

repositories {
    maven {
        name = "OctoStudios"
        url = uri("https://maven.octo-studios.com/releases")
    }
}

dependencies {
    implementation 'top.theillusivec4.curios:curios-neoforge:${version}'
}

Replace ${version} with the version of Curios you want to use.