search

TheLoopProject / patches

Making the game more fun on legacy versions.
Mozilla Public License 2.0
0 stars 0 forks source link

readme

Ornithe Template Mod

The official Ornithe template mod. You can use it as a template for your own mods!

Usage

In order to use this mod as a template:

  1. Create a new repository from this template with Use this template
    • Tick the box "Include all branches"
  2. Your repository will contain several branches, each for a different preferred loader and Minecraft version. You can select the appropriate branch as the main branch and discard the others.
    • For Fabric Loader, Minecraft 1.3 and above, use the fabric/merged branch.
    • For Fabric Loader, Minecraft 12w30e and below, use the fabric/split branch.
    • For Quilt Loader, Minecraft 1.3 and above, use the quilt/merged branch.
    • For Quilt Loader, Minecraft 12w30e and below, use the quilt/split branch.
  3. Clone the recently-created repo on your PC
  4. Make the necessary changes in order to make it yours:
    • Update gradle.properties in order to use your
      • Update your mod's 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>
      • Update your mod's dependencies
    • 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.
      • If you use LICENSE.md, don't forget to update the buildscript in order to use that file name!
      • In fabric.mod.json, don't forget to put the license's SPDX identifier under the "license" property`.
      • The GPLv3 and AGPLv3 are not valid mod licenses, so you can use almost any license except for those.
    • Update the Java sub-directory structure so it reflects your Maven group
  5. The mod is now ready to be worked on!

License

This template on the OrnitheMC GitHub is licensed under the Creative Common Zero v1.0 license.

Mods created with this template are not automatically licensed under the CC0, and are not required to give any kind of credit back to OrnitheMC for this template.