Apply suggestions from code review
Co-authored-by: Emma C. Pointer-Null <emmaffle@modrinth.com>
This commit is contained in:
parent
0068b2d93f
commit
0a9b240074
3 changed files with 6 additions and 5 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -23,5 +23,5 @@ bin/
|
||||||
.classpath
|
.classpath
|
||||||
.project
|
.project
|
||||||
|
|
||||||
# MacOS
|
# macOS
|
||||||
*.DS_Store
|
*.DS_Store
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Quilt Example Mod
|
# 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
|
## Usage
|
||||||
|
|
||||||
|
@ -10,12 +10,13 @@ In order to use this mod as a template:
|
||||||
2. Clone the recently-created repo on your PC
|
2. Clone the recently-created repo on your PC
|
||||||
3. Make the necessary changes in order to make it yours:
|
3. Make the necessary changes in order to make it yours:
|
||||||
- Update `gradle.properties` in order to use your Maven group and mod ID
|
- 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.<Your_Username_Here>`
|
- 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
|
- 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
|
- 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/).
|
- 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!
|
- 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
|
- 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.
|
- 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!
|
4. The mod is now ready to be worked on!
|
||||||
|
|
|
@ -7,7 +7,7 @@ import org.quiltmc.qsl.base.api.entrypoint.ModInitializer;
|
||||||
|
|
||||||
public class ExampleMod implements ModInitializer {
|
public class ExampleMod implements ModInitializer {
|
||||||
// This logger is used to write text to the console and the log file.
|
// 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.
|
// That way, it's clear which mod wrote info, warnings, and errors.
|
||||||
public static final Logger LOGGER = LogManager.getLogger("Example Mod");
|
public static final Logger LOGGER = LogManager.getLogger("Example Mod");
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue