Stereo528's unofficial Quilt template mod. You can use it as a template for your own mods! However, this is the basis for all of my mods going forward!
In order to use this mod as a template:
- Create a new repository from this template with
Use this template - Clone the recently-created repo on your PC
- Make the necessary changes in order to make it yours:
- Update
gradle.propertiesin order to use your Maven group and mod ID- If you don't know which Maven group to use, and you are planning to host the mod's source code on GitHub, use
io.github.<Your_Username_Here>
- If you don't know which Maven group to use, and you are planning to host the mod's source code on GitHub, use
- Update
quilt.mod.jsonin order to reflect your mod's metadata- If you are planning to include (jar-in-jar) a mod, don't forget to declare its dependency on it!
- The icon provided here is a placeholder one. If you aren't able to replace it yet, you can delete it and remove the "icon" property
- Create a LICENSE file for this mod! If you don't know which license to use, check out here.
- In
quilt.mod.json, don't forget to put the license's SPDX identifier under the"license"property in"metadata". - The GPLv3 and AGPLv3 are not valid mod licenses, so you can use almost any license except for those.
- In
- Update the Java sub-directory structure so it reflects your Maven group
- If the dependencies on
gradle/libs.versions.tomlisn't up-to-date, feel free to update them! The linked utility should help you in this easy and quick process.
- Update
- The mod is now ready to be worked on!
- LazyDFU & Sodium are dev environment only mods
- MidnightLib is a dependency mod
- MidnightLib config system is set up already!
This template is licensed under the BSD-3-Clause "New" or "Revised" License.
Mods created with this template are not automatically licensed under the BSD-3-Clause License, and are not required to give any kind of credit back to QuiltMC or Stereo528 for this template.