Initial commit

2025-12-10 10:36:14 +00:00 · 2020-03-21 17:18:43 +01:00
commit db569b1bdd
14 changed files with 622 additions and 0 deletions
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -0,0 +1,60 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: circleci/openjdk:8-jdk
+    steps:
+      - checkout
+      - run:
+          name: Gradle Wapper に実行権限付与
+          command: sudo chmod +x ./gradlew
+      - restore_cache:
+          name: ビルド環境をキャッシュから復元
+          keys:
+            - jars-{{ checksum "build.gradle.kts" }}
+            - jars-
+      - run:
+          name: ビルド
+          command: ./gradlew setupCiWorkspace build
+      - save_cache:
+          name: ビルド環境をキャッシュに保存
+          paths:
+            - ~/.gradle
+          key: jars-{{ checksum "build.gradle.kts" }}
+      - store_artifacts:
+          path: build/libs
+      - persist_to_workspace:
+          root: .
+          paths:
+            - build/libs
+
+  release:
+    docker:
+      - image: circleci/golang:1.8
+    steps:
+      - attach_workspace:
+          at: .
+      - run:
+          name: "GitHub Release に Zip をアップロード"
+          command: |
+            go get github.com/tcnksm/ghr
+            ghr -t ${GITHUB_TOKEN} -u ${CIRCLE_PROJECT_USERNAME} -r ${CIRCLE_PROJECT_REPONAME} -c ${CIRCLE_SHA1} \
+              -n "ver${CIRCLE_TAG}" -delete -draft ${CIRCLE_TAG} build/libs/
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - build:
+          filters:
+            tags:
+              only: /.*/
+      - release:
+          requires:
+            - build
+          filters:
+            branches:
+              ignore: /.*/
+            tags:
+              only: /.*/
--- a/.editorconfig
+++ b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1,18 @@
+# Gradle
+.gradle/
+build/
+
+# Forge Gradle
+run/
+
+# InteliJ
+.idea/**/dictionaries
+.idea/**/libraries
+.idea/**/gradle.xml
+.idea/**/tasks.xml
+.idea/**/workspace.xml
+out/
+*.iml
+
+# Visual Studio Code
+.history/
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EntryPointsManager">
+    <list size="4">
+      <item index="0" class="java.lang.String" itemvalue="net.minecraftforge.fml.common.Mod" />
+      <item index="1" class="java.lang.String" itemvalue="net.minecraftforge.fml.common.Mod.EventBusSubscriber" />
+      <item index="2" class="java.lang.String" itemvalue="net.minecraftforge.fml.common.Mod.EventHandler" />
+      <item index="3" class="java.lang.String" itemvalue="net.minecraftforge.fml.common.eventhandler.SubscribeEvent" />
+    </list>
+  </component>
+  <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8" project-jdk-type="JavaSDK">
+    <output url="file://$PROJECT_DIR$/out" />
+  </component>
+</project>
--- a/.idea/vcs.xml
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
--- a/README.md
+++ b/README.md
@@ -0,0 +1,61 @@
+# Minecraft Forge Kotlin Template
+Minecraft 1.12.2 で Forge と Kotlin を用いた Mod のテンプレートです。  
+Minecraft 1.12.2 Mod template using Forge and Kotlin.  
+
+## Getting Started
+### Clone template
+Please click [Use this template](https://github.com/proudust/minecraft-forge-kotlin-template/generate)
+
+or
+
+```sh
+git clone --depth=1 https://github.com/proudust/minecraft-forge-kotlin-template <your_project_name>
+cd <your_project_name>
+rm -rf .git
+```
+
+### Install dependencies
+```sh
+./gradlew build
+```
+
+### Fix properties
+**gradle.properties**
+```
+modGroup=<your_package_name>
+modVersion=<your_project_version>
+modBaseName=<your_project_name>
+```
+
+**mcmod.info**
+```json
+{
+    "modid": "<your_package_name>",
+    "name": "<Your Project Name>",
+}
+```
+
+**MinecraftForgeKotlinTemplate.kt**
+```kt
+package <your_package_name>.<your_project_name>
+
+//...
+
+object <YourProjectName> {
+    const val MOD_ID = <your_project_name>
+    const val MOD_NAME = <Your Project Name>
+    const val VERSION = <your_project_version>
+
+    //...
+}
+```
+
+## Dependencies
+
+- [Minecraft Forge](https://files.minecraftforge.net/)
+- [shadowfacts/Forgelin](https://github.com/shadowfacts/Forgelin)
+
+## References
+
+- [C6H2Cl2/MCDevNightSample](https://github.com/C6H2Cl2/MCDevNightSample)
+- [therealfarfetchd/build.gradle.kts](https://gist.github.com/therealfarfetchd/db8fc601df89703a360bccc0395ec590)
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -0,0 +1,78 @@
+import net.minecraftforge.gradle.user.UserBaseExtension
+import org.gradle.jvm.tasks.Jar
+
+// gradle.properties
+val modGroup: String by extra
+val modVersion: String by extra
+val modBaseName: String by extra
+val forgeVersion: String by extra
+val mappingVersion: String by extra
+
+buildscript {
+    repositories {
+        jcenter()
+        maven(url = "https://files.minecraftforge.net/maven") {
+            name = "forge"
+        }
+    }
+    dependencies {
+        classpath("net.minecraftforge.gradle:ForgeGradle:2.3-SNAPSHOT")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.50")
+    }
+}
+
+plugins {
+    java
+    scala
+}
+
+apply {
+    plugin("net.minecraftforge.gradle.forge")
+    plugin("kotlin")
+}
+
+version = modVersion
+group = modGroup
+
+configure<UserBaseExtension> {
+    version = forgeVersion
+    runDir = "run"
+
+    // the mappings can be changed at any time, and must be in the following format.
+    // snapshot_YYYYMMDD   snapshot are built nightly.
+    // stable_#            stables are built at the discretion of the MCP team.
+    // Use non-default mappings at your own risk. they may not always work.
+    // simply re-run your setup task after changing the mappings to update your workspace.
+    mappings = mappingVersion
+    // makeObfSourceJar = false // an Srg named sources jar is made by default. uncomment this to disable.
+}
+
+repositories {
+    jcenter()
+    mavenCentral()
+    maven(url = "http://maven.shadowfacts.net/")
+}
+
+dependencies {
+    compile("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.3.50")
+    compile("net.shadowfacts:Forgelin:1.8.4")
+}
+
+// processResources
+val Project.minecraft: UserBaseExtension
+    get() = extensions.getByName<UserBaseExtension>("minecraft")
+tasks.withType<Jar> {
+    // this will ensure that this task is redone when the versions change.
+    inputs.properties += "version" to project.version
+    inputs.properties += "mcversion" to project.minecraft.version
+
+    baseName = modBaseName
+
+    // replace stuff in mcmod.info, nothing else
+    filesMatching("/mcmod.info") {
+        expand(mapOf(
+            "version" to project.version,
+            "mcversion" to project.minecraft.version
+        ))
+    }
+}
--- a/gradle.properties
+++ b/gradle.properties
@@ -0,0 +1,5 @@
+modGroup=io.github.proudust
+modVersion=1.0-SNAPSHOT
+modBaseName=minecraft-forge-kotlin-template
+forgeVersion=1.12.2-14.23.5.2768
+mappingVersion=stable_39
--- a/gradle/wrapper/gradle-wrapper.jar
+++ b/gradle/wrapper/gradle-wrapper.jar
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4.1-bin.zip
--- a/172
+++ b/172
@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"
--- a/gradlew.bat
+++ b/gradlew.bat
@@ -0,0 +1,84 @@
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
--- a/src/main/kotlin/io/github/proudust/minecraftforgekotlintemplate/MinecraftForgeKotlinTemplate.kt
+++ b/src/main/kotlin/io/github/proudust/minecraftforgekotlintemplate/MinecraftForgeKotlinTemplate.kt
@@ -0,0 +1,84 @@
+package io.github.proudust.minecraftforgekotlintemplate
+
+import net.minecraft.block.Block
+import net.minecraft.item.Item
+import net.minecraftforge.event.RegistryEvent
+import net.minecraftforge.fml.common.Mod
+import net.minecraftforge.fml.common.event.FMLInitializationEvent
+import net.minecraftforge.fml.common.event.FMLPostInitializationEvent
+import net.minecraftforge.fml.common.event.FMLPreInitializationEvent
+import net.minecraftforge.fml.common.eventhandler.SubscribeEvent
+
+@Mod(
+    modid = MinecraftForgeKotlinTemplate.MOD_ID,
+    name = MinecraftForgeKotlinTemplate.MOD_NAME,
+    version = MinecraftForgeKotlinTemplate.VERSION,
+    modLanguageAdapter = "net.shadowfacts.forgelin.KotlinAdapter"
+)
+object MinecraftForgeKotlinTemplate {
+    const val MOD_ID = "minecraft-forge-kotlin-template"
+    const val MOD_NAME = "Minecraft Forge Kotlin Template"
+    const val VERSION = "2019.1-1.2.23"
+
+    /**
+     * This is the first initialization event. Register tile entities here.
+     * The registry events below will have fired prior to entry to this method.
+     */
+    @Mod.EventHandler
+    fun preinit(event: FMLPreInitializationEvent) {
+
+    }
+
+    /**
+     * This is the second initialization event. Register custom recipes
+     */
+    @Mod.EventHandler
+    fun init(event: FMLInitializationEvent) {
+
+    }
+
+    /**
+     * This is the final initialization event. Register actions from other mods here
+     */
+    @Mod.EventHandler
+    fun postinit(event: FMLPostInitializationEvent) {
+
+    }
+
+    /**
+     * This is a special class that listens to registry events, to allow creation of mod blocks and items at the proper time.
+     */
+    @Mod.EventBusSubscriber
+    object ObjectRegistryHandler {
+        /**
+         * Listen for the register event for creating custom items
+         */
+        @SubscribeEvent
+        fun addItems(event: RegistryEvent.Register<Item>) {
+            /*
+            event.registry.register(ItemBlock(MySpecialBlock).setRegistryName(MOD_ID, "myBlock"))
+            event.registry.register(MySpecialItem.setRegistryName(MOD_ID, "mySpecialItem"))
+            */
+        }
+
+        /**
+         * Listen for the register event for creating custom blocks
+         */
+        @SubscribeEvent
+        fun addBlocks(event: RegistryEvent.Register<Block>) {
+            /*
+            event.registry.register(MySpecialBlock.setRegistryName(MOD_ID, "mySpecialBlock"))
+            */
+        }
+    }
+
+    /* EXAMPLE ITEM AND BLOCK - you probably want these in separate files
+    object MySpecialItem : Item() {
+
+    }
+
+    object MySpecialBlock : Block() {
+
+    }
+    */
+}
--- a/src/main/resources/mcmod.info
+++ b/src/main/resources/mcmod.info
@@ -0,0 +1,19 @@
+[
+    {
+        "modid": "minecraft-forge-kotlin-template",
+        "name": "Minecraft Forge Kotlin Template",
+        "description": "injection point type '%s'",
+        "version": "${version}",
+        "mcversion": "${mcversion}",
+        "url": "",
+        "updateUrl": "",
+        "authorList": [],
+        "credits": "",
+        "logoFile": "",
+        "screenshots": [],
+        "requiredMods": [
+            "forgelin"
+        ],
+        "dependencies": []
+    }
+]