Skip to content

README.md

Latest commit

 

History

History
30 lines (20 loc) · 1.19 KB

README.md

File metadata and controls

30 lines (20 loc) · 1.19 KB
Raw

Weave's Mod Template

This repository shows how to set up a Gradle project using the Weave Gradle plugin to develop mods for Weave. This template uses Java, if you want to use Kotlin instead, check out the Kotlin Template.

Note

If you prefer developing in Kotlin instead of Java, check out the Kotlin template repository at Weave-MC/ExampleMod-Kotlin.

How to start?

To use this repository as a template, click on the green Use this template button.

Alternatively, you can simply clone this repository with the following commands:

# You can change "MyCoolMod" to anything you'd like
git clone https://github.com/Weave-MC/ExampleMod MyCoolMod 
cd MyCoolMod

How to build

Building requires a JDK of version 17 or higher. A good JDK distribution can be downloaded from Adoptium.net, but any OpenJDK compatible JDK suffices.

To build a Weave mod, you can simply run:

./gradlew build

You can find the built jar files in ./build/libs/*.jar.