├── Example Mod ├── .env.example ├── .gitattributes ├── .gitignore ├── build.gradle.kts ├── gradle.properties ├── gradle │ └── wrapper │ │ ├── gradle-wrapper.jar │ │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle.kts └── src │ └── main │ ├── kotlin │ └── com │ │ └── mod_author │ │ └── mod_id │ │ └── ModName.kt │ └── resources │ ├── assets │ └── mod_name │ │ └── icon.png │ ├── fabric.mod.json │ └── mod_id.mixins.json ├── LICENSE └── README.md /Example Mod/.env.example: -------------------------------------------------------------------------------- 1 | CURSEFORGE_TOKEN= 2 | MODRINTH_TOKEN= -------------------------------------------------------------------------------- /Example Mod/.gitattributes: -------------------------------------------------------------------------------- 1 | /gradlew text eol=lf 2 | *.bat text eol=crlf -------------------------------------------------------------------------------- /Example Mod/.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle 2 | .gradle/ 3 | build/ 4 | out/ 5 | classes/ 6 | # Eclipse 7 | *.launch 8 | # IntelliJ IDEA 9 | .idea/ 10 | *.iml 11 | *.ipr 12 | *.iws 13 | # Visual Studio Code 14 | .settings/ 15 | .vscode/ 16 | bin/ 17 | .classpath 18 | .project 19 | # macOS 20 | *.DS_Store 21 | # Fabric 22 | run/ 23 | # Java 24 | hs_err_*.log 25 | replay_*.log 26 | *.hprof 27 | *.jfr 28 | # Kotlin 29 | .kotlin/ 30 | # Static Analysis 31 | .PVS-Studio/ 32 | # Security 33 | .env -------------------------------------------------------------------------------- /Example Mod/build.gradle.kts: -------------------------------------------------------------------------------- 1 | import net.darkhax.curseforgegradle.TaskPublishCurseForge 2 | import org.jetbrains.kotlin.gradle.dsl.JvmTarget 3 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 4 | plugins { 5 | id("fabric-loom") 6 | kotlin("jvm") 7 | id("com.modrinth.minotaur") 8 | id("net.darkhax.curseforgegradle") 9 | id("co.uzzu.dotenv.gradle") 10 | } 11 | base.archivesName = project.extra["archives_base_name"] as String 12 | version = project.extra["mod_version"] as String 13 | group = project.extra["maven_group"] as String 14 | dependencies { 15 | minecraft("com.mojang", "minecraft", project.extra["minecraft_version"] as String) 16 | mappings("net.fabricmc", "yarn", project.extra["yarn_mappings"] as String, null, "v2") 17 | modImplementation("net.fabricmc", "fabric-loader", project.extra["loader_version"] as String) 18 | modImplementation("net.fabricmc.fabric-api", "fabric-api", project.extra["fabric_version"] as String) 19 | modImplementation("net.fabricmc", "fabric-language-kotlin", project.extra["fabric_language_kotlin_version"] as String) 20 | } 21 | tasks { 22 | val javaVersion = JavaVersion.toVersion((project.extra["java_version"] as String).toInt()) 23 | withType().configureEach { 24 | options.encoding = "UTF-8" 25 | sourceCompatibility = javaVersion.toString() 26 | targetCompatibility = javaVersion.toString() 27 | options.release = javaVersion.toString().toInt() 28 | } 29 | withType().configureEach { defaultCharacterEncoding = "UTF-8" } 30 | withType().configureEach { options.encoding = "UTF-8" } 31 | withType().configureEach { defaultCharacterEncoding = "UTF-8" } 32 | withType().configureEach { 33 | compilerOptions { 34 | extraWarnings = true 35 | jvmTarget = JvmTarget.valueOf("JVM_$javaVersion") 36 | } 37 | } 38 | jar { from("LICENSE") { rename { "${it}_${base.archivesName.get()}" } } } 39 | processResources { 40 | filesMatching("fabric.mod.json") { expand(mutableMapOf("version" to project.extra["mod_version"] as String, "fabricloader" to project.extra["loader_version"] as String, "fabric_api" to project.extra["fabric_version"] as String, "fabric_language_kotlin" to project.extra["fabric_language_kotlin_version"] as String, "minecraft" to project.extra["minecraft_version"] as String, "java" to project.extra["java_version"] as String)) } 41 | filesMatching("*.mixins.json") { expand(mutableMapOf("java" to project.extra["java_version"] as String)) } 42 | } 43 | java { 44 | toolchain.languageVersion = JavaLanguageVersion.of(javaVersion.toString()) 45 | sourceCompatibility = javaVersion 46 | targetCompatibility = javaVersion 47 | withSourcesJar() 48 | } 49 | register("publishCurseForge") { 50 | disableVersionDetection() 51 | apiToken = env.fetch("CURSEFORGE_TOKEN", "") 52 | val file = upload("Replace this with the CurseForge project ID as an Integer", remapJar) 53 | file.displayName = "[${project.extra["minecraft_version"] as String}] Mod Name" 54 | file.addEnvironment("Client", "Server") 55 | file.changelog = "" 56 | file.releaseType = "release" 57 | file.addModLoader("Fabric") 58 | file.addGameVersion(project.extra["minecraft_version"] as String) 59 | } 60 | } 61 | modrinth { 62 | token.set(env.fetch("MODRINTH_TOKEN", "")) 63 | projectId.set("Replace this with the slug to the Modrinth mod page") 64 | uploadFile.set(tasks.remapJar) 65 | gameVersions.addAll(project.extra["minecraft_version"] as String) 66 | versionName.set("[${project.extra["minecraft_version"] as String}] Mod Name") 67 | dependencies { required.project("fabric-api", "fabric-language-kotlin") } 68 | } -------------------------------------------------------------------------------- /Example Mod/gradle.properties: -------------------------------------------------------------------------------- 1 | ########################################################################## 2 | # Standard Properties 3 | kotlin.code.style = official 4 | org.gradle.jvmargs = -Xmx1G 5 | org.gradle.warning.mode = all 6 | ########################################################################## 7 | # Standard Fabric Dependencies 8 | # Check these on https://fabricmc.net/develop/ 9 | minecraft_version = 1.21.5 10 | yarn_mappings = 1.21.5+build.1 11 | loader_version = 0.16.14 12 | # Fabric API 13 | fabric_version = 0.121.0+1.21.5 14 | loom_version = 1.10-SNAPSHOT 15 | java_version = 21 16 | ########################################################################## 17 | # Mod Properties 18 | mod_version = 1.0.0 19 | maven_group = com.author 20 | archives_base_name = mod-name 21 | ########################################################################## 22 | # Kotlin Dependencies 23 | # Check this on https://kotlinlang.org/docs/releases.html 24 | kotlin_version = 2.1.20 25 | # Check this on https://www.curseforge.com/minecraft/mc-mods/fabric-language-kotlin/ 26 | fabric_language_kotlin_version = 1.13.2+kotlin.2.1.20 27 | ########################################################################## 28 | # Automatic Mod Upload Plugins 29 | # Check this on https://plugins.gradle.org/plugin/com.modrinth.minotaur/ 30 | minotaur_version = 2.8.7 31 | # Check this on https://plugins.gradle.org/plugin/net.darkhax.curseforgegradle/ 32 | curseforge_gradle_version = 1.1.26 33 | # Check this on https://plugins.gradle.org/plugin/co.uzzu.dotenv.gradle/ 34 | dotenv_version = 4.0.0 35 | ########################################################################## -------------------------------------------------------------------------------- /Example Mod/gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SmushyTaco/Example-Mod/7d31c7a4d6246ebf53f00dd8b6f3d1542f1cd238/Example Mod/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /Example Mod/gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Check this on https://gradle.org/releases/ 2 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-all.zip 3 | distributionBase=GRADLE_USER_HOME 4 | distributionPath=wrapper/dists 5 | zipStorePath=wrapper/dists 6 | zipStoreBase=GRADLE_USER_HOME -------------------------------------------------------------------------------- /Example Mod/gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s 90 | ' "$PWD" ) || exit 91 | 92 | # Use the maximum available, or set MAX_FD != -1 to use that value. 93 | MAX_FD=maximum 94 | 95 | warn () { 96 | echo "$*" 97 | } >&2 98 | 99 | die () { 100 | echo 101 | echo "$*" 102 | echo 103 | exit 1 104 | } >&2 105 | 106 | # OS specific support (must be 'true' or 'false'). 107 | cygwin=false 108 | msys=false 109 | darwin=false 110 | nonstop=false 111 | case "$( uname )" in #( 112 | CYGWIN* ) cygwin=true ;; #( 113 | Darwin* ) darwin=true ;; #( 114 | MSYS* | MINGW* ) msys=true ;; #( 115 | NONSTOP* ) nonstop=true ;; 116 | esac 117 | 118 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 119 | 120 | 121 | # Determine the Java command to use to start the JVM. 122 | if [ -n "$JAVA_HOME" ] ; then 123 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 124 | # IBM's JDK on AIX uses strange locations for the executables 125 | JAVACMD=$JAVA_HOME/jre/sh/java 126 | else 127 | JAVACMD=$JAVA_HOME/bin/java 128 | fi 129 | if [ ! -x "$JAVACMD" ] ; then 130 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 131 | 132 | Please set the JAVA_HOME variable in your environment to match the 133 | location of your Java installation." 134 | fi 135 | else 136 | JAVACMD=java 137 | if ! command -v java >/dev/null 2>&1 138 | then 139 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 140 | 141 | Please set the JAVA_HOME variable in your environment to match the 142 | location of your Java installation." 143 | fi 144 | fi 145 | 146 | # Increase the maximum file descriptors if we can. 147 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 148 | case $MAX_FD in #( 149 | max*) 150 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 151 | # shellcheck disable=SC2039,SC3045 152 | MAX_FD=$( ulimit -H -n ) || 153 | warn "Could not query maximum file descriptor limit" 154 | esac 155 | case $MAX_FD in #( 156 | '' | soft) :;; #( 157 | *) 158 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 159 | # shellcheck disable=SC2039,SC3045 160 | ulimit -n "$MAX_FD" || 161 | warn "Could not set maximum file descriptor limit to $MAX_FD" 162 | esac 163 | fi 164 | 165 | # Collect all arguments for the java command, stacking in reverse order: 166 | # * args from the command line 167 | # * the main class name 168 | # * -classpath 169 | # * -D...appname settings 170 | # * --module-path (only if needed) 171 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 172 | 173 | # For Cygwin or MSYS, switch paths to Windows format before running java 174 | if "$cygwin" || "$msys" ; then 175 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 176 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 177 | 178 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 179 | 180 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 181 | for arg do 182 | if 183 | case $arg in #( 184 | -*) false ;; # don't mess with options #( 185 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 186 | [ -e "$t" ] ;; #( 187 | *) false ;; 188 | esac 189 | then 190 | arg=$( cygpath --path --ignore --mixed "$arg" ) 191 | fi 192 | # Roll the args list around exactly as many times as the number of 193 | # args, so each arg winds up back in the position where it started, but 194 | # possibly modified. 195 | # 196 | # NB: a `for` loop captures its iteration list before it begins, so 197 | # changing the positional parameters here affects neither the number of 198 | # iterations, nor the values presented in `arg`. 199 | shift # remove old arg 200 | set -- "$@" "$arg" # push replacement arg 201 | done 202 | fi 203 | 204 | 205 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 206 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 207 | 208 | # Collect all arguments for the java command: 209 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 210 | # and any embedded shellness will be escaped. 211 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 212 | # treated as '${Hostname}' itself on the command line. 213 | 214 | set -- \ 215 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 216 | -classpath "$CLASSPATH" \ 217 | org.gradle.wrapper.GradleWrapperMain \ 218 | "$@" 219 | 220 | # Stop when "xargs" is not available. 221 | if ! command -v xargs >/dev/null 2>&1 222 | then 223 | die "xargs is not available" 224 | fi 225 | 226 | # Use "xargs" to parse quoted args. 227 | # 228 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 229 | # 230 | # In Bash we could simply go: 231 | # 232 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 233 | # set -- "${ARGS[@]}" "$@" 234 | # 235 | # but POSIX shell has neither arrays nor command substitution, so instead we 236 | # post-process each arg (as a line of input to sed) to backslash-escape any 237 | # character that might be a shell metacharacter, then use eval to reverse 238 | # that process (while maintaining the separation between arguments), and wrap 239 | # the whole thing up as a single "set" statement. 240 | # 241 | # This will of course break if any of these variables contains a newline or 242 | # an unmatched quote. 243 | # 244 | 245 | eval "set -- $( 246 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 247 | xargs -n1 | 248 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 249 | tr '\n' ' ' 250 | )" '"$@"' 251 | 252 | exec "$JAVACMD" "$@" -------------------------------------------------------------------------------- /Example Mod/gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 74 | 75 | 76 | @rem Execute Gradle 77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 78 | 79 | :end 80 | @rem End local scope for the variables with windows NT shell 81 | if %ERRORLEVEL% equ 0 goto mainEnd 82 | 83 | :fail 84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 85 | rem the _cmd.exe /c_ return code! 86 | set EXIT_CODE=%ERRORLEVEL% 87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 89 | exit /b %EXIT_CODE% 90 | 91 | :mainEnd 92 | if "%OS%"=="Windows_NT" endlocal 93 | 94 | :omega -------------------------------------------------------------------------------- /Example Mod/settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = settings.extra["archives_base_name"] as String 2 | pluginManagement { 3 | repositories { 4 | maven("https://maven.fabricmc.net") { name = "Fabric" } 5 | mavenCentral() 6 | gradlePluginPortal() 7 | } 8 | plugins { 9 | id("fabric-loom").version(settings.extra["loom_version"] as String) 10 | kotlin("jvm").version(settings.extra["kotlin_version"] as String) 11 | id("com.modrinth.minotaur").version(settings.extra["minotaur_version"] as String) 12 | id("net.darkhax.curseforgegradle").version(settings.extra["curseforge_gradle_version"] as String) 13 | id("co.uzzu.dotenv.gradle").version(settings.extra["dotenv_version"] as String) 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /Example Mod/src/main/kotlin/com/mod_author/mod_id/ModName.kt: -------------------------------------------------------------------------------- 1 | package com.mod_author.mod_id 2 | import net.fabricmc.api.ModInitializer 3 | @Suppress("UNUSED") 4 | object ModName: ModInitializer { 5 | private const val MOD_ID = "mod_id" 6 | override fun onInitialize() { 7 | println("Example mod has been initialized.") 8 | } 9 | } -------------------------------------------------------------------------------- /Example Mod/src/main/resources/assets/mod_name/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SmushyTaco/Example-Mod/7d31c7a4d6246ebf53f00dd8b6f3d1542f1cd238/Example Mod/src/main/resources/assets/mod_name/icon.png -------------------------------------------------------------------------------- /Example Mod/src/main/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "mod_id", 4 | "version": "${version}", 5 | "name": "Mod Name", 6 | "description": "Mod Description", 7 | "authors": [ 8 | "Author" 9 | ], 10 | "contact": { 11 | "homepage": "https://example.com/", 12 | "issues": "https://example.com/", 13 | "sources": "https://example.com/" 14 | }, 15 | "license": "The Unlicense", 16 | "icon": "assets/mod_name/icon.png", 17 | "environment": "*", 18 | "entrypoints": { 19 | "main": [ 20 | { 21 | "adapter": "kotlin", 22 | "value": "com.mod_author.mod_id.ModName" 23 | } 24 | ] 25 | }, 26 | "mixins": [ 27 | "mod_id.mixins.json" 28 | ], 29 | "depends": { 30 | "fabricloader": ">=${fabricloader}", 31 | "fabric-api": ">=${fabric_api}", 32 | "fabric-language-kotlin": ">=${fabric_language_kotlin}", 33 | "minecraft": ">=${minecraft}", 34 | "java": ">=${java}" 35 | } 36 | } -------------------------------------------------------------------------------- /Example Mod/src/main/resources/mod_id.mixins.json: -------------------------------------------------------------------------------- 1 | { 2 | "required": true, 3 | "package": "com.mod_author.mod_id.mixins", 4 | "compatibilityLevel": "JAVA_${java}", 5 | "injectors": { 6 | "defaultRequire": 1 7 | }, 8 | "mixins": [] 9 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | This is free and unencumbered software released into the public domain. 2 | 3 | Anyone is free to copy, modify, publish, use, compile, sell, or 4 | distribute this software, either in source code form or as a compiled 5 | binary, for any purpose, commercial or non-commercial, and by any 6 | means. 7 | 8 | In jurisdictions that recognize copyright laws, the author or authors 9 | of this software dedicate any and all copyright interest in the 10 | software to the public domain. We make this dedication for the benefit 11 | of the public at large and to the detriment of our heirs and 12 | successors. We intend this dedication to be an overt act of 13 | relinquishment in perpetuity of all present and future rights to this 14 | software under copyright law. 15 | 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 | OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 | ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 | OTHER DEALINGS IN THE SOFTWARE. 23 | 24 | For more information, please refer to 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Example Mod 2 | This is an example mod for Kotlin. --------------------------------------------------------------------------------