Readme and changelog
This commit is contained in:
parent
d2f9cf30a5
commit
eb40fcfe5e
2 changed files with 14 additions and 22 deletions
36
README.md
36
README.md
|
@ -1,29 +1,21 @@
|
|||
# Quilt Template Mod
|
||||
# LimePot Quilt Template Mod
|
||||
|
||||
The official Quilt template mod. You can use it as a template for your own mods!
|
||||
Based on the official template mod, this mod is modified to preconfigure things like mod menu support that I normally add anyways to my mods.
|
||||
|
||||
## Usage
|
||||
|
||||
In order to use this mod as a template:
|
||||
### please note the below is for personal use, if you decide to use my template mod you do not need to use the unlicense.
|
||||
### Contributing:
|
||||
I wont tell you exactly how to contribute but I will say, you must cryptographically sign the [waiver](License/WAIVER) and include it in your first commit.
|
||||
|
||||
``gpg --no-version --armor --sign WAIVER``
|
||||
|
||||
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](https://choosealicense.com/).
|
||||
- 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](https://spdx.org/licenses/) 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](https://lambdaurora.dev/tools/import_quilt.html) should help you in this easy and quick process.
|
||||
4. The mod is now ready to be worked on!
|
||||
|
||||
## License
|
||||
I dedicate any and all copyright interest in this software to the
|
||||
public domain. I make this dedication for the benefit of the public at
|
||||
large and to the detriment of my heirs and successors. I intend this
|
||||
dedication to be an overt act of relinquishment in perpetuity of all
|
||||
present and future rights to this software under copyright law.
|
||||
|
||||
This template on the QuiltMC GitHub is licensed under the [Creative Common Zero v1.0 license](./LICENSE-TEMPLATE.md).
|
||||
|
||||
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.
|
||||
![pd-icon](https://user-images.githubusercontent.com/9313366/208296032-a39e4144-ab3d-4abc-af51-074d2ac678fe.png)
|
||||
See [Unlicense](https://unlicense.org).
|
||||
|
|
0
changelog.md
Normal file
0
changelog.md
Normal file
Loading…
Reference in a new issue