View source for Mod:Unruled Api

{{Infobox mod|title=Unruled API|image=Unruled_api_icon.png|author=RecraftorsMC|developer=[[User:Nerjal Nosk|Nerjal Nosk]]|latest_release=0.6 (2025-01-03)|initial_release=0.1 (2024-01-24)|modloader={{Fabric}},{{NeoForge}}|minecraft_version=active:{{1.21}}, {{1.21}} <br> inactive: {{1.18}}, {{1.19}}|modrinth=https://modrinth.com/mod/unruled-api|sources=https://codeberg.org/RecraftorsMC/unruled-api}}

'''Unruled API''' is a library mod, that allows other mod to easily create new gamerules, using new kind of gamerules, new tools to tweak them, and provide more control over the game without the need for brand new functionalities like complex configuration files.

Additionally, despite some client-side integration for better ease of use, Unruled API works perfectly being only on the server, making it a proper server-side mod.

== New Gamerule Types ==

Unruled API provides other mods with up to 9 new gamerule types:

Since 0.1:
<li>
  <ul>Floating gamerules
  <li>
    <ul>Stores a <i>float</i> value, with precision ranging from 2<sup>-126</sup> to 2<sup>127</sup></ul>
  </li>
  </ul>
  <ul>Long gamerules
  <li>
    <ul>Stores a <i>long</i> value, ranging from -2<sup>63</sup> to 2<sup>63</sup>-1</ul>
  </li>
  </ul>
  <ul>Double gamerules
  <li>
    <ul>Stores a <i>double</i> value, with precision ranging from 2<sup>-1022</sup> to 2<sup>1023</sup></ul>
  </li>
  </ul>
  <ul>String gamerules
  <li>
    <ul>Stores a short textual value, with a hard maximum length of 128 characters.</ul>
  </li>
  </ul>
  <ul>Text gamerules
  <li>
    <ul>Stores a textual value, with an arbitrary maximum length to be determined by the mod creating the gamerule.</ul>
  </li>
  </ul>
  <ul>Enum gamerules
  <li>
    <ul>Stores an enum value, from a specified enum class. Values are parsed and recognized by name, and only those are suggested to the player upon trying to modify the gamerule's value from the chat.</ul>
  </li>
  </ul>
</li>

Since 0.6

<li>
  <ul>Registry Entry gamerules
  <li>
    <ul>Stores a {{Registry}} entry value as a {{Resource_Location}}, and matches it with the appropriate registry value for the mod creating the gamerule to use.</ul>
  </li>
  </ul>
</li>

All gamerule types have integration with the World Creation's Gamerules menu. However, due to menu development not being the strong suit of the developer, text rules' integration is marked as <i>Not Yet Implemented</i>, in view of a future easier mean to edit long to very long textual fields in a single menu.

== Additional Functionalities ==

Unruled API allows mods to add to any new gamerule both a <i>validator</i> and an <i>adapter</i>. Those are meant to help a mod control what values can a gamerule accept.

The validator is used when providing a new value to the gamerule. It will test if the provided value matches custom conditions. If the value is accepted, then the gamerule value can properly change without any issue.

If the value is rejected by the validator, then the adapter will take it, and possibly try to provide a better fitting value. This new value will then be tested again with the validator for a final consistency check. Then only, if accepted, will the gamerule's value change.

{{DEFAULTSORT:Unruled API}}
[[Category:Mods]]