Framework

A custom and relatively unstable template mod, based on Jaredlll08's MultiLoader Template.

Why?

This template was created to accelerate development of new client-side mods by providing more base functionality than the original Multiloader-Template from which it is derived.

It is not better, nor necessarily worse, than the original, it just serves a different purpose.

Features

• Configuration system using Cloth Config or YACL (both included, remove the one you don't want)
• Keybind registration
• Command registration
• GitHub, Modrinth and CurseForge publishing via GitHub actions

Usage

This project was created and is maintained for TerminalMC use, so consider it provided as-is, without any warranty or guarantee of support or maintenance. If you choose to use it, you do so at your own risk.

Changing Project Details (IntelliJ IDEA)

1. Change the root directory name, then
2. SHIFT+F6 to rename packages, classes and files, then
3. CTRL+SHIFT+R case-sensitive with scope In Project to replace (in order):
   • raDGbHBr -> Modrinth project ID
   • 833352 -> CurseForge project ID
   • tmc-framework -> CurseForge slug
   • Framework -> Mod name
   • framework -> Mod ID
     • Note: Fabric allows - but not _, NeoForge allows _ but not -
   • https://discord.terminalmc.dev -> Discord invite link
   • 1103153365216669797 -> Discord server ID
   • NotRyken -> Author name
   • Outside of TerminalMC
     • https://terminalmc.dev -> Contact link
     • TerminalMC
     • terminalmc

Other Notes

• The Fabric Client run configuration will crash, citing a missing library for YACL. Download and add YACL to the mods folder manually to fix. It may still crash after that, but usually only on the first run.

Dependencies

• Mod dependencies must be specified in the loader-specific build.gradle. API mods may also be specified in the common build.gradle for usage by the common subproject.

• Dependency repositories must be specified in buildSrc/main/groovy/multiloader-common.gradle.

• Dependency version and compatible version ranges must be added to gradle.properties and the expandProps map in

• multiloader-common.gradle, to allow importing by fabric.mod.json, neoforge.mods.toml, and mixin.json files.

License

CC0-1.0 Universal

Contact