Skip to content

Commit

Permalink
metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
TropheusJ committed Oct 25, 2023
1 parent 6393b13 commit b6ec614
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 60 deletions.
29 changes: 2 additions & 27 deletions README.md
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.
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ org.gradle.jvmargs = -Xmx2G
org.gradle.parallel = true

# Metadata
maven_group = io.github.tropheusj
archives_base_name = modid
maven_group = io.github.fusionflux
archives_base_name = portalcubed
mod_version = 0.1.0

# Dependencies
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.github.tropheusj.modid;
package io.github.fusionflux.portalcubed;

import net.minecraft.resources.ResourceLocation;

Expand All @@ -7,8 +7,8 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ExampleMod implements ModInitializer {
public static final String ID = "modid";
public class PortalCubed implements ModInitializer {
public static final String ID = "portalcubed";
public static final Logger LOGGER = LoggerFactory.getLogger(ID);

@Override
Expand Down
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"required": true,
"minVersion": "0.8",
"package": "io.github.tropheusj.modid.mixin",
"package": "io.github.fusionflux.modid.mixin",
"compatibilityLevel": "JAVA_17",
"mixins": [
],
Expand Down
21 changes: 12 additions & 9 deletions src/main/resources/quilt.mod.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
{
"schema_version": 1,
"quilt_loader": {
"group": "io.github.tropheusj",
"id": "modid",
"group": "io.github.fusionflux",
"id": "portalcubed",
"version": "${version}",
"metadata": {
"name": "Modid",
"name": "Portal Cubed",
"description": "A short description of your mod.",
"contributors": {
"Tropheus Jay": "Owner"
"Fusion Flux": "Owner",
"Maximum": "Developer",
"TropheusJ": "Developer",
"Cart3r": "Artist"
},
"contact": {
"issues": "https://github.com/TropheusJ/quilt-template-mod/issues",
"sources": "https://github.com/TropheusJ/quilt-template-mod"
"issues": "https://github.com/Fusion-Flux/Portal-Cubed-Rewrite/issues",
"sources": "https://github.com/Fusion-Flux/Portal-Cubed-Rewrite"
},
"icon": "assets/modid/icon.png"
"icon": "assets/portalcubed/icon.png"
},
"intermediate_mappings": "net.fabricmc:intermediary",
"entrypoints": {
"init": "io.github.tropheusj.modid.ExampleMod"
"init": "io.github.fusionflux.portalcubed.PortalCubed"
},
"depends": [
{
Expand All @@ -35,5 +38,5 @@
}
]
},
"mixin": "modid.mixins.json"
"mixin": "portalcubed.mixins.json"
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package io.github.tropheusj.modid_test;
package io.github.fusionflux.portalcubed_test;

import net.minecraft.resources.ResourceLocation;

Expand All @@ -7,8 +7,8 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class ExampleModTest implements ModInitializer {
public static final String ID = "modid_test";
public class PortalCubedTestmod implements ModInitializer {
public static final String ID = "portalcubed_test";
public static final Logger LOGGER = LoggerFactory.getLogger(ID);

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
package io.github.tropheusj.modid_test.gametest;
package io.github.fusionflux.portalcubed_test.gametest;

import io.github.tropheusj.modid_test.ExampleModTest;
import net.fabricmc.fabric.api.gametest.v1.FabricGameTest;
import io.github.fusionflux.portalcubed_test.PortalCubedTestmod;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.world.entity.EntityType;
import net.minecraft.world.level.block.Blocks;

public class ExampleModGameTest implements FabricGameTest {
@GameTest(template = ExampleModTest.ID + ":minecart_test")
import org.quiltmc.qsl.testing.api.game.QuiltGameTest;

public class ExampleModGameTest implements QuiltGameTest {
@GameTest(template = PortalCubedTestmod.ID + ":minecart_test")
public void minecartTest(GameTestHelper helper) {
helper.setBlock(2, 2, 0, Blocks.REDSTONE_BLOCK);
helper.succeedWhenEntityPresent(EntityType.MINECART, 2, 2, 3);
Expand Down
19 changes: 9 additions & 10 deletions src/testmod/resources/quilt.mod.json
Original file line number Diff line number Diff line change
@@ -1,26 +1,25 @@
{
"schema_version": 1,
"quilt_loader": {
"group": "io.github.tropheusj",
"id": "modid_test",
"group": "io.github.fusionflux",
"id": "portalcubed_test",
"version": "1.0.0",
"metadata": {
"name": "Modid Test",
"name": "Portal Cubed Test",
"description": "A short description of your mod.",
"contributors": {
"Tropheus Jay": "Owner"
},
"contact": {
"issues": "https://github.com/TropheusJ/quilt-template-mod/issues",
"sources": "https://github.com/TropheusJ/quilt-template-mod"
"issues": "https://github.com/Fusion-Flux/Portal-Cubed-Rewrite/issues",
"sources": "https://github.com/Fusion-Flux/Portal-Cubed-Rewrite"
},
"icon": "assets/modid_test/icon.png"
"icon": "assets/portalcubed_test/icon.png"
},
"intermediate_mappings": "net.fabricmc:intermediary",
"entrypoints": {
"init": "io.github.tropheusj.modid_test.ExampleModTest",
"fabric-gametest": [
"io.github.tropheusj.modid_test.gametest.ExampleModGameTest"
"init": "io.github.fusionflux.portalcubed_test.PortalCubedTestmod",
"quilt:game_test": [
"io.github.fusionflux.portalcubed_test.gametest.ExampleModGameTest"
]
}
}
Expand Down

0 comments on commit b6ec614

Please sign in to comment.