Differences

This shows you the differences between two versions of the page.

--- tutorial:gamerule [2021/01/30 19:51] – mysterious_dev
+++ tutorial:gamerule [2025/12/09 19:10] (current) – 1.21.11 lang-file change for gamerules' identifier(s) solacekairos
@@ Line 1: / Line 1: @@
-====== Custom Gamerule ======
+====== Adding a Gamerule ======
-==== Creating your gamerule ====
+==== Registering a Gamerule ====
+To create a gamerule, build and register it using the ''GameRuleBuilder'' of the Fabric API:
+<code java [enable_line_numbers="true"]>
+// Create and register a boolean gamerule, enabled by default
+private static final Identifier        GAMERULE_IDENTIFIER     = Identifier.of("custom_mod_name","gamerule_name");
+public  static final GameRule<Boolean> CUSTOM_BOOLEAN_GAMERULE = GameRuleBuilder
+    .forBoolean(true) //default value declaration
+    .category(GameRuleCategory.MISC)
+    .buildAndRegister(GAMERULE_IDENTIFIER)
+;
+</code>
+==== Using the gamerule ====
+To get access to the value of a gamerule, use a server-world:
+<code java [enable_line_numbers="true"]>
+serverWorld.getGameRules().getValue(CUSTOM_GAMERULE);
+</code>
+==== Translation ====
+The registered gamerule shows up untranslated in the gamerule list, which can be opened in the world creation screen.
+To translate the name, add an entry in the lang-file (see [[tutorial:lang|lang]] for more info):
+<code json>
+{
+  "gamerule.custom_mod_name.gamerule_name": "Gamerule Name"
+}
+</code>