Description

PlayerAbilityLib

Have you ever had an issue with a flight charm that stopped working as soon as you ran a /fly command ? Or a magic jetpack that made spectators sink through the ground ? Or a ghost mode that didn't let you fly for seemingly no reason ?

Mod incompatibilities with player abilities are way more common than we would like them to be, and are very difficult for mod developers to avoid. This library can be used by any Fabric mod that interacts with the PlayerAbilities class to avoid the aforementioned issues without difficulty.

credits to Chloe Dawn for some of the API design

Player information

Players should not have to download this library themselves, as it is intended to be embedded in distributed jar files.

If you find a mod that causes incompatibility related to player abilities (eg. flight), you can link the author (politely) to this API and ask if they could use it wherever they touch PlayerAbilities.

Developer information

Developers should use gradle to setup a dependency on this library. Instructions are given in the repository's README.

You can find a couple usage examples in the Test Mod.

• Item that toggles an ability
• Potion that grants an ability

What means Verified?

• Compatibility: The mod should be compatible with the latest version of Minecraft and be clearly labeled with its supported versions.
• Functionality: The mod should work as advertised and not cause any game-breaking bugs or crashes.
• Security: The mod should not contain any malicious code or attempts to steal personal information.
• Performance: The mod should not cause a significant decrease in the game's performance, such as by causing lag or reducing frame rates.
• Originality: The mod should be original and not a copy of someone else's work.
• Up-to-date: The mod should be regularly updated to fix bugs, improve performance, and maintain compatibility with the latest version of Minecraft.
• Support: The mod should have an active developer who provides support and troubleshooting assistance to users.
• License: The mod should be released under a clear and open source license that allows others to use, modify, and redistribute the code.
• Documentation: The mod should come with clear and detailed documentation on how to install and use it.

How to Install