Mekanized

Mekanized

Mekanism's machines on Paper and Folia servers, with no client mod. Built on MachineEngine and CraftEngine: CraftEngine sends the blocks and items in a resource pack, and zMenu draws the machine menus.

Inspired by Mekanism; textures, models, recipes and names come from Mekanism by Aidan C. Brady (MIT, see LICENSE-MEKANISM.txt, which ships in the jar). Mekanized is not affiliated with Mekanism.

Requirements

Installing

Put CraftEngine, MachineEngine, Mekanized and zMenu in plugins/, start the server once, then run /ce reload all. Players need CraftEngine's resource pack, which also draws the menus. The full server owner's guide is docs/MEKANIZED_GUIDE.md.

Building

./gradlew build

The plugin jar is written to build/libs/Mekanized-<version>.jar. JDK 25 builds it; the bytecode stays Java 21, and check fails if it uses Paper API newer than 1.20.6 (verifyPaperBaseline).

MachineEngine: Mekanized compiles against machineengine-api and tests with machineengine-test, from JitPack at the version in gradle/libs.versions.toml. With a MachineEngine checkout next to this one (../MachineEngine, or -Pmachineengine_dir=<path>), the build uses that checkout instead, so engine changes are picked up without a release; -PlocalEngine=false turns this off. CI and releases clone MachineEngine at that version next to the checkout, so they do not depend on JitPack.

Dev servers

./gradlew runPaper-26.3

Also runPaper-1.20.6, runFolia-1.20.6 and runFolia-26.2. They need the MachineEngine checkout: the server gets MachineEngine's plugin jar built from it. CraftEngine is built from its dev branch into .craftengine/ on the first run (-PrefreshCraftEngine rebuilds it; -Pcraftengine_runtime=modrinth downloads the release instead), and zMenu is downloaded (-PwithZMenu=false leaves it out). Servers run in run/<paper|folia>-<version>/.

Server checks (admins, results in the console log): /mekanized test, test-cable, test-chemistry, check-block-options, check-upgrades, check-station, check-modules, check-item-data. ./gradlew ceSnapshot checks that the CraftEngine blocks and items still expand as in ce-snapshot.json.

Content

The content is kept by hand in src/main/resources/mekanized/: textures and models under pack/resourcepack/, CraftEngine items and crafting recipes under pack/configuration/, and machine recipes and tags under definitions/. A .yml file added to pack/configuration/ or definitions/ is installed automatically: the build lists them in manifest.yml.

License

GPL-3.0, see LICENSE. Mekanism's assets: MIT, see LICENSE-MEKANISM.txt.