fabric-template-mod's Introduction

Fabric Template Mod

I wanted my own system/template for modding, so I made one instead of just modifying the Fabric one each time...

Usage

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.properties in 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>
  - Otherwise, if you own a domain you can use your domain just backwards, like dev.stereo528
  - And if you don't have a domain, use me.<Username>, com.<ProjectName>, or think of something fun!
- Update fabric.mod.json in 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 fabric.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.
- Update the Java subdirectory structure so it reflects your Maven group
- If the dependencies on gradle/libs.versions.toml isn't up-to-date, feel free to update them! The linked utility should help you in this easy and quick process.
The mod is now ready to be worked on!

License

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 FabricMC or Stereo528 for this template.

Recommend Projects