TheWinABagel / Example-BTWEMI-mod

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Fabric Example Mod

Quick start guide (Windows)

  • Clone this repository
  • Download the according BTW-CE 3.0+ intermediary release
  • Drag&Drop the intermediary .zip file onto the install.bat
  • Wait till it fully finishes
  • Run the gradle task build and then runClient

Quick start guide (Linux)

  • Clone this repository
  • Download the according BTW-CE 3.0+ intermediary release
  • Drag&Drop the intermediary .zip file into the base mod folder
  • Open a terminal, cd to the base mod folder and run install.sh with sudo sh ./install.sh
    • Note: The default file name for the intermediary .zip file is BTW-CE-Intermediary-Distribution.zip. You can change it by editing the INTERMEDIARY_FILE_NAME variable in the install.sh.
  • Wait till it fully finishes
  • Run the gradle task build and then runClient

Introduction to the folder structure

Build files:

File Description
build.gradle Configures the compilation process.
gradle.properties Contains properties for Minecraft, fabric, and your mod.
settings.gradle Configures the plugin repositories.

Fabric files:

These files are located at src/main/resources.

File Description Additional information
fabric.mod.json Contains metadata about your mod. wiki:fabric_mod_json_spec
modid.mixins.json Contains a list of all your mixin files. wiki:mixin_registration
assets/modid/icon.png The icon of your mod. wiki:fabric_mod_json_spec#icon

Creating your mod

First of you must replace all occurrences of modid with the id of your mod.

If your mod doesn't use mixins you can safely remove the mixin entry in your fabric.mod.json as well as delete any *.mixin.json files.

This template has the legacy fabric api included in it's build script, more info about the api can be found at it's github repo. If you know what you are doing you can also safely remove the api from the build script as it isn't required.

Useful gradle commands

# Compile your mod
./gradlew build

# Remove old build files
./gradlew clean

# Generate Minecraft sources
./gradlew genSources

# Launch a modded Minecraft client
./gradlew runClient

# Kill gradle if it's doing stupid things
./gradlew --stop

More info

Additional tutorials and tips can be found in the wiki.

For more detailed setup instructions please see the fabric wiki.

If you are new to fabric or Minecraft modding in general then this wiki page may help you.

License

This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects. This project incorporates:

About


Languages

Language:Batchfile 35.8%Language:Shell 35.7%Language:Java 28.5%