Initial commit

Author: crosby-moe

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+# Automatically build the project and run any configured tests for every push
+# and submitted pull request. This can help catch issues that only occur on
+# certain Java versions, and provides a first line of defence against bad commits.
+
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: 21
+
+      - name: Build with Gradle
+        run: ./gradlew build
+
+      - name: Upload a Build Artifact
+        uses: actions/upload-artifact@v4
+        with: 
+          name: template-mod
+          path: build/libs/*.jar

.gitignore

@@ -0,0 +1,27 @@
+# gradle
+.gradle/
+build/
+out/
+classes/
+
+# eclipse
+*.launch
+
+# idea
+.idea/
+*.iml
+*.ipr
+*.iws
+
+# vscode
+.settings/
+.vscode/
+bin/
+.classpath
+.project
+
+# fabric
+run/
+
+# macos
+*.DS_Store

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -0,0 +1,71 @@
+# Legacy Fabric Template Mod
+
+- [Quick start guide](#quick-start-guide)
+  - [Introduction to the folder structure](#introduction-to-the-folder-structure)
+  - [Creating your mod](#creating-your-mod)
+  - [Useful gradle commands](#useful-gradle-commands)
+- [More info](#more-info)
+- [License](#license)
+
+## Quick start guide
+
+### Introduction to the folder structure
+
+**Build files:**
+
+| File                  | Description                                              |
+|-----------------------| -------------------------------------------------------- |
+| `build.gradle.kts`    | Configures the compilation process.                      |
+| `gradle.properties`   | Contains properties for Minecraft, fabric, and your mod. |
+| `settings.gradle.kts` | Configures the plugin repositories.                      |
+
+**Fabric files:**
+
+These files are located at `src/main/resources`.
+
+| File                       | Description                              | Additional information                                                                                                |
+|----------------------------| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `fabric.mod.json`          | Contains metadata about your mod.        | [wiki:fabric_mod_json_spec](https://fabricmc.net/wiki/documentation:fabric_mod_json_spec)                             |
+| `template-mod.mixins.json` | Contains a list of all your mixin files. | [wiki:mixin_registration](https://fabricmc.net/wiki/tutorial:mixin_registration)                                      |
+| `assets/template/icon.png` | The icon of your mod.                    | [wiki:fabric_mod_json_spec#icon](https://fabricmc.net/wiki/documentation:fabric_mod_json_spec?s[]=icon#custom_fields) |
+
+
+### Creating your mod
+
+First of you must replace all occurrences of `template-mod` with the id of your mod.
+
+If your mod doesn't use mixins you can safely remove the mixin entry in your `fabric.mod.json` as well as delete any `*.mixin.json` files.
+
+This template has the legacy fabric api included in its build script, more info about the api can be found at it's [github repo](https://github.com/Legacy-Fabric/fabric).
+If you know what you are doing you can also safely remove the api from the build script as it isn't required.
+
+### Useful gradle commands
+
+```sh
+# Compile your mod
+./gradlew build
+
+# Remove old build files
+./gradlew clean
+
+# Generate Minecraft sources
+./gradlew genSourcesWithVineflower
+
+# Launch a modded Minecraft client
+./gradlew runClient
+
+# Kill gradle if it's doing stupid things
+./gradlew --stop
+```
+
+## More info
+
+Additional tutorials and tips can be found in the [wiki](https://github.com/Legacy-Fabric/fabric-example-mod/wiki).
+
+For more detailed setup instructions please see the [fabric wiki](https://fabricmc.net/wiki/tutorial:setup).
+
+If you are new to fabric or Minecraft modding in general then [this wiki page](https://fabricmc.net/wiki/tutorial:primer) may help you.
+
+## License
+
+This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.

build.gradle.kts

@@ -0,0 +1,86 @@
+plugins {
+	id("fabric-loom") version "1.9-SNAPSHOT"
+	id("legacy-looming") version "1.9-SNAPSHOT" // Version must be the same as fabric-loom's
+}
+
+base {
+	archivesName = properties["archives_base_name"] as String
+	version = properties["mod_version"] as String
+	group = properties["maven_group"] as String
+}
+
+repositories {
+	// Add repositories to retrieve artifacts from in here.
+	// You should only use this when depending on other mods because
+	// Loom adds the essential maven repositories to download Minecraft and libraries from automatically.
+	// See https://docs.gradle.org/current/userguide/declaring_repositories.html
+	// for more information about repositories.
+}
+
+legacyLooming {
+	// 	The generation of intermediary to use, default is 1.
+	// 	legacy.yarn() will automatically point at the variant for the set intermediary generation.
+	// 	However do not forget to set the right build number of legacy yarn as they are different per variant.
+	//	intermediaryVersion = 2
+
+	// 	Wether to use Legacy Fabric intermediaries or Upstream/Official FabricMC ones.
+	//	Default to true: use Legacy Fabric intermediaries.
+	// 	If setting to false, don't forget to also set intermediaryVersion to generation 2.
+	//	useLFIntermediary.set(false)
+}
+
+dependencies {
+	minecraft("com.mojang:minecraft:${properties["minecraft_version"] as String}")
+	mappings(legacy.yarn(properties["minecraft_version"] as String, properties["yarn_build"] as String))
+	modImplementation("net.fabricmc:fabric-loader:${properties["loader_version"] as String}")
+
+	// Legacy Fabric API provides hooks for events, item registration, and more. As most mods will need this, it's included by default.
+	// If you know for a fact you don't, it's not required and can be safely removed.
+	// As of September 2024, available for MC 1.6.4, 1.7.10, 1.8, 1.8.9, 1.9.4, 1.10.2, 1.11.2 and 1.12.2.
+	// As of September 2024, available only for intermediary generation 1.
+	modImplementation("net.legacyfabric.legacy-fabric-api:legacy-fabric-api:${properties["fabric_version"] as String}")
+
+	// You can retrieve a specific api module using this notation.
+	// modImplementation(legacy.apiModule("legacy-fabric-item-groups-v1", properties["fabric_version"] as String))
+}
+
+tasks {
+	processResources {
+		val properties = mapOf(
+			"version" to project.version
+		)
+
+		filteringCharset = "UTF-8"
+
+		inputs.properties(properties)
+
+		filesMatching("fabric.mod.json") {
+			expand(properties)
+		}
+	}
+
+	withType<JavaCompile> {
+		// Ensure that the encoding is set to UTF-8, no matter what the system default is
+		// this fixes some edge cases with special characters not displaying correctly
+		// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html
+		options.encoding = "UTF-8"
+		options.release = 8
+	}
+
+	java {
+		sourceCompatibility = JavaVersion.VERSION_1_8
+		targetCompatibility = JavaVersion.VERSION_1_8
+
+		// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
+		// if it is present.
+		// If you remove this line, sources will not be generated.
+		withSourcesJar()
+	}
+
+	jar {
+		val projectIdentifier = project.base.archivesName.get()
+		from("LICENSE") {
+			rename { "${it}_${projectIdentifier}" }
+		}
+	}
+}

gradle.properties

@@ -0,0 +1,18 @@
+# Done to increase the memory available to gradle.
+org.gradle.jvmargs=-Xmx2G
+org.gradle.configuration-cache=true
+
+# Fabric Properties
+# More versions available at: https://grayray75.github.io/LegacyFabric-Versions/
+minecraft_version = 1.8.9
+yarn_build = 551
+loader_version = 0.16.10
+
+# Legacy Fabric API
+# Also available for mc 1.6.4, 1.7.10, 1.8, 1.9.4, 1.10.2, 1.11.2 and 1.12.2
+fabric_version = 1.10.2+1.8.9
+
+# Mod Properties
+mod_version = 0.1.0
+maven_group = com.example
+archives_base_name = template-mod

gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists