Skip to content

AxolotlClient/AxolotlClient-config-template-mod

Repository files navigation

AxolotlClient-Config Example Mod

A template / example for using this Config Library in Minecraft 1.19.2.

Usage

In order to use this mod as a template:

  1. Create a new repository from this template with Use this template
  2. Clone the recently-created repo on your PC
  3. 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>
    • Update quilt.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 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.
    • 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.
  4. The mod is now ready to be worked on!

License

This template on the AxolotlClient 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 AxolotlClient for this template.

Credits

This template is based on the Quilt Template Mod.

About

Template mod for using AxolotlClient-Config

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages