1.21, the rest of the owl

Author: Kamefrede

.github/workflows/gradle.yml

@@ -11,7 +11,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '17'
+          java-version: '21'
 
       - name: Validate gradlew integrity
         uses: gradle/actions/wrapper-validation@v3
@@ -24,19 +24,23 @@ jobs:
             ~/.gradle/wrapper
             ./.gradle/loom-cache/remapped-mods
             ./build/moddev
-          key: ${{ runner.os }}-gradle-${{ hashFiles('**/build.gradle', './build.properties', './settings.gradle', '**/gradle-wrapper.properties') }}
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/build.gradle', './gradle.properties', './settings.gradle', '**/gradle-wrapper.properties') }}
 
       - name: Calculate artifact names
         id: calculate_artifact_names
         run: |
-          MC=$(awk -F '=' '/mc_version/ { print $2; }' build.properties)
-          BUILD=$(awk -F '=' '/build_number/ { print $2; }' build.properties)
+          MC=$(awk -F '=' '/mc_version/ { print $2; }' gradle.properties)
+          BUILD=$(awk -F '=' '/build_number/ { print $2; }' gradle.properties)
           echo "forge=build/libs/Psi-${MC}-${BUILD}.jar" >> "$GITHUB_OUTPUT"
 
-      - name: Build with Gradle
+      - name: Lint files
+        run : |
+          ./gradlew checkSyntax
+
+      - name: Build
         run: |
           RELEASE_MODE=${{ startsWith(github.ref, 'refs/tags/release-') && '1' || '0' }} \
-          ./gradlew pmdMain spotlessJavaCheck build
+          ./gradlew build
 
       - name: PMD report
         uses: jwgmeligmeyling/pmd-github-action@v1

build.gradle

@@ -3,15 +3,12 @@ plugins {
     id 'eclipse'
     id 'idea'
     id 'maven-publish'
+    id 'pmd'
+    id 'com.diffplug.spotless' version '7.0.3'
     id 'net.neoforged.gradle.userdev' version '7.0.152'
 }
 
 tasks.named('wrapper', Wrapper).configure {
-    // Define wrapper values here so as to not have to always do so when updating gradlew.properties.
-    // Switching this to Wrapper.DistributionType.ALL will download the full gradle sources that comes with
-    // documentation attached on cursor hover of gradle classes and methods. However, this comes with increased
-    // file size for Gradle. If you do switch this to ALL, run the Gradle wrapper task twice afterwards.
-    // (Verify by checking gradle/wrapper/gradle-wrapper.properties to see if distributionUrl now points to `-all`)
     distributionType = Wrapper.DistributionType.BIN
 }
 
@@ -35,33 +32,37 @@ base {
     archivesName = mod_id
 }
 
+spotless {
+    java {
+        target project.fileTree(dir: 'src/main/java/vazkii/psi', include: '**/*.java')
+        eclipse().configFile 'spotless/eclipseformat.xml'
+        removeUnusedImports()
+        importOrderFile 'spotless/eclipse.importorder'
+        replaceRegex 'Too much space after if', '(if|for|while|switch) +\\(', '$1('
+    }
+}
+
+pmd {
+    ruleSetFiles = files("spotless/pmd-ruleset.xml")
+}
+
+tasks.register('checkSyntax') {
+    dependsOn spotlessJavaCheck, pmdMain
+}
+
 // Mojang ships Java 21 to end users starting in 1.20.5, so mods should target Java 21.
 java.toolchain.languageVersion = JavaLanguageVersion.of(21)
 
 minecraft.accessTransformers.file file('src/main/resources/META-INF/accesstransformer.cfg')
 
-// Default run configurations.
-// These can be tweaked, removed, or duplicated as needed.
 runs {
-    // applies to all the run configs below
     configureEach {
-        // Recommended logging data for a userdev environment
-        // The markers can be added/remove as needed separated by commas.
-        // "SCAN": For mods scan.
-        // "REGISTRIES": For firing of registry events.
-        // "REGISTRYDUMP": For getting the contents of all registries.
         systemProperty 'forge.logging.markers', 'REGISTRIES'
-
-        // Recommended logging level for the console
-        // You can set various levels here.
-        // Please read: https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels
         systemProperty 'forge.logging.console.level', 'debug'
-
         modSource project.sourceSets.main
     }
 
     client {
-        // Comma-separated list of namespaces to load gametests from. Empty = all namespaces.
         systemProperty 'forge.enabledGameTestNamespaces', project.mod_id
     }
 
@@ -70,13 +71,6 @@ runs {
         programArgument '--nogui'
     }
 
-    // This run config launches GameTestServer and runs all registered gametests, then exits.
-    // By default, the server will crash when no gametests are provided.
-    // The gametest system is also enabled by default for other run configs under the /test command.
-    gameTestServer {
-        systemProperty 'forge.enabledGameTestNamespaces', project.mod_id
-    }
-
     data {
         // example of overriding the workingDirectory set in configureEach above, uncomment if you want to use it
         // workingDirectory project.file('run-data')
@@ -86,24 +80,12 @@ runs {
     }
 }
 
-// Include resources generated by data generators.
 sourceSets.main.resources { srcDir 'src/generated/resources' }
-
-// Sets up a dependency configuration called 'localRuntime'.
-// This configuration should be used instead of 'runtimeOnly' to declare
-// a dependency that will be present for runtime testing but that is
-// "optional", meaning it will not be pulled by dependents of this mod.
 configurations {
     runtimeClasspath.extendsFrom localRuntime
 }
 
 dependencies {
-    // Specify the version of Minecraft to use.
-    // Depending on the plugin applied there are several options. We will assume you applied the userdev plugin as shown above.
-    // The group for userdev is net.neoforged, the module name is neoforge, and the version is the same as the neoforge version.
-    // You can however also use the vanilla plugin (net.neoforged.gradle.vanilla) to use a version of Minecraft without the neoforge loader.
-    // And its provides the option to then use net.minecraft as the group, and one of; client, server or joined as the module name, plus the game version as version.
-    // For all intends and purposes: You can treat this dependency as if it is a normal library you would use.
     implementation "net.neoforged:neoforge:${neo_version}"
 
     // Example optional mod dependency with JEI
@@ -113,29 +95,11 @@ dependencies {
     // We add the full version to localRuntime, not runtimeOnly, so that we do not publish a dependency on it
     localRuntime "mezz.jei:jei-${minecraft_version}-neoforge:${jei_version}"
 
-    compileOnly "vazkii.patchouli:Patchouli:1.21-87-NEOFORGE:api"
-    runtimeOnly "vazkii.patchouli:Patchouli:1.21-87-NEOFORGE"
-
-    // Example mod dependency using a mod jar from ./libs with a flat dir repository
-    // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
-    // The group id is ignored when searching -- in this case, it is "blank"
-    // implementation "blank:coolmod-${mc_version}:${coolmod_version}"
-
-    // Example mod dependency using a file as dependency
-    // implementation files("libs/coolmod-${mc_version}-${coolmod_version}.jar")
-
-    // Example project dependency using a sister or child project:
-    // implementation project(":myproject")
-
-    // For more info:
-    // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html
-    // http://www.gradle.org/docs/current/userguide/dependency_management.html
+    compileOnly "vazkii.patchouli:Patchouli:${patchouli_version}-NEOFORGE:api"
+    runtimeOnly "vazkii.patchouli:Patchouli:${patchouli_version}-NEOFORGE"
 }
 
-// This block of code expands all declared replace properties in the specified resource targets.
-// A missing property will result in an error. Properties are expanded using ${} Groovy notation.
-// When "copyIdeResources" is enabled, this will also run before the game launches in IDE environments.
-// See https://docs.gradle.org/current/dsl/org.gradle.language.jvm.tasks.ProcessResources.html
+
 tasks.withType(ProcessResources).configureEach {
     var replaceProperties = [
             minecraft_version      : minecraft_version,
@@ -157,25 +121,11 @@ tasks.withType(ProcessResources).configureEach {
     }
 }
 
-// Example configuration to allow publishing using the maven-publish plugin
-publishing {
-    publications {
-        register('mavenJava', MavenPublication) {
-            from components.java
-        }
-    }
-    repositories {
-        maven {
-            url "file://${project.projectDir}/repo"
-        }
-    }
-}
 
 tasks.withType(JavaCompile).configureEach {
-    options.encoding = 'UTF-8' // Use the UTF-8 charset for Java compilation
+    options.encoding = 'UTF-8'
 }
 
-// IDEA no longer automatically downloads sources/javadoc jars for dependencies, so we need to explicitly enable the behavior.
 idea {
     module {
         downloadSources = true

build.properties

@@ -3,43 +3,23 @@ org.gradle.jvmargs=-Xmx1G
 org.gradle.daemon=false
 org.gradle.debug=false
 
-#read more on this at https://github.com/neoforged/NeoGradle/blob/NG_7.0/README.md#apply-parchment-mappings
-# you can also find the latest versions at: https://parchmentmc.org/docs/getting-started
 neogradle.subsystems.parchment.minecraftVersion=1.21.1
 neogradle.subsystems.parchment.mappingsVersion=2024.11.17
-# Environment Properties
-# You can find the latest versions here: https://projects.neoforged.net/neoforged/neoforge
-# The Minecraft version must agree with the Neo version to get a valid artifact
 minecraft_version=1.21.1
-# The Minecraft version range can use any release version of Minecraft as bounds.
-# Snapshots, pre-releases, and release candidates are not guaranteed to sort properly
-# as they do not follow standard versioning conventions.
 minecraft_version_range=[1.21.1,1.21.2)
-# The Neo version must agree with the Minecraft version to get a valid artifact
 neo_version=21.1.4
-# The Neo version range can use any version of Neo as bounds
 neo_version_range=[21.1.0,)
-# The loader version range can only use the major version of FML as bounds
 loader_version_range=[4,)
 
+# Dependencies
 jei_version=19.9.0.120
+patchouli_version=1.21-87
 
 ## Mod Properties
-
-# The unique mod identifier for the mod. Must be lowercase in English locale. Must fit the regex [a-z][a-z0-9_]{1,63}
-# Must match the String constant located in the main mod class annotated with @Mod.
 mod_id=psi
-# The human-readable display name for the mod.
 mod_name=Psi
-# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
-mod_license=All Rights Reserved
-# The mod version. See https://semver.org/
+mod_license=Psi License
 mod_version=1.21.1
-# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
-# This should match the base package used for the mod sources.
-# See https://maven.apache.org/guides/mini/guide-naming-conventions.html
-mod_group_id=com.example.examplemod
-# The authors of the mod. This is a simple text string that is used for display purposes in the mod list.
-mod_authors=YourNameHere, OtherNameHere
-# The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list.
-mod_description=Example mod description.\nNewline characters can be used and will be replaced properly.
+mod_group_id=vazkii.psi
+mod_authors=Vazkii, Wiiv, WireSegal, Kamefrede, Williewillus, Hubry, Dudblockman, TheidenHD
+mod_description=Psionic Spellcasting Instruments

gradle.properties

@@ -5,7 +5,7 @@
 
 def main():
     build = Properties()
-    with open("build.properties", "rb") as f:
+    with open("gradle.properties", "rb") as f:
         build.load(f, "utf-8")
 
     mc_version, mcv_meta = build["mc_version"]
@@ -39,7 +39,7 @@ def main():
         print("Created tag")
 
     build["build_number"] = str(int(build_number) + 1)
-    with open("build.properties", "wb") as f:
+    with open("gradle.properties", "wb") as f:
         build.store(f, encoding="utf-8")
 
     os.system("git commit -a -m build")

scripts/push_tag.py

@@ -21,37 +21,37 @@
 @OnlyIn(Dist.CLIENT)
 public class ClientPsiAPI {
 
-    //public static final ResourceLocation PSI_PIECE_TEXTURE_ATLAS = ResourceLocation.fromNamespaceAndPath(MOD_ID, "spell_pieces");
-    private static final Map<ResourceLocation, Material> simpleSpellTextures = new ConcurrentHashMap<>();
-
-    /**
-     * Register the texture of a piece
-     * <p>
-     * On Forge, call this at any time before registry events finish (e.g. during item registration).
-     * Note that common setup event is <em>too late</em>!
-     * <p>
-     * NB: Why the strange restriction? Because in 1.16.2+ forge, texture stitching, model baking, etc. go on
-     * <em>concurrently</em> with all setup events (client, common). So by then, it is way too late to tell the game
-     * to load these textures. Registry events are the final thing that runs serially until loading is done, so
-     * we have to receive all registrations by then. This makes the setup events, particularly the client one,
-     * pretty much useless for doing anything that interacts with the vanilla game. Awesome system design right there!
-     *
-     * @param pieceId ID of the piece whose texture to register
-     * @param texture Path to the piece's texture, where <code>domain:foo/bar</code> translates to
-     *                <code>/assets/domain/textures/foo/bar.png</code>.
-     *                In other words, do <b>not</b> prefix with textures/ nor suffix with .png.
-     */
-    @OnlyIn(Dist.CLIENT)
-    public static void registerPieceTexture(ResourceLocation pieceId, ResourceLocation texture) {
-        ClientPsiAPI.simpleSpellTextures.put(pieceId, new Material(TextureAtlas.LOCATION_BLOCKS, texture));
-    }
-
-    public static Material getSpellPieceMaterial(ResourceLocation key) {
-        return simpleSpellTextures.get(key);
-    }
-
-    public static Collection<Material> getAllSpellPieceMaterial() {
-        return simpleSpellTextures.values();
-    }
+	//public static final ResourceLocation PSI_PIECE_TEXTURE_ATLAS = ResourceLocation.fromNamespaceAndPath(MOD_ID, "spell_pieces");
+	private static final Map<ResourceLocation, Material> simpleSpellTextures = new ConcurrentHashMap<>();
+
+	/**
+	 * Register the texture of a piece
+	 * <p>
+	 * On Forge, call this at any time before registry events finish (e.g. during item registration).
+	 * Note that common setup event is <em>too late</em>!
+	 * <p>
+	 * NB: Why the strange restriction? Because in 1.16.2+ forge, texture stitching, model baking, etc. go on
+	 * <em>concurrently</em> with all setup events (client, common). So by then, it is way too late to tell the game
+	 * to load these textures. Registry events are the final thing that runs serially until loading is done, so
+	 * we have to receive all registrations by then. This makes the setup events, particularly the client one,
+	 * pretty much useless for doing anything that interacts with the vanilla game. Awesome system design right there!
+	 *
+	 * @param pieceId ID of the piece whose texture to register
+	 * @param texture Path to the piece's texture, where <code>domain:foo/bar</code> translates to
+	 *                <code>/assets/domain/textures/foo/bar.png</code>.
+	 *                In other words, do <b>not</b> prefix with textures/ nor suffix with .png.
+	 */
+	@OnlyIn(Dist.CLIENT)
+	public static void registerPieceTexture(ResourceLocation pieceId, ResourceLocation texture) {
+		ClientPsiAPI.simpleSpellTextures.put(pieceId, new Material(TextureAtlas.LOCATION_BLOCKS, texture));
+	}
+
+	public static Material getSpellPieceMaterial(ResourceLocation key) {
+		return simpleSpellTextures.get(key);
+	}
+
+	public static Collection<Material> getAllSpellPieceMaterial() {
+		return simpleSpellTextures.values();
+	}
 
 }