Official Quilt template mod.

Overview

Quilt Template Mod

The official Quilt 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
  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 sub-directory 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 QuiltMC 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 QuiltMC for this template.

Comments
  • Adapt the LICENSE renaming in order to account for the file extension

    Adapt the LICENSE renaming in order to account for the file extension

    On QTM, LICENSE.md is to be considered a valid alternative to the good ol' LICENSE, but if you do try it, the renamed LICENSE will become something like LICENSE.md_example_mod, which is bad

    opened by EnnuiL 5
  • Add .gitattributes generated by gradle init

    Add .gitattributes generated by gradle init

    This ensures gradlew and gradlew.bat will always have the right line endings (if this is not done, Git for Windows' autocrlf causes differences between commits created on Linux and on Windows)

    opened by kb-1000 2
  • Unable to launch game after following example mod setup

    Unable to launch game after following example mod setup

    I am trying to port my Fabric mod to Quilt and followed the example mod as close as I can. However, when I run the game, I am greeted with this screen. image

    Console output: https://paste.ee/p/AA9Jq

    My mod's source: https://github.com/TelepathicGrunt/FeatureNBTDeadlockBeGone/tree/Quilt-1.18

    deps:

    • minecraft = "1.18.2"
    • quilt_mappings = "1.18.2+build.22"
    • quilt_loader = "0.16.0-beta.7"
    • quilted_fabric_api = "1.0.0-beta.6+0.51.1-1.18.2"

    lmk if you need more info.

    opened by TelepathicGrunt 2
  • Rework the template mod

    Rework the template mod

    The whole thing was a mess, so why not improve it?

    Here, I have done the following:

    • Grab the parts from Fabric Template Mod that were unnecessarily different here
    • Updated the README to be much clearer for the user (and also usable as a template for the end-user)
    • Use snake_case for mod IDs, use the common structure of x.y.z
    • Use version catalogs for managing all the dependency versions (If necessary, we could move it to root instead of the gradle subfolder)
    • Update Gradle to 7.4.2 (7.3 is necessary for Java 17 support, 7.4 for version catalogs)
    • Unbreak support for other IDEs
    opened by EnnuiL 2
  • Fix version ID

    Fix version ID

    Due to the 1.19 update, the version ID listed in gradle.properties became out of date. This PR fixes it and tells the gitignore to drop files made by the Eclipse JDT language server.

    opened by enderger 1
  • Branch 1.19 refers to 1.18.2 in gradle/libs.versions.toml

    Branch 1.19 refers to 1.18.2 in gradle/libs.versions.toml

    File libs.versions.toml in 1.19 branch

    https://github.com/QuiltMC/quilt-template-mod/blob/1.19/gradle/libs.versions.toml

    refers to 1.18.2 dependencies in [versions] section. Please fix.

    opened by lospejos 1
  • Template mod (and mods based on it) crash on startup on macOS, despite Quilt Launcher working in MultiMC

    Template mod (and mods based on it) crash on startup on macOS, despite Quilt Launcher working in MultiMC

    See here for the crash's latest.log: https://paste.ee/p/2vuJu Dev environment is running on Intelij IDEA 2022.1, and on ARM64 macOS Java 17

    Of most note is probably this:

    org.quiltmc.loader.impl.FormattedException: java.lang.NoSuchMethodError: 'net.minecraft.util.Identifier net.minecraft.util.registry.RegistryKey.method_29177()'
    	at org.quiltmc.loader.impl.game.minecraft.MinecraftGameProvider.launch(MinecraftGameProvider.java:425) ~[quilt-loader-0.16.0-beta.10.jar:?]
    	at net.fabricmc.loader.launch.knot.Knot.launch(Knot.java:76) [quilt-loader-0.16.0-beta.10.jar:?]
    	at org.quiltmc.loader.launch.knot.KnotHelper.launchClient(KnotHelper.java:28) [quilt-loader-0.16.0-beta.10.jar:?]
    	at net.fabricmc.loader.launch.knot.KnotClient.main(KnotClient.java:23) [quilt-loader-0.16.0-beta.10.jar:?]
    	at net.fabricmc.devlaunchinjector.Main.main(Main.java:86) [dev-launch-injector-0.2.1+build.8.jar:?]
    

    Crashes for both Client and Server launch. I checked a fabric project I have installed and it still works, so it's not an issue with IDEA or Java, seemingly. Not sure if this is a Quilt Loader issue or a Example Mod issue, but I've not seen any other reports of it so I've put it here

    opened by cocona20xx 1
  • Add .gitattributes: QSL Edition

    Add .gitattributes: QSL Edition

    Succeeds #20; This fixes gradle.bat not being CRLF while making everything else LF/binary, but this time, it has a more complete .gitattributes based on Aurora's work on QSL;

    I'm curious to see if there are any missing spots to cover before merging!

    opened by EnnuiL 0
  • Change icon into a scary Missing Texture placeholder

    Change icon into a scary Missing Texture placeholder

    The goal here is to avoid the Permanent Placeholder trope by making the icon scary enough to make people actually take an action against it if it happens to be published on production. Child me used to terrified of Missing Textures, and now, I get to exploit that fear!

    (also, don't worry, even if the icon was a SCP, it would be Safe, I hope :P)

    opened by EnnuiL 0
  • Explain what the heck are Maven Groups in the README

    Explain what the heck are Maven Groups in the README

    While I do suggest the usage of the user's GitHub page as a replacement for one, there is one tiny issue:

    • Maven groups are never properly explained, confusing people in the process
    • The "use your GitHub page if you don't know what it is" trick may work, but it's not really explained, the association of it to Maven groups isn't strong, and it doesn't explain what are Maven groups
    • We need to explain Maven groups
    • That's all :P
    enhancement 
    opened by EnnuiL 0
  • Consider adopting a simple GitHub Action workflow

    Consider adopting a simple GitHub Action workflow

    I believe that it would be ideal to adopt a quite simple GH Action workflow that automatically uploads its artifacts for testing purposes; The question is: how exactly should it be done? I fear that the approach adopted by Fabric Example Mod might be a bit too complex, so I was thinking of adopting Boring Template's workflow as the template workflow, although with it being commented so it's more modification-friendly. Suggestion are welcome! i desperately need them

    enhancement 
    opened by EnnuiL 4
Owner
null
Use Quilt Mappings on Loom

Quilt Mappings on Loom The time has finally arrived! Quilt Mappings are now usable in Loom! Ever wanted to use mappings other than Yarn or MojMap? Qui

null 15 Dec 7, 2022
Template mod to make an addon mod for Create fabric.

Create Fabric Addon Template This template mod comes pre-configured for developing an addon mod for Create on Fabric. Setup For environment setup inst

null 14 Dec 29, 2022
Mindustry Java Mod Template

Mindustry Java Mod Template A Java Mindustry mod template that works on Android and PC. The Kotlin version of this mod can be seen here. Building for

IvyX 4 Oct 3, 2022
Official Elasticsearch Java Client

Elasticsearch Java Client The official Java client for Elasticsearch. Note: this project is still a work in progress. This client is meant to replace

elastic 230 Jan 8, 2023
Catogram - Experimental telegram client based on official Android sources

Catogram Experimental telegram client based on official Android sources Features: Message translator TGX Style of context menu VKUI Icons and inbuilt

null 188 Dec 17, 2022
ZerotierFix - An unofficial Zerotier Android client patched from official client

Zerotier Fix An unofficial Zerotier Android client patched from official client. Features Self-hosted Moon Support Add custom planet config via file a

KAAAsS 830 Jan 8, 2023
This is the official theme SDK for the FairPlayer Music Player for Android.

FairPlayer - Themes SDK This is the official theme SDK for the FairPlayer Music Player for Android. You can download the most recent version of FairPl

Mark Jivko 0 Jan 31, 2022
Patches for the old minecraft official launcher to add microsoft account support

MSA4Legacy Patches for the old minecraft official launcher to add microsoft account support My code here is quite atrocious in some parts (for example

Nep Nep 26 Nov 3, 2022
Official React Native client for FingerprintJS PRO. 100% accurate device identification for fraud detection.

FingerprintJS PRO React Native Official React Native module for 100% accurate device identification, created for the FingerprintJS Pro Server API. Thi

FingerprintJS 26 Nov 22, 2022
Official Java library for the DeepL language translation API.

DeepL Java Library The DeepL API is a language translation API that allows other computer programs to send texts and documents to DeepL's servers and

DeepL 26 Dec 29, 2022
A Java-based template project for the FastJ Game Engine.

FastJ Java Template Program Requirements Java 16 JDK Basic understanding of Java Initial Setup Download the Template You have a few options for gettin

Andrew Dey 13 May 15, 2022
The shortest possible maven template / quickstarter for Java 16

The shortest possible Java 16 maven quickstarter The shortest possible Apache Maven template for Java 16 usage git clone https://github.com/AdamBien/j

Adam Bien 6 Nov 8, 2021
Spring Cloud Netflix Hystrix Dashboard template resolution vulnerability CVE-2021-22053

CVE-2021-22053: Spring Cloud Netflix Hystrix Dashboard template resolution vulnerability Severity High Vendor Spring by VMware Description Application

SCSL 38 Dec 16, 2022
A boilerplate project designed to work as a template for new microservices and help you get in touch with various useful concepts.

Microservice Reference Project This project is inspired by the idea to quickly create a production ready project with all the required infrastructure

Innovation & Tech 4 Dec 17, 2022
Template to speed up your development in React Native projects.

React Native SpaceShip I created this template with the purpose of leaving the development environment already configured for use. ?? How to use it in

Lucas Augusto 3 Mar 23, 2022
With this template, you are ste to deploy your application to Heroku

Template for deployment With this template, you are ste to deploy your application to Heroku. I´m using a Spring backend, React JS Frontend with Mongo

Thomas Kittlaus 4 Jun 23, 2022
A Spigot latest maven starter template.

NAME One sentence to describe your plugin. Introduction Describe your plugin clearly. Features Feature 1 Dependencies Commands /command Command functi

Katorly Lab 3 Jul 1, 2022
A template repository for new extensions.

SAP CX Template The sapcxtemplate extension improves ... FEATURE DESCRIPTION COPY-TEXT INTRODUCTION How to activate and use COPY-TEXT ACTIVATION / SET

SAP CX Tools 3 Dec 15, 2022
JavaFX or Swing + jpackage + Maven template project for generating native desktop applications.

Java + Maven + GitHub Actions = Native Desktop Apps JavaFX or Swing + jpackage + Maven template project for generating native desktop applications. Go

Will Iverson 243 Dec 24, 2022