Registration and Data Generation Utility for NeoForge.
Find a file
2024-09-30 17:20:44 +01:00
.github/workflows update java build version 2024-05-06 17:42:35 +02:00
config Initial hunk of changes. 2024-07-15 21:34:42 +01:00
gradle/wrapper Initial hunk of changes. 2024-07-15 21:34:42 +01:00
src build: Fix missing license headers 2024-09-30 17:19:19 +01:00
.editorconfig Reformat and apply an editorconfig file. 2024-07-15 22:18:15 +01:00
.gitattributes Initialize 1.20.2 2023-12-26 17:56:02 +01:00
.gitignore single data provider 2023-12-28 00:14:04 +01:00
build.gradle.kts Bump version number and NeoForge version 2024-09-30 17:07:34 +01:00
gradle.properties Bump version number and NeoForge version 2024-09-30 17:07:34 +01:00
gradlew Initialize 1.20.2 2023-12-26 17:56:02 +01:00
gradlew.bat Initialize 1.20.2 2023-12-26 17:56:02 +01:00
LICENSE.txt Add license, small readme and test mod changes 2024-05-06 17:40:02 +02:00
README.md docs: Add note that the README is outdated [no ci] 2024-09-30 17:20:44 +01:00
settings.gradle.kts Converted to Kotlin gradle scripts, and Regilite is now a GAMELIBRARY. 2024-03-09 22:15:57 +00:00

Regilite

A lightweight library helping with registration and data generation.

Note this Usage guide is now outdated. It will be updated at some point, but the best way to get started is to look at the code :)

Usage

This library provides helper functions and wrappers around for various Holders and registries. To be able to use Regilite, you firstly create and register a Regilite-object. This object will do the actual registring data to events and doing DataGen.

Below you can find a list of Holder objects Regilite supports. You can see not every Holder has a Regilite alternative, and this is intentional. We've only provided our wrappers when the Holder could benefit from it in our eyes.

RegiliteBlock

Besides the block itself, there are also functions to automatically register the following:

  • Loot tables
  • Blockstates and model
  • Block color (tint)
  • Block Tags
  • Translation
  • Block item
    • See Items

RegiliteItem

Besides the item itself, there are also functions to automatically register the following:

  • Item model
  • Item color (tint)
  • Item Tags
  • Creative tabs
  • Translation
  • Capabilities

RegiliteFluid

Besides the fluid(type) itself, there are also functions to automatically register the following:

  • Flowing fluid
  • Source fluid
  • Fluid tag
  • Translation
  • Liquid block
    • See Block
  • Bucket Item
    • See Item

RegiliteBlockEntity

Besides the block entity(type) itself, it automatically registers the following:

  • Block entity renderer
  • Block entity tags
  • Capabilities

RegiliteEntity

Besides the entity(type) itself, it automatically registers the following:

  • Entity model
  • Entity tags
  • Translation
  • Capabilities (TODO)
  • Model layer (TODO)

RegiliteMenu

Besides the menu(type) itself, it automatically registers the following:

  • Screen factory
  • Translation (TODO)

Translations

We provide automatic translations for holders where the ResourceLocation gives enough context. This can always be changed using the setTranslation method.

For other translations, the Regilite-object provides methods for registering a translation. In case a translation is added multiple times, only the last one will be used.