Merge branch 'refs/heads/main' into release/1.20.1

# Conflicts:
#	COMPAT.md
#	common/src/main/resources/assets/miapi/lang/en_us.json

Author: Smartin-b

COMPAT.md

@@ -1,33 +1,31 @@
-# Compat information
-## Dedicated Compat
-These Mods have received dedicated compatibility patches/bugfixes in truly modular to ensure compatibility  
-This IS NOT a definitive list of compatible mods, just a list of mods that originally caused issues that we fixed.
-- **Better Combat**:
-dedicated and integrated support  
-But Better Combat sadly has a bug with NBT based Compat. We recommend using https://modrinth.com/mod/better-combat-nbt-fix for multiplayer
-- **Epic Fight**: weapons are mostly supported, armor sadly is not    
-- **Apoli**: is Origins power api, we have support via a property, allowing developers to use any apolipowers on modular items  
-- **HT Treechop**: If HT Treechop is loaded, woodcutting axes and normal axes will synergies with it  
-- **Project MMO**: light weight support so modular items are somewhat picked up by it.  
-- **Quark**: Quarks Enchanting Glint is somewhat supported on modular items  
-- **Apotheosis/Zenith**: Minor bugfixes for certain colliding effects  
+# Compatibility information
+
+## Dedicated Compatibility
+- **[Better Combat](https://modrinth.com/mod/better-combat)** has dedicated and integrated support within MIAPI.
+That being said, Better Combat also sadly has a bug with NBT based compatibility. We recommend using **[Better Combat NBT Fix](https://modrinth.com/mod/better-combat-nbt-fix)** for multiplayer.
+- **[Epic Fight](https://modrinth.com/mod/epic-fight)** should be fully supported well. If somebody wants to add more depth to the choices for EF, feel free to share with us.
+- **[Apoli](https://github.com/apace100/origins-fabric?tab=readme-ov-file)** is the Origins power API. We have support via a property, allowing developers to use any Apoli powers on modular items.
+- **[Quark](https://modrinth.com/mod/quark)** has special enchantment glint effects, and these are supported.
+- **[Apotheosis](https://www.curseforge.com/minecraft/mc-mods/apotheosis)**, and its Fabric port **[Zenith](https://modrinth.com/mod/zenith)** adds Affixes to equipment, and these are supported
+
+## Other Mod Info
+- **[Better Paragliders](https://modrinth.com/mod/better-paragliders)** stamina system should work with MIAPI tools.
 
 ## Generated Material Info
-Truly Modular attempts to make any mods Tool Materials compatible.
-This is done by scanning a Mods tools and trying to match their stats.
-Most mods should work with this system.vs
+Truly Modular attempts to make any mods' tool materials compatible.
+This is done by scanning a mod's tools, and trying to match their stats.
+Most mods should work with this system.
 - **Reqirements**  
-A Sword and an Axe implement as the same Toolfamily.
+Swords and Axes need to implement as the same tool family.
 - **Exceptions**  
-Some mods sadly implement their Tools differently/weirdly and dont get detected because of that.
-In addition right click abilities and on-hit effects or similar effects cant be automaticly detected sadly
-- **Quirks**  
-Sometimes the texturing or Naming of the Generated Material may be odd, this is simply due to the generative nature.
-  
-## Make your own Compat  
-  
-If some compat is still missing you can try to your own hand at it with the [Material Helper](https://truly-modular.github.io/Material-Helper/)
-This is a Website that lets anybody make compat materials for Truly Modular, even without any coding knowledge.
+Some mods sadly implement their tools differently or weirdly, and don't get detected because of that.
+In addition, right click abilities, on-hit effects, or similar effects can't be automatically detected.
+- **Quirks**
+Sometimes the texturing or naming of the generated material may be odd, this is simply due to the generative nature.
+
+## Make Your Own Compatibility  
+If some compatibility is still missing, you can try your own hand at it with the **[Truly Modular Material Helper](https://truly-modular.github.io/Material-Helper/)**.
+This is a web app that lets anybody make compat materials for Truly Modular, even without any coding knowledge.
 
 ## Issues
-if you encounter any issues be sure to report them https://github.com/Truly-Modular/Modular-Item-API/issues
+If you encounter any issues, be sure to report them to https://github.com/Truly-Modular/Modular-Item-API/issues

README.md

@@ -1,28 +1,36 @@
-The Truly Modular: miapi (Modular Item API) includes a comprehensive set of APIs, offering a wide range of features and functionalities to modders. Some of the key APIs provided by miapi include:
+<img src="common/src/main/resources/icon.png" alt="totally modular api icon" width="256">
 
-- Complex Module Properties: A complex Property resolving system producing predictable and easily adjustable results for Addon devs
+# Modular-Item-API 
+[![](http://cf.way2muchnoise.eu/versions/904056.svg)](https://www.curseforge.com/minecraft/mc-mods/modular-item-api)
+[![Modrinth](https://img.shields.io/modrinth/v/c4Uf1TKc?label=Modrinth&labelColor=%232D2D2D)](https://modrinth.com/mod/modular-item-api)
 
-- Runtime Property Injections and Overrides: Seamlessly inject or override properties at runtime using the Property system to inject additional Properties to a singular Module ona singular Item.
+Truly Modular: miapi (Modular Item API) includes a comprehensive set of APIs, offering a wide range of features and functionalities to modders. Some of the key APIs provided by miapi include:
 
-- GUI APIs: Access various GUI APIs to create GUIs with proper order of hirarchy and children logic to allow the creation of Complex GUIs.
+- Complex Module Properties: A complex Property resolving system producing predictable and easily adjustable results for Addon devs.
+
+- Runtime Property Injections and Overrides: Seamlessly inject or override properties at runtime using the Property system to inject additional Properties to a singular Module on a singular Item.
+
+- GUI APIs: Access various GUI APIs to create GUIs with proper order of hierarchy and children logic, to allow the creation of Complex GUIs.
 
 - Modular Item Crafter GUI: Enjoy a fully functional modular item crafter GUI, providing players with a convenient way to craft and assemble their customized modular items.
 
-- Synergy System between Modules: With a complex Synergysystem allowing unique Synergies between modules or materials allowing to target groups of each to create intricate Synergies.
+- Synergy System between Modules: With a complex Synergy system allowing unique Synergies between modules or materials allowing to target groups of each to create intricate Synergies.
 
 - Dozens of Default Properties: Benefit from a wide range of default properties that come bundled with miapi, saving you time and effort in defining common item attributes to be used accross addons.
 
-- Dozens of Default Materials: Utilize a diverse selection of default materials available within miapi from vanilla in addition to wide ranging mod support.
+- Dozens of Default Materials: Utilize a diverse selection of default materials available within miapi from vanilla, in addition to wide ranging mod support.
 
-- Complex 3D Capabilities: By abstracting the rendering any kind of effect can be implemented, by default this is mostly limited to block/item models for modules; entities and other special options do exist as well
+- Complex 3D Capabilities: By abstracting the rendering, any kind of effect can be implemented, by default this is mostly limited to block/item models for modules; entities and other special options do exist as well
 
-And much more awaits you as you delve into the world of Truly Modular: miapi. Explore the limitless potential of modular item customization and elevate your modding projects to new heights.
+Much more awaits you as you delve into the world of Truly Modular: miapi. Explore the limitless potential of modular item customization and elevate your modding projects to new heights.
 
 # For Developers
-latest version can be checked https://github.com/Truly-Modular/Modular-Item-API/releases  
-We recommend the usage of any Architectury Template, depending on Architectury is also recommended since Truly Modular already depends on it
-the miapi_version needed is the same as the github release tag
-## Common
+The latest version can be checked here: https://github.com/Truly-Modular/Modular-Item-API/releases  
+We recommend the usage of any Architectury Template, and depending on Architectury is also recommended since Truly Modular already depends on it.
+
+The miapi_version needed is the same as the Github release tag.
+## Repositories
+Add this to every subproject.
 ```js
 repositories {
     maven {
@@ -38,22 +46,34 @@ repositories {
             includeGroup "com.jamieswhiteshirt"
         }
     }
+    maven {
+        name = 'GeckoLib'
+        url 'https://dl.cloudsmith.io/public/geckolib3/geckolib/maven/'
+        content {
+            includeGroupByRegex("software\\.bernie.*")
+            includeGroup("com.eliotlash.mclib")
+        }
+    }
 }
 ```
+## Common
 ```js
 dependencies {
-    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-common:${rootProject.miapi_version}")
+    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-common:${rootProject.miapi_version}-${rootProject.minecraft_version}")
 }
 ```
 ## Fabric
 ```js
 dependencies {
-    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-fabric:${rootProject.miapi_version}")
+    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-fabric:${rootProject.miapi_version}-${rootProject.minecraft_version}")
 }
 ```
 ## Forge
 ```js
 dependencies {
-    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-forge:${rootProject.miapi_version}")
+    compileOnly(annotationProcessor("io.github.llamalad7:mixinextras-common:0.4.1"))
+    implementation(include("io.github.llamalad7:mixinextras-forge:0.4.1"))
+    modApi("com.Truly-Modular.Modular-Item-API:Truly-Modular-miapi-forge:${rootProject.miapi_version}-${rootProject.minecraft_version}")
+    forgeRuntimeLibrary(api("com.ezylang:EvalEx:3.2.0"))
 }
 ```