From 0a9b240074f2d2d0ad40a9b2e58754bf9f17ed75 Mon Sep 17 00:00:00 2001 From: Ennui Langeweile <85590273+EnnuiL@users.noreply.github.com> Date: Wed, 20 Apr 2022 16:23:53 -0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Emma C. Pointer-Null --- .gitignore | 2 +- README.md | 7 ++++--- src/main/java/com/example/example_mod/ExampleMod.java | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 2dea676..785c6a7 100644 --- a/.gitignore +++ b/.gitignore @@ -23,5 +23,5 @@ bin/ .classpath .project -# MacOS +# macOS *.DS_Store diff --git a/README.md b/README.md index 4479745..09fea01 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Quilt Example Mod -The official Quilt example mod. You can use it as a template for you own mods! +The official Quilt example mod. You can use it as a template for your own mods! ## Usage @@ -10,12 +10,13 @@ In order to use this mod as a 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 `com.github.` + - 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.` - Update `quilt.mod.json` in order to reflect your mod's metadata - - If you are planning to include a mod, don't forget to declare its dependency on it! + - 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! + - 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! diff --git a/src/main/java/com/example/example_mod/ExampleMod.java b/src/main/java/com/example/example_mod/ExampleMod.java index acc77ee..efa94a3 100644 --- a/src/main/java/com/example/example_mod/ExampleMod.java +++ b/src/main/java/com/example/example_mod/ExampleMod.java @@ -7,7 +7,7 @@ import org.quiltmc.qsl.base.api.entrypoint.ModInitializer; public class ExampleMod implements ModInitializer { // This logger is used to write text to the console and the log file. - // It is considered best practice to use your mod id as the logger's name. + // It is considered best practice to use your mod name as the logger's name. // That way, it's clear which mod wrote info, warnings, and errors. public static final Logger LOGGER = LogManager.getLogger("Example Mod");