Lua script loader for Java Minecraft.
Currently, only functioning and in development in Fabric, with the intent of supporting Forge/Quilt later on down the road.
Installing
Allium installs just like any other Fabric mod. Depending on the scripts you use, they may depend on Bouquet, an additional mod that adds libraries to make scripting easier. Much like Fabric API, this mod is independent and not built into the loader side of Allium and must be downloaded individually.
If you'd like to use Allium or Bouquet to extend functionality of your own Java mod, publications can be found on the Moongarden Maven.
Scripts
In the same place that you create your mods directory, create a folder named allium. This is where your lua scripts
will go. They may come in the form of a .zip, but may be expanded, and put into a regular directory if you'd like to
tinker with them. If you're at all familiar with the Resource/Data Pack structure, then you'll know that this is
similar.
Documentation
How to Install Allium (Mod)
Allium by hugeblank is verified for Fabric across Minecraft versions 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6 (latest release: 0.5.0, file size: 709 KB). Follow the steps below to install it safely from ModCraft.tv:
- Click the Download button above and select your Minecraft version (1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6) and platform (Fabric).
- Make sure you have the compatible loader or environment installed for Fabric.
- Move the downloaded Allium file into your Minecraft
.minecraft/modsfolder and launch the game.
All Versions
+ Add Version
This update is a complete overhaul from the prior version. Much of the fundamental behaviors remains the same, but the engine behind those behaviors has been changed. Furthermore most all of the APIs have been overhauled in one way or another. For specific documentation please see the [Allium Docs](https://allium.moongarden.dev/).
Major items have been given a title in bold.
## Features
- Mixin Support**: Lua developers can now write Java mixins in Lua. While it is possible for all mixin injector types to be created, support in the API has been primarily given to the following annotations:
- @Inject
- @ModifyArg
- @ModifyArgs
- @ModifyExpressionValue
- @ModifyReturnValue
- @WrapMethod
- @Definition
- @Expression
- @Cancellable
- @Local
- @Share
- Class Builder Scope**: The methods provided to a class being built now have access to private methods on themselves, and protected methods on parent classes via the
selfkeyword. - Java Library Additions**:
- Java primitive types can now be accessed through the
javalibrary using the primitive name (ex.java.boolean) - Add method
java.callWith(). Forces a method invocation with the provided parameter type list, instead of inferring them from the parameters. - Add method
java.coerce(). Coerces an object that inherits from eitherCollectionorMapinto a table. - Add method
java.wrap(). Forcibly wraps a primitive value in one of the Java wrapper classes. - Add method
java.throw(). Throws a provided exception. - Add the
mixinmanifest entrypoint. Used to declare mixins before the game launches. - Add method
script:registerReloadable(), expects arequire-like path to a file that will be executed whenever the script'sreloadmethod is called. - The
__lenmetamethod is now provided on all objects where a Java.size()method or.lengthfield is present. This means that any object with either can now have their size inspected with the#prefix.
## Changes
- Class Builder Overhaul**: The class builder API is now a factory pattern, where methods get chained together to build out the class. At the very end a table matching the specified class methods is supplied.
- The
alliumandjavaAPIs have been moved from Bouquet to here. - Java arrays no longer unidirectionally get converted to tables and instead are given a metatable that wraps the array in table-like functionality.
- The game environment that was previously accessed with
package.environmentis now accessed with theallium.environment()function. - The
staticmanifest entrypoint has been renamed tomain - A wider range of java specific utility types are now supported during coercion.
- Error messages are substantially more detailed.
## Removals
- Mapping Support Deprecation**: Due to the [removal of obfuscation](https://www.minecraft.net/en-us/article/removing-obfuscation-in-java-edition) and the overwhelming challenge of having to convert betw
- Remove individual per-environment script entrypoints
- Add
package.environmentto compensate for the removal mentioned above. Usepackage.environment == "client"in a conditional to isolate logic that's only meant to be run on the client. - Add
mappingsfield tomanifest.json. Currently the only available option is"yarn", but expect that to change soon!
