Added a README.md

README.md

@@ -1,9 +1,35 @@
-# Fabric Example Mod
+# JoaCarpet
 
-## Setup
+A small [Carpet](https://github.com/gnembon/fabric-carpet) extension mod.
 
-For setup instructions please see the [fabric wiki page](https://fabricmc.net/wiki/tutorial:setup) that relates to the IDE that you are using.
+## Carpet Mod Settings
+### insaneBehaviors
+Makes the random velocities of droppers and projectiles (as well as both the position and velocity of blocks broken by pistons) systematically iterate through the most extreme values possible, and then repeatedly iterate through all the halfway points in between, in a sense attempting every point in a 3d/5d "grid" that slowly increases in resolution.
 
-## License
+For droppers and projectiles, this setting determines whether the max value corresponds to the old gaussian randomness limits (\"extreme\"), or the limits of the triangular randomness introduced in 1.19 (\"sensible\"). Both settings function the same for blocks being broken by pistons.
 
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+For the `/insanebehaviors <reset/getstate/setstate>` command, see `/carpet commandInsaneBehaviors`.
+
+Do note that insaneBehaviors works on a global iterator: any triggering event will step through an iteration from all other insaneBehaviors events, too.
+
+* Type: `String`
+* Categories: `CREATIVE`, `JOA`
+* Options: `extreme`, `sensible`, `off`
+* Default value: `off`
+
+### commandInsaneBehaviors
+The command used for the `insaneBehaviors` rule.
+\"reset\" sets the `resolution` and `counter` back to the default values. \"getstate\" and \"setstate\" are used to manually read and write the current iteration state.
+
+* Type: `String`
+* Categories: `COMMAND`, `CREATIVE`, `JOA`
+* Options `true`, `ops`, `false`, `0`, `1`, `2`, `3`, `4`
+* Default value: `ops`
+
+### blockTickling
+Lets you send manual block and/or shape updates to blocks using a feather item. Shape updates are sent from the block in front of the face you're clicking on. Useful if you're working with update interactions off or with budded blocks.
+
+* Type: `String`
+* Categories: `CREATIVE`, `JOA`
+* Options `off`, `blockupdates`, `shapeupdates`, `both`
+* Default value: `off`

src/main/resources/assets/joacarpet/lang/en_us.json

@@ -1,5 +1,5 @@
 {
-  "carpet.rule.insaneBehaviors.desc": "Makes the random velocities of droppers and projectiles (as well as both the position and velocity of blocks broken by pistons) systematically iterate through the most extreme values possible, and then repeatedly iterate through all of the halfway points in between, in a sense attempting every in-between value in a 3d/5d \"grid\" of points that slowly increases in resolution.\nFor droppers and projectiles, this setting determines whether the max value corresponds to the old gaussian randomness limits (\"extreme\"), or the limits of the triangular randomness introduced in 1.19 (\"sensible\"). Both settings function the same for blocks being broken by pistons.\nFor the `/insanebehaviors <reset/getstate/setstate>` command, see `/carpet commandInsaneBehaviors`.\nDo note that insaneBehaviors works on a global iterator: any triggering event will step through an iteration from all other insaneBehaviors events, too.",
+  "carpet.rule.insaneBehaviors.desc": "Makes the random velocities of droppers and projectiles (as well as both the position and velocity of blocks broken by pistons) systematically iterate through the most extreme values possible, and then repeatedly iterate through all the halfway points in between, in a sense attempting every point in a 3d/5d \"grid\" that slowly increases in resolution.\nFor droppers and projectiles, this setting determines whether the max value corresponds to the old gaussian randomness limits (\"extreme\"), or the limits of the triangular randomness introduced in 1.19 (\"sensible\"). Both settings function the same for blocks being broken by pistons.\nFor the `/insanebehaviors <reset/getstate/setstate>` command, see `/carpet commandInsaneBehaviors`.\nDo note that insaneBehaviors works on a global iterator: any triggering event will step through an iteration from all other insaneBehaviors events, too.",
   "carpet.rule.commandInsaneBehaviors.desc": "The command used for the `insaneBehaviors` rule.\n\"reset\" sets the `resolution` and `counter` back to the default values. \"getstate\" and \"setstate\" are used to manually read and write the current iteration state.",
   "carpet.rule.blockTickling.desc": "Lets you send manual block and/or shape updates to blocks using a feather item. Updates are sent from the block in front of the face you're clicking on. Useful if you're working with update interations off or with budded blocks."
 }