From 3dc343a4dfd0b5c30543321b77227d6c4fe5697e Mon Sep 17 00:00:00 2001 From: Linnea Gräf Date: Tue, 25 Nov 2025 11:07:33 +0100 Subject: fix: add documentation for how to register an extension --- src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/api/java') diff --git a/src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java b/src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java index 1fa3c11..89547cb 100644 --- a/src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java +++ b/src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java @@ -6,8 +6,19 @@ import net.minecraft.client.gui.screens.Screen; import java.util.Collection; import java.util.List; +/** + * An extension to firmament, allowing you to hook into firmaments functions. + * + *

To register, set the entrypoint {@code firmament:v1} to an implementation of this class.

+ * @see #ENTRYPOINT_NAME + */ public interface FirmamentExtension { + /** + * Name of the entry point that should be used registering firmament extensions. + */ + String ENTRYPOINT_NAME = "firmament:v1"; + /** * This method gets called during client initialization, if firmament is installed. Can be used as an alternative to * checking {@code FabricLoader.getInstance().isModLoaded("firmament")}. -- cgit