Overview
Mechanicals Lib is a Java library aimed at developers who create mods for the Neoforge platform. It focuses on providing building blocks for addons that extend the functionality of the Create mod, but it can be used for other purposes as well. The project includes a dedicated wiki that explains the API and shows example usage.
Compatibility
The library works with Minecraft version 1.21.1 and requires the Neoforge mod loader. Both client and server sides must have the library present for it to function correctly. It's listed under the Libraries & APIs category on Modrinth.
Adding to a Project
To include Mechanicals Lib in a Gradle project, first add the Maven repository that hosts the library:
maven {
url "https://maven.fosil.eu/releases"
}
Then declare the dependency using the jarJar syntax:
jarJar(implementation("com.oierbravo.mechanicals:Mechanicals:${minecraft_version}-${mechanicals_version}"))
In the project's gradle.properties file set the following variables:
minecraft_version=1.21.1
mechanicals_version=4.28 #Use always latest.
The comment reminds users to keep the version number up to date.
Licensing
Mechanicals Lib is released under the GNU Lesser General Public License version 3 only. Some parts of the code come from the Create mod and are covered by the MIT license, which is noted in the repository.
Who Should Use It
If you're building a mod that needs to interact with Create's mechanics or you want a stable API for common Neoforge tasks, this library gives you a ready set of classes and utilities. Look, it saves you from writing low-level code and lets you focus on the features that make your addon unique.
Getting Help
The wiki linked from the Modrinth page contains installation instructions, API reference, and examples. Community members can also raise issues on the GitHub repository if they encounter problems.
