TFC Registry API

Quick rating

Community listing page, reviews here may not be monitored by the author.

TFC Registry API

By VerphOwner

No reviews yet

Dynamically discovers and unifies access to all mod-added TFC registry types (metals, woods, ores, rocks, soils, sands, soil variants) from any mod using the registry interfaces.

API/Library
Mod Loaders
NeoForge
Minecraft

Community voices

Reviews

List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Show per page
10
25
50
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Where It Runs
Client and Server

Must be installed on both the client and the server.

About

Project Details

Type
Mod
License
BSD 2-Clause "Simplified" License
Latest Version
TFCRegistryAPI-1.21.x-1.2

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

CurseForge ID
Modrinth ID

Resources

External Links

Source Issues Wiki Discord

About

Description

TFC Registry API

A lightweight library mod that automatically discovers and unifies all TerraFirmaCraft registry types added by any mod. It works with any addon, as long as they correctly implement this library's registry interfaces or TFC's own:

  • RegistryMetal
  • RegistryRock
  • RegistrySoilVariant
  • RegistryWood

Where these are provided by this library:

  • RegistryOre
  • RegistrySand
  • RegistrySoil

How discovery works

The mod automatically finds all types if:

  • The type implements the correct Registry[Type] interface
  • The type is an enum (required for auto-discovery)

If an addon does not use enums or needs manual registration, it can still be supported by the addon developer by calling the helper registration methods directly:

Example: manually register soil variants from a non-enum source

SoilVariantRegistryHelper.registerTypes(
    YourSoilVariantClass.class,
    List.of(yourVariant1, yourVariant2, ...),
    "yourmodid"
);

Same method exists in every helper class:

MetalRegistryHelper.registerTypes(...)
WoodRegistryHelper.registerTypes(...)
RockRegistryHelper.registerTypes(...)
OreRegistryHelper.registerTypes(...)
SoilRegistryHelper.registerTypes(...)
SandRegistryHelper.registerTypes(...)
SoilVariantRegistryHelper.registerTypes(...)

Code examples:

// Metals
List<RegistryMetal> allMetals = MetalRegistryHelper.getAllMetalValues();
RegistryMetal brass = MetalRegistryHelper.getMetalValueOrDefault("brass");

// Woods
List<RegistryWood> allWoods = WoodRegistryHelper.getAllWoodValues();
RegistryWood ebony = WoodRegistryHelper.getWoodValueOrDefault("ebony");

// Rocks
List<RegistryRock> allRocks = RockRegistryHelper.getAllRockValues();
RegistryRock marble = RockRegistryHelper.getRockValueOrDefault("marble");

// Ores
List<RegistryOre> allOres = OreRegistryHelper.getAllOreValues();
RegistryOre sphalerite = OreRegistryHelper.getOreValueOrDefault("sphalerite");

// Soils
List<RegistrySoil> allSoils = SoilRegistryHelper.getAllSoilValues();
RegistrySoil duff = SoilRegistryHelper.getSoilValueOrDefault("duff");

// Sand colors
List<RegistrySand> allSands = SandRegistryHelper.getAllSandValues();
RegistrySand white = SandRegistryHelper.getSandValueOrDefault("white");

// Soil variants
List<RegistrySoilVariant> allVariants = SoilVariantRegistryHelper.getAllSoilVariantValues();
RegistrySoilVariant inceptisol = SoilVariantRegistryHelper.getSoilVariantValueOrDefault("inceptisol");

All get[Type]ValueOrDefault("name") methods are case-insensitive and return a safe fallback if not found.

For example, iterating over the List<RegistryWood> list, can yield a list of wood types like this, where this shows a scenario with ArborFirmaCraft installed:

acacia, ash, aspen, birch, blackwood, chestnut, douglas_fir, hickory, kapok, mangrove, maple, oak, palm, pine, rosewood, sequoia, spruce, sycamore, white_cedar, willow, araucaria, baobab, beech, cypress, eucalyptus, fig, ginkgo, hevea, ipe, ironwood, mahoe, mahogany, teak, tualang

You can easily register new blocks using the lists/getters provided by the helpers. Here is shown an example of how to add a new SoilBlock for all registered soil types and soil variants:

public static final Map<RegistrySoil, Map<RegistrySoilVariant, Id<Block>>> NEW_SOIL_BLOCKS =
    SoilRegistryHelper.getAllSoilValues().stream()
        .collect(Collectors.toMap(
            type -> type,
            type -> SoilVariantRegistryHelper.getAllSoilVariantValues().stream()
                .collect(Collectors.toMap(
                    variant -> variant,
                    variant -> register(type.toString() + "/" + variant.toString(),
                        () -> new SoilBlock(Block.Properties.of().mapColor(MapColor.DIRT).strength(1.4f), type, variant))
                ))
        ));

For example: if a block/item/entity/whatever constructor insists on using e.g. SoilBlockType, such as ConnectedGrassBlock, you can safely cast your soil from the RegistrySoil interface to it like this (RegistrySoil)(Object)soil (or however else you prefer to do it), since I've made TFC's SoilBlockTypeenum class implement the custom RegistrySoil interface.

Ideal for addons, modpack makers, or any setting that needs to work with every TFC-compatible metal, wood, rock, ore, soil, sand, or variant regardless of which mods are installed.

For example, you can use the registry type lists created by this library, to easily create new blocks, items, entities etc. for all of or the desired entries of the specific type.

TFC Registry API

A lightweight library mod that automatically discovers and unifies all TerraFirmaCraft registry types added by any mod. It works with any addon, as long as they correctly implement this library's registry interfaces or TFC's own:

  • RegistryMetal
  • RegistryRock
  • RegistrySoilVariant
  • RegistryWood

Where these are provided by this library:

  • RegistryOre
  • RegistrySand
  • RegistrySoil

How discovery works

The mod automatically finds all types if:

  • The type implements the correct Registry[Type] interface
  • The type is an enum (required for auto-discovery)

If an addon does not use enums or needs manual registration, it can still be supported by the addon developer by calling the helper registration methods directly:

Example: manually register soil variants from a non-enum source

SoilVariantRegistryHelper.registerTypes(
    YourSoilVariantClass.class,
    List.of(yourVariant1, yourVariant2, ...),
    "yourmodid"
);

Same method exists in every helper class:

MetalRegistryHelper.registerTypes(...)
WoodRegistryHelper.registerTypes(...)
RockRegistryHelper.registerTypes(...)
OreRegistryHelper.registerTypes(...)
SoilRegistryHelper.registerTypes(...)
SandRegistryHelper.registerTypes(...)
SoilVariantRegistryHelper.registerTypes(...)

Code examples:

// Metals
List<RegistryMetal> allMetals = MetalRegistryHelper.getAllMetalValues();
RegistryMetal brass = MetalRegistryHelper.getMetalValueOrDefault("brass");

// Woods
List<RegistryWood> allWoods = WoodRegistryHelper.getAllWoodValues();
RegistryWood ebony = WoodRegistryHelper.getWoodValueOrDefault("ebony");

// Rocks
List<RegistryRock> allRocks = RockRegistryHelper.getAllRockValues();
RegistryRock marble = RockRegistryHelper.getRockValueOrDefault("marble");

// Ores
List<RegistryOre> allOres = OreRegistryHelper.getAllOreValues();
RegistryOre sphalerite = OreRegistryHelper.getOreValueOrDefault("sphalerite");

// Soils
List<RegistrySoil> allSoils = SoilRegistryHelper.getAllSoilValues();
RegistrySoil duff = SoilRegistryHelper.getSoilValueOrDefault("duff");

// Sand colors
List<RegistrySand> allSands = SandRegistryHelper.getAllSandValues();
RegistrySand white = SandRegistryHelper.getSandValueOrDefault("white");

// Soil variants
List<RegistrySoilVariant> allVariants = SoilVariantRegistryHelper.getAllSoilVariantValues();
RegistrySoilVariant inceptisol = SoilVariantRegistryHelper.getSoilVariantValueOrDefault("inceptisol");

All get[Type]ValueOrDefault("name") methods are case-insensitive and return a safe fallback if not found.

For example, iterating over the List<RegistryWood> list, can yield a list of wood types like this, where this shows a scenario with ArborFirmaCraft installed:

acacia, ash, aspen, birch, blackwood, chestnut, douglas_fir, hickory, kapok, mangrove, maple, oak, palm, pine, rosewood, sequoia, spruce, sycamore, white_cedar, willow, araucaria, baobab, beech, cypress, eucalyptus, fig, ginkgo, hevea, ipe, ironwood, mahoe, mahogany, teak, tualang

You can easily register new blocks using the lists/getters provided by the helpers. Here is shown an example of how to add a new SoilBlock for all registered soil types and soil variants:

public static final Map<RegistrySoil, Map<RegistrySoilVariant, Id<Block>>> NEW_SOIL_BLOCKS =
    SoilRegistryHelper.getAllSoilValues().stream()
        .collect(Collectors.toMap(
            type -> type,
            type -> SoilVariantRegistryHelper.getAllSoilVariantValues().stream()
                .collect(Collectors.toMap(
                    variant -> variant,
                    variant -> register(type.toString() + "/" + variant.toString(),
                        () -> new SoilBlock(Block.Properties.of().mapColor(MapColor.DIRT).strength(1.4f), type, variant))
                ))
        ));

For example: if a block/item/entity/whatever constructor insists on using e.g. SoilBlockType, such as ConnectedGrassBlock, you can safely cast your soil from the RegistrySoil interface to it like this (RegistrySoil)(Object)soil (or however else you prefer to do it), since I've made TFC's SoilBlockTypeenum class implement the custom RegistrySoil interface.

Ideal for addons, modpack makers, or any setting that needs to work with every TFC-compatible metal, wood, rock, ore, soil, sand, or variant regardless of which mods are installed.

For example, you can use the registry type lists created by this library, to easily create new blocks, items, entities etc. for all of or the desired entries of the specific type.

Screenshots

Gallery

This project has no gallery images yet.

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

~29,000
Total Downloads
CurseForge
~22,000
Modrinth
~6,000
Last Updated
CurseForge
Created
CurseForge
Modrinth
Last synced
When ModDex last fetched this project from CurseForge or Modrinth. Every project is re-checked on a schedule, and any project that ships a new file is synced automatically within hours of the release.
New file updates sync automatically
How syncing works