diff options
| author | Linnea Gräf <nea@nea.moe> | 2025-11-25 11:07:33 +0100 |
|---|---|---|
| committer | Linnea Gräf <nea@nea.moe> | 2025-11-25 11:07:33 +0100 |
| commit | 3dc343a4dfd0b5c30543321b77227d6c4fe5697e (patch) | |
| tree | f97a5643efeb9cf165b714bcd6e3b7eb4a496913 /src/api/java | |
| parent | 707652b59e10371cf4826f9f65d653cac528c6bb (diff) | |
| download | Firmament-3dc343a4dfd0b5c30543321b77227d6c4fe5697e.tar.gz Firmament-3dc343a4dfd0b5c30543321b77227d6c4fe5697e.tar.bz2 Firmament-3dc343a4dfd0b5c30543321b77227d6c4fe5697e.zip | |
fix: add documentation for how to register an extension
Diffstat (limited to 'src/api/java')
| -rw-r--r-- | src/api/java/moe/nea/firmament/api/v1/FirmamentExtension.java | 11 |
1 files changed, 11 insertions, 0 deletions
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,9 +6,20 @@ 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. + * + * <p>To register, set the entrypoint {@code firmament:v1} to an implementation of this class.</p> + * @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")}. */ |