generated from TropheusJ/quilt-template-mod
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
38 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,2 @@ | ||
# 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](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 | ||
|
||
This template on the TropheusJ GitHub is licensed under the [MIT license](./LICENSE). | ||
# Portal Cubed | ||
This is a rewrite of Portal Cubed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
2 changes: 1 addition & 1 deletion
2
src/main/resources/modid.mixins.json → src/main/resources/portalcubed.mixins.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 6 additions & 5 deletions
11
...did_test/gametest/ExampleModGameTest.java → ...bed_test/gametest/ExampleModGameTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters