Skip to content

README.md

Latest commit

 

History

History
64 lines (47 loc) · 2.34 KB

README.md

File metadata and controls

64 lines (47 loc) · 2.34 KB
Raw

Cactus-ModLoader

A fork-agnostic and cross-platform Mod Loader for LCE.

Cactus ModLoader allows you to mod LCE using lua scripting.

Join the discord https://discord.gg/YFdVHmUvdm

Scope

The scope of this project is to have a fork-agnostic and cross-platform Mod Loader for LCE

Goals:

  • Add custom block and item registration with custom textures (implemented)
  • Event system (implemented)
  • Client and server modding using LUA scripting (implemented)
  • Allow for modding the UI
  • Custom generation and dimensions
  • Port Cactus ModLoader to Minecraft Java Edition
  • String ID system for items and blocks (implemented)
  • More...

Building

Dependencies

This project requires Lua 5.4 and its developments headers for compiling

Ubuntu

sudo apt install lua5.4 liblua5.4-dev

Arch Linux

sudo pacman -S lua

Fedora

sudo dnf install lua lua-devel

Windows: I suggest using the vcpkg package manager to install the dependencies or you can download the pre-compiled binaries and headers on the LuaBinaries website.

vcpkg install lua:x64-windows

Implementing and building

Cactus ModLoader is made to be fork-agnostic so that it could be implemented into any fork of LCE Example: LCEMP, MinecraftConsoles, 4jcraft and others?

You are responsible for maintaining a custom implementation of Cactus ModLoader on a LCE fork while respecting the contribution policy of the project

The project comes with a meson.build file that can be added as a dependency for the Minecraft.Client

I am currently working on a implementation of Cactus ModLoader for 4jcraft while developing and expending the mod loader you can contribute to it on the cml-implementation branch of my 4jcraft-mmay fork

Contribution policy

Submitting code to this repository authored by generative AI tools (LLMs, agentic coding tools, etc...) is strictly forbidden Pull requests that are clearly vibe-coded or written by an LLM will be closed. Contributors are expected to both fully understand the code that they write and have the necessary skills to maintain it. You should not contribute any LCE derived or copied code to the Cactus ModLoader project, that sould be contributed to the respective implementations