Skip to content

moongardenmods/allium

Repository files navigation

Allium Logo

Github Stars Allium Modrinth Downloads Bouquet Modrinth Downloads Discord

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 hugeblank's 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.

Logos

Allium's logos are under the same license as the rest of the project. Feel free to use these in your own project.

Allium Icon

Allium Logo

Powered by Allium

Contributing

Allium is broken up into 2 gradle subprojects that each build into their own jars. When making a pull request please make sure to use the template that corresponds to which project you're contributing to (TODO). If you'd like to discuss contribution please feel free to join the Moongarden mods discord.

Allium

Found in the allium directory, this is the bare-minimum necessary for a Lua script to be run in the game.

Bouquet

Found in the bouquet directory, this features additional quality of life libraries, as well as frequently used event hooks into the games logic.

Dev Environment Notes

  • To build both projects at the same time use the buildAll gradle task.
  • Multiple client run configurations are created. One is for running only allium, the other is for running both allium & bouquet.

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Contributors 7