├── generated ├── kotlin_version.txt └── library_versions.json ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src ├── main │ ├── resources │ │ ├── assets │ │ │ └── fabric-language-kotlin │ │ │ │ └── icon500.png │ │ └── fabric.mod.json │ └── kotlin │ │ └── net │ │ └── fabricmc │ │ └── language │ │ └── kotlin │ │ ├── KotlinLanguageAdapter.kt │ │ └── KotlinAdapter.kt └── test │ └── kotlin │ └── net │ └── fabricmc │ └── language │ └── kotlin │ └── test │ ├── entrypoints │ ├── TopLevelEntrypoint.kt │ ├── ObjectFunctionEntrypoint.kt │ ├── CompanionFunctionEntrypoint.kt │ ├── ClassEntrypoint.kt │ ├── ObjectFieldEntrypoint.kt │ ├── ObjectClassEntrypoint.kt │ ├── CompanionFieldEntrypoint.kt │ └── CompanionClassEntrypoint.kt │ └── KotlinAdapterTest.kt ├── settings.gradle ├── gradle.properties ├── .gitignore ├── HEADER ├── .github └── workflows │ ├── push.yml │ ├── update.yml │ └── release.yml ├── .gitattributes ├── gradlew.bat ├── README.md ├── templates └── README.template.md ├── gradlew └── LICENSE /generated/kotlin_version.txt: -------------------------------------------------------------------------------- 1 | 2.2.21 -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FabricMC/fabric-language-kotlin/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/resources/assets/fabric-language-kotlin/icon500.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FabricMC/fabric-language-kotlin/HEAD/src/main/resources/assets/fabric-language-kotlin/icon500.png -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven { 4 | name = 'Fabric' 5 | url = 'https://maven.fabricmc.net/' 6 | } 7 | mavenCentral() 8 | gradlePluginPortal() 9 | } 10 | } 11 | 12 | rootProject.name = "fabric-language-kotlin" -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official 2 | org.gradle.jvmargs=-Xmx2G 3 | 4 | modId=fabric-language-kotlin 5 | modVersion=1.13.7 6 | minecraftVersion=1.20.2 7 | mappingsVersion=1.20.2+build.4 8 | loaderVersion=0.16.9 9 | group=net.fabricmc 10 | description=Fabric language module for Kotlin 11 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore everything 2 | /* 3 | 4 | # Folders 5 | !/gradle 6 | !/buildSrc 7 | !/src 8 | !/generated 9 | 10 | # Files 11 | !/.gitattributes 12 | !/.gitignore 13 | !/build.gradle 14 | !/gradle.properties 15 | !/gradlew 16 | !/gradlew.bat 17 | !/HEADER 18 | !/Jenkinsfile 19 | !/LICENSE 20 | !/README.md 21 | !/settings.gradle 22 | 23 | !/sample-mod 24 | !/templates/ 25 | !/.github/ 26 | 27 | build/ 28 | .gradle/ -------------------------------------------------------------------------------- /HEADER: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | -------------------------------------------------------------------------------- /.github/workflows/push.yml: -------------------------------------------------------------------------------- 1 | name: Run Tests 2 | on: [push, pull_request] 3 | jobs: 4 | gradle: 5 | strategy: 6 | matrix: 7 | java: [17, 21] 8 | runs-on: ubuntu-22.04 9 | steps: 10 | - uses: actions/setup-java@v3 11 | with: 12 | java-version: ${{ matrix.java }} 13 | distribution: 'temurin' 14 | - uses: actions/checkout@v3 15 | - name: 'Build' 16 | run: ./gradlew build publishMods --stacktrace --warning-mode=fail 17 | - name: 'Upload artifacts' 18 | if: ${{ matrix.java == '20' }} 19 | uses: actions/upload-artifact@v4 20 | with: 21 | name: Artifacts 22 | path: build/libs/ 23 | -------------------------------------------------------------------------------- /.github/workflows/update.yml: -------------------------------------------------------------------------------- 1 | name: Update Check 2 | on: 3 | workflow_dispatch: 4 | schedule: 5 | - cron: "0 0 * * *" 6 | jobs: 7 | build: 8 | runs-on: ubuntu-22.04 9 | steps: 10 | - uses: actions/checkout@v3 11 | - uses: actions/setup-java@v3 12 | with: 13 | java-version: 21 14 | distribution: 'temurin' 15 | - run: ./gradlew updateVersions 16 | - run: ./gradlew processMDTemplates 17 | - uses: peter-evans/create-pull-request@v6 18 | with: 19 | branch: update-versions 20 | title: Update versions 21 | author: github-actions <41898282+github-actions[bot]@users.noreply.github.com> 22 | commit-message: Update versions 23 | -------------------------------------------------------------------------------- /src/main/resources/fabric.mod.json: -------------------------------------------------------------------------------- 1 | { 2 | "schemaVersion": 1, 3 | "id": "fabric-language-kotlin", 4 | "version": "$version", 5 | "name": "Fabric Language Kotlin", 6 | "description": "Fabric language module for Kotlin.", 7 | "authors": [ 8 | "FabricMC" 9 | ], 10 | "contact": { 11 | "homepage": "https://minecraft.curseforge.com/projects/fabric-language-kotlin", 12 | "irc": "irc://irc.esper.net:6667/fabric", 13 | "issues": "https://github.com/FabricMC/fabric-language-kotlin/issues", 14 | "sources": "https://github.com/FabricMC/fabric-language-kotlin" 15 | }, 16 | "languageAdapters": { 17 | "kotlin": "net.fabricmc.language.kotlin.KotlinAdapter" 18 | }, 19 | "license": "Apache-2.0", 20 | "icon": "assets/fabric-language-kotlin/icon500.png", 21 | "depends": { 22 | "fabricloader": ">=0.16.9" 23 | } 24 | } -------------------------------------------------------------------------------- /generated/library_versions.json: -------------------------------------------------------------------------------- 1 | { 2 | "org.jetbrains.kotlin:kotlin-stdlib": "2.2.21", 3 | "org.jetbrains.kotlin:kotlin-stdlib-jdk8": "2.2.21", 4 | "org.jetbrains.kotlin:kotlin-stdlib-jdk7": "2.2.21", 5 | "org.jetbrains.kotlin:kotlin-reflect": "2.2.21", 6 | "org.jetbrains.kotlinx:kotlinx-coroutines-core": "1.10.2", 7 | "org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm": "1.10.2", 8 | "org.jetbrains.kotlinx:kotlinx-coroutines-jdk8": "1.10.2", 9 | "org.jetbrains.kotlinx:kotlinx-serialization-core-jvm": "1.9.0", 10 | "org.jetbrains.kotlinx:kotlinx-serialization-json-jvm": "1.9.0", 11 | "org.jetbrains.kotlinx:kotlinx-serialization-cbor-jvm": "1.9.0", 12 | "org.jetbrains.kotlinx:atomicfu-jvm": "0.29.0", 13 | "org.jetbrains.kotlinx:kotlinx-datetime-jvm": "0.7.1", 14 | "org.jetbrains.kotlinx:kotlinx-io-core-jvm": "0.8.0", 15 | "org.jetbrains.kotlinx:kotlinx-io-bytestring-jvm": "0.8.0" 16 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/TopLevelEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.loader.api.FabricLoader 20 | 21 | fun init() { 22 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 23 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/ObjectFunctionEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.loader.api.FabricLoader 20 | 21 | object ObjectFunctionEntrypoint { 22 | fun init() { 23 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 24 | } 25 | } -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Handle line endings automatically for files detected as text 2 | # and leave all files detected as binary untouched. 3 | * text=auto 4 | 5 | # 6 | # The above will handle all files NOT found below 7 | # 8 | # These files are text and should be normalized (Convert crlf => lf) 9 | *.css text 10 | *.df text 11 | *.htm text 12 | *.html text 13 | *.java text 14 | *.js text 15 | *.json text 16 | *.jsp text 17 | *.jspf text 18 | *.properties text 19 | *.sh text 20 | *.tld text 21 | *.txt text 22 | *.xml text 23 | 24 | # These files are binary and should be left untouched 25 | # (binary is a macro for -text -diff) 26 | *.class binary 27 | *.dll binary 28 | *.ear binary 29 | *.gif binary 30 | *.ico binary 31 | *.jar binary 32 | *.jpg binary 33 | *.jpeg binary 34 | *.png binary 35 | *.so binary 36 | *.war binary 37 | -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/CompanionFunctionEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.loader.api.FabricLoader 20 | 21 | class CompanionFunctionEntrypoint { 22 | companion object { 23 | fun init() { 24 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 25 | } 26 | } 27 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/ClassEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.loader.api.FabricLoader 21 | 22 | class ClassEntrypoint : ModInitializer { 23 | override fun onInitialize() { 24 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 25 | } 26 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/ObjectFieldEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.loader.api.FabricLoader 21 | 22 | object ObjectFieldEntrypoint { 23 | val initializer = ModInitializer { 24 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 25 | } 26 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/ObjectClassEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.loader.api.FabricLoader 21 | 22 | object ObjectClassEntrypoint : ModInitializer { 23 | override fun onInitialize() { 24 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 25 | } 26 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/CompanionFieldEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.loader.api.FabricLoader 21 | 22 | class CompanionFieldEntrypoint { 23 | companion object { 24 | val initializer = ModInitializer { 25 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/entrypoints/CompanionClassEntrypoint.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test.entrypoints 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.loader.api.FabricLoader 21 | 22 | class CompanionClassEntrypoint { 23 | companion object: ModInitializer { 24 | override fun onInitialize() { 25 | FabricLoader.getInstance().objectShare.put("fabric-language-kotlin:test", "true") 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: [workflow_dispatch] # Manual trigger 3 | jobs: 4 | build: 5 | runs-on: ubuntu-22.04 6 | steps: 7 | - uses: actions/checkout@v3 8 | with: 9 | fetch-depth: 0 10 | - uses: actions/setup-java@v3 11 | with: 12 | java-version: 21 13 | distribution: 'temurin' 14 | - uses: FabricMC/fabric-action-scripts@v2 15 | id: changelog 16 | with: 17 | context: changelog 18 | workflow_id: release.yml 19 | - run: ./gradlew build publishMods publish --stacktrace --warning-mode=fail 20 | env: 21 | MAVEN_URL: ${{ secrets.MAVEN_URL }} 22 | MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} 23 | MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} 24 | CURSEFORGE_API_KEY: ${{ secrets.CURSEFORGE_API_KEY }} 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 26 | MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }} 27 | CHANGELOG: ${{ steps.changelog.outputs.changelog }} 28 | - run: ./gradlew processMDTemplates 29 | - uses: stefanzweifel/git-auto-commit-action@v4 30 | with: 31 | commit_message: Update readme 32 | commit_author: github-actions <41898282+github-actions[bot]@users.noreply.github.com> 33 | -------------------------------------------------------------------------------- /src/main/kotlin/net/fabricmc/language/kotlin/KotlinLanguageAdapter.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin 18 | 19 | import net.fabricmc.loader.language.LanguageAdapter 20 | import org.apache.logging.log4j.LogManager 21 | 22 | private val Logger = LogManager.getLogger("Fabric-Language-Kotlin") 23 | 24 | class KotlinLanguageAdapter : LanguageAdapter { 25 | override fun createInstance(clazz: Class<*>, options: LanguageAdapter.Options): Any { 26 | Logger.warn("$clazz is using a deprecated language adapter, support for this will be dropped in a future update. Update $clazz.") 27 | return clazz.kotlin.objectInstance ?: run { 28 | System.err.println("Unable to find Kotlin object instance for ${clazz.name}, constructing new instance") 29 | clazz.newInstance() 30 | } 31 | } 32 | } -------------------------------------------------------------------------------- /src/test/kotlin/net/fabricmc/language/kotlin/test/KotlinAdapterTest.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin.test 18 | 19 | import net.fabricmc.api.ModInitializer 20 | import net.fabricmc.language.kotlin.KotlinAdapter 21 | import net.fabricmc.loader.api.FabricLoader 22 | import kotlin.test.Test 23 | 24 | class KotlinAdapterTest { 25 | @Test 26 | fun classEntrypoint() { 27 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.ClassEntrypoint") 28 | } 29 | 30 | @Test 31 | fun objectClassEntrypoint() { 32 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.ObjectClassEntrypoint") 33 | } 34 | 35 | @Test 36 | fun objectFunctionEntrypoint() { 37 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.ObjectFunctionEntrypoint::init") 38 | } 39 | 40 | @Test 41 | fun objectFieldEntrypoint() { 42 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.ObjectFieldEntrypoint::initializer") 43 | } 44 | 45 | @Test 46 | fun companionClassEntrypoint() { 47 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.CompanionClassEntrypoint\$Companion") 48 | } 49 | 50 | @Test 51 | fun companionFunctionEntrypoint() { 52 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.CompanionFunctionEntrypoint\$Companion::init") 53 | } 54 | 55 | @Test 56 | fun companionFieldEntrypoint() { 57 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.CompanionFieldEntrypoint\$Companion::initializer") 58 | } 59 | 60 | @Test 61 | fun topLevelEntrypoint() { 62 | testEntrypoint("net.fabricmc.language.kotlin.test.entrypoints.TopLevelEntrypointKt::init") 63 | } 64 | 65 | private fun testEntrypoint(value: String) { 66 | FabricLoader.getInstance().objectShare.remove("fabric-language-kotlin:test") 67 | 68 | val modContainer = FabricLoader.getInstance().getModContainer("fabric-language-kotlin").get() 69 | val entrypoint = KotlinAdapter().create(modContainer, value, ModInitializer::class.java) 70 | entrypoint.onInitialize() 71 | 72 | assert(FabricLoader.getInstance().objectShare.get("fabric-language-kotlin:test") == "true") 73 | } 74 | } -------------------------------------------------------------------------------- /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 95 | -------------------------------------------------------------------------------- /src/main/kotlin/net/fabricmc/language/kotlin/KotlinAdapter.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2016 FabricMC 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package net.fabricmc.language.kotlin 18 | 19 | import net.fabricmc.loader.api.LanguageAdapter 20 | import net.fabricmc.loader.api.LanguageAdapterException 21 | import net.fabricmc.loader.api.ModContainer 22 | import java.lang.invoke.MethodHandleProxies 23 | import java.lang.invoke.MethodHandles 24 | import kotlin.reflect.full.createInstance 25 | import kotlin.reflect.full.declaredMemberProperties 26 | import kotlin.reflect.full.isSuperclassOf 27 | import kotlin.reflect.full.memberFunctions 28 | import kotlin.reflect.jvm.javaMethod 29 | import kotlin.reflect.jvm.jvmErasure 30 | 31 | open class KotlinAdapter : LanguageAdapter { 32 | override fun create(mod: ModContainer, value: String, type: Class): T { 33 | val methodSplit = value.split("::").dropLastWhile { it.isEmpty() }.toTypedArray() 34 | val methodSplitSize = methodSplit.size 35 | if (methodSplitSize >= 3) { 36 | throw LanguageAdapterException("Invalid handle format: $value") 37 | } 38 | 39 | val c: Class = try { 40 | Class.forName(methodSplit[0]) as Class 41 | } catch (e: ClassNotFoundException) { 42 | throw LanguageAdapterException(e) 43 | } 44 | val k = c.kotlin 45 | 46 | when (methodSplit.size) { 47 | 1 -> { 48 | return if (type.isAssignableFrom(c)) { 49 | // try to return the objectInstance first 50 | @Suppress("UNCHECKED_CAST") 51 | k.objectInstance as? T 52 | ?: try { 53 | k.createInstance() as T 54 | } catch (e: Exception) { 55 | throw LanguageAdapterException(e) 56 | } 57 | } else { 58 | throw LanguageAdapterException("Class " + c.name + " cannot be cast to " + type.name + "!") 59 | } 60 | } 61 | 2 -> { 62 | val instance = k.objectInstance ?: run { 63 | // In Kotlin 1.9.20 objectInstance can return null. 64 | // See: https://github.com/FabricMC/fabric-language-kotlin/issues/120 65 | return LanguageAdapter.getDefault().create(mod, value, type) 66 | } 67 | 68 | val methodList = instance::class.memberFunctions.filter { m -> 69 | m.name == methodSplit[1] 70 | } 71 | 72 | k.declaredMemberProperties.find { 73 | it.name == methodSplit[1] 74 | }?.let { field -> 75 | try { 76 | val fType = field.returnType 77 | 78 | if (methodList.isNotEmpty()) { 79 | throw LanguageAdapterException("Ambiguous $value - refers to both field and method!") 80 | } 81 | 82 | if (!type.kotlin.isSuperclassOf(fType.jvmErasure)) { 83 | throw LanguageAdapterException("Field " + value + " cannot be cast to " + type.name + "!") 84 | } 85 | 86 | return field.get(instance) as T 87 | } catch (e: NoSuchFieldException) { 88 | // ignore 89 | } catch (e: IllegalAccessException) { 90 | throw LanguageAdapterException("Field $value cannot be accessed!", e) 91 | } 92 | } 93 | 94 | if (!type.isInterface) { 95 | throw LanguageAdapterException("Cannot proxy method " + value + " to non-interface type " + type.name + "!") 96 | } 97 | 98 | if (methodList.isEmpty()) { 99 | throw LanguageAdapterException("Could not find $value!") 100 | } else if (methodList.size >= 2) { 101 | throw LanguageAdapterException("Found multiple method entries of name $value!") 102 | } 103 | 104 | val handle = try { 105 | MethodHandles.lookup() 106 | .unreflect(methodList[0].javaMethod) 107 | .bindTo(instance) 108 | } catch (ex: Exception) { 109 | throw LanguageAdapterException("Failed to create method handle for $value!", ex) 110 | } 111 | 112 | try { 113 | return MethodHandleProxies.asInterfaceInstance(type, handle) 114 | } catch (ex: Exception) { 115 | throw LanguageAdapterException(ex) 116 | } 117 | } 118 | else -> throw LanguageAdapterException("Invalid handle format: $value") 119 | } 120 | } 121 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fabric-language-kotlin 2 | 3 | [![maven-badge](https://img.shields.io/maven-metadata/v/https/maven.fabricmc.net/net/fabricmc/fabric-language-kotlin/maven-metadata.xml.svg?style=flat-square&logo=Kotlin&label=Maven)](https://maven.fabricmc.net/net/fabricmc/fabric-language-kotlin) 4 | [![modrinth-badge](https://img.shields.io/modrinth/dt/fabric-language-kotlin?label=Modrinth&logo=Modrinth&style=flat-square)](https://modrinth.com/mod/fabric-language-kotlin/versions) 5 | [![curseforge-badge](https://img.shields.io/curseforge/dt/308769?style=flat-square&logo=curseforge&label=CurseForge)](https://minecraft.curseforge.com/projects/308769/files) 6 | 7 | Fabric language module for [Kotlin](https://kotlinlang.org/). Adds support for Kotlin exclusive entrypoints and bundles the Kotlin Stdlib as well as common kotlinx libraries. 8 | 9 | ## Usage 10 | 11 | ### Dependency 12 | 13 | Add it as a dependency to your Gradle project: 14 | 15 | ```kotlin 16 | dependencies { 17 | modImplementation("net.fabricmc:fabric-language-kotlin:1.13.7+kotlin.2.2.21") 18 | } 19 | ``` 20 | 21 | ### Adapter 22 | 23 | Use the `kotlin` adapter for your mod by setting the `adapter` property in the `fabric.mod.json` file. 24 | Remember to the add a dependency entry to your `fabric.mod.json` file: 25 | 26 | ```json 27 | { 28 | "schemaVersion": 1, 29 | "entrypoints": { 30 | "main": [ 31 | { 32 | "adapter": "kotlin", 33 | "value": "package.ClassName" 34 | } 35 | ] 36 | }, 37 | "depends": { 38 | "fabric-language-kotlin": ">=1.13.7+kotlin.2.2.21" 39 | } 40 | } 41 | ``` 42 | 43 | For more info reference the [fabric.mod.json documentation](https://fabricmc.net/wiki/documentation:fabric_mod_json). 44 | 45 | Do not forget to set the `schemaVersion` to `1` or it will fall back to schema `0` and will not attempt to load entrypoints. 46 | 47 | ### Entrypoint samples 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 78 | 79 | 80 | 81 | 82 | 83 | 102 | 121 | 140 | 141 | 142 | 143 | 164 | 185 | 206 | 207 | 208 | 209 | 210 | 229 | 230 | 231 |
KindClass referenceFunction referenceField reference
class 60 | 61 | ```json 62 | { 63 | "adapter": "kotlin", 64 | "value": "mymod.MyMod" 65 | } 66 | ``` 67 | 68 | ```kotlin 69 | package mymod 70 | class MyMod : ModInitializer { 71 | override fun onInitialize() { 72 | TODO() 73 | } 74 | } 75 | ``` 76 | 77 |
object 84 | 85 | ```json 86 | { 87 | "adapter": "kotlin", 88 | "value": "mymod.MyMod" 89 | } 90 | ``` 91 | 92 | ```kotlin 93 | package mymod 94 | object MyMod : ModInitializer { 95 | override fun onInitialize() { 96 | TODO() 97 | } 98 | } 99 | ``` 100 | 101 | 103 | 104 | ```json 105 | { 106 | "adapter": "kotlin", 107 | "value": "mymod.MyMod::init" 108 | } 109 | ``` 110 | 111 | ```kotlin 112 | package mymod 113 | object MyMod { 114 | fun init() { 115 | TODO() 116 | } 117 | } 118 | ``` 119 | 120 | 122 | 123 | ```json 124 | { 125 | "adapter": "kotlin", 126 | "value": "mymod.MyMod::initializer" 127 | } 128 | ``` 129 | 130 | ```kotlin 131 | package mymod 132 | object MyMod { 133 | val initializer = ModInitializer { 134 | TODO() 135 | } 136 | } 137 | ``` 138 | 139 |
companion object 144 | 145 | ```json 146 | { 147 | "adapter": "kotlin", 148 | "value": "mymod.MyMod$Companion" 149 | } 150 | ``` 151 | 152 | ```kotlin 153 | package mymod 154 | class MyMod { 155 | companion object : ModInitializer { 156 | override fun onInitialize() { 157 | TODO() 158 | } 159 | } 160 | } 161 | ``` 162 | 163 | 165 | 166 | ```json 167 | { 168 | "adapter": "kotlin", 169 | "value": "mymod.MyMod$Companion::init" 170 | } 171 | ``` 172 | 173 | ```kotlin 174 | package mymod 175 | class MyMod { 176 | companion object { 177 | fun init() { 178 | TODO() 179 | } 180 | } 181 | } 182 | ``` 183 | 184 | 186 | 187 | ```json 188 | { 189 | "adapter": "kotlin", 190 | "value": "mymod.MyMod$Companion::initializer" 191 | } 192 | ``` 193 | 194 | ```kotlin 195 | package mymod 196 | class MyMod { 197 | companion object { 198 | val initializer = ModInitializer { 199 | TODO() 200 | } 201 | } 202 | } 203 | ``` 204 | 205 |
top level 211 | 212 | ```json 213 | { 214 | "adapter": "kotlin", 215 | "value": "mymod.MyModKt::init" 216 | } 217 | ``` 218 | 219 | File: `src/main/kotlin/mymod/MyMod.kt` 220 | ```kotlin 221 | package mymod 222 | 223 | fun init() { 224 | TODO() 225 | } 226 | ``` 227 | 228 |
232 | 233 | Companion objects can be used by appending `$Companion` to the class. 234 | **Take care of `processResources` there**, it might try to expand it, in that case escape it. 235 | 236 | ## Bundled libraries 237 | 238 | `org.jetbrains.kotlin` namespace: 239 | - **`kotlin-stdlib`** 2.2.21 [Docs](https://kotlinlang.org/docs/home.html), [API docs](https://kotlinlang.org/api/latest/jvm/stdlib/), [GitHub](https://github.com/JetBrains/kotlin) 240 | - **`kotlin-reflect`** 2.2.21 [Docs](https://kotlinlang.org/docs/reflection.html), [API docs](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/) 241 | 242 | `org.jetbrains.kotlinx` namespace: 243 | - **`kotlinx-coroutines-core`** 1.10.2 [Guide](https://kotlinlang.org/docs/coroutines-guide.html), [API docs](https://kotlin.github.io/kotlinx.coroutines/), [GitHub](https://github.com/Kotlin/kotlinx.coroutines) 244 | - **`kotlinx-coroutines-jdk8`** 1.10.2 [API docs](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/index.html) 245 | - **`kotlinx-serialization-core`** 1.9.0 [Guide](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/serialization-guide.md), [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/index.html), [GitHub](https://github.com/Kotlin/kotlinx.serialization) 246 | - **`kotlinx-serialization-json`** 1.9.0 [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-json/index.html) 247 | - **`kotlinx-serialization-cbor`** 1.9.0 [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-cbor/index.html) 248 | - **`atomicfu`** 0.29.0 [GitHub](https://github.com/Kotlin/kotlinx.atomicfu) 249 | - **`kotlinx-datetime`** 0.7.1 [GitHub](https://github.com/Kotlin/kotlinx-datetime) 250 | - **`kotlinx-io-core`** 0.8.0 [API docs](https://kotlin.github.io/kotlinx-io/kotlinx-io-core/index.html), [GitHub](https://github.com/Kotlin/kotlinx-io) 251 | - **`kotlinx-io-bytestring`** 0.8.0 [API docs](https://kotlin.github.io/kotlinx-io/kotlinx-io-bytestring/index.html) 252 | 253 | ## Available Versions 254 | 255 | https://maven.fabricmc.net/net/fabricmc/fabric-language-kotlin/ 256 | 257 | ## Updating README 258 | 259 | - Update the readme in `templates/README.template.md`. 260 | - Run `./gradlew processMDTemplates`. 261 | -------------------------------------------------------------------------------- /templates/README.template.md: -------------------------------------------------------------------------------- 1 | # fabric-language-kotlin 2 | 3 | [![maven-badge](https://img.shields.io/maven-metadata/v/https/maven.fabricmc.net/net/fabricmc/fabric-language-kotlin/maven-metadata.xml.svg?style=flat-square&logo=Kotlin&label=Maven)](https://maven.fabricmc.net/net/fabricmc/fabric-language-kotlin) 4 | [![modrinth-badge](https://img.shields.io/modrinth/dt/fabric-language-kotlin?label=Modrinth&logo=Modrinth&style=flat-square)](https://modrinth.com/mod/fabric-language-kotlin/versions) 5 | [![curseforge-badge](https://img.shields.io/curseforge/dt/308769?style=flat-square&logo=curseforge&label=CurseForge)](https://minecraft.curseforge.com/projects/308769/files) 6 | 7 | Fabric language module for [Kotlin](https://kotlinlang.org/). Adds support for Kotlin exclusive entrypoints and bundles the Kotlin Stdlib as well as common kotlinx libraries. 8 | 9 | ## Usage 10 | 11 | ### Dependency 12 | 13 | Add it as a dependency to your Gradle project: 14 | 15 | ```kotlin 16 | dependencies { 17 | modImplementation("net.fabricmc:fabric-language-kotlin:${MOD_VERSION}") 18 | } 19 | ``` 20 | 21 | ### Adapter 22 | 23 | Use the `kotlin` adapter for your mod by setting the `adapter` property in the `fabric.mod.json` file. 24 | Remember to the add a dependency entry to your `fabric.mod.json` file: 25 | 26 | ```json 27 | { 28 | "schemaVersion": 1, 29 | "entrypoints": { 30 | "main": [ 31 | { 32 | "adapter": "kotlin", 33 | "value": "package.ClassName" 34 | } 35 | ] 36 | }, 37 | "depends": { 38 | "fabric-language-kotlin": ">=${MOD_VERSION}" 39 | } 40 | } 41 | ``` 42 | 43 | For more info reference the [fabric.mod.json documentation](https://fabricmc.net/wiki/documentation:fabric_mod_json). 44 | 45 | Do not forget to set the `schemaVersion` to `1` or it will fall back to schema `0` and will not attempt to load entrypoints. 46 | 47 | ### Entrypoint samples 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 78 | 79 | 80 | 81 | 82 | 83 | 102 | 121 | 140 | 141 | 142 | 143 | 164 | 185 | 206 | 207 | 208 | 209 | 210 | 229 | 230 | 231 |
KindClass referenceFunction referenceField reference
class 60 | 61 | ```json 62 | { 63 | "adapter": "kotlin", 64 | "value": "mymod.MyMod" 65 | } 66 | ``` 67 | 68 | ```kotlin 69 | package mymod 70 | class MyMod : ModInitializer { 71 | override fun onInitialize() { 72 | TODO() 73 | } 74 | } 75 | ``` 76 | 77 |
object 84 | 85 | ```json 86 | { 87 | "adapter": "kotlin", 88 | "value": "mymod.MyMod" 89 | } 90 | ``` 91 | 92 | ```kotlin 93 | package mymod 94 | object MyMod : ModInitializer { 95 | override fun onInitialize() { 96 | TODO() 97 | } 98 | } 99 | ``` 100 | 101 | 103 | 104 | ```json 105 | { 106 | "adapter": "kotlin", 107 | "value": "mymod.MyMod::init" 108 | } 109 | ``` 110 | 111 | ```kotlin 112 | package mymod 113 | object MyMod { 114 | fun init() { 115 | TODO() 116 | } 117 | } 118 | ``` 119 | 120 | 122 | 123 | ```json 124 | { 125 | "adapter": "kotlin", 126 | "value": "mymod.MyMod::initializer" 127 | } 128 | ``` 129 | 130 | ```kotlin 131 | package mymod 132 | object MyMod { 133 | val initializer = ModInitializer { 134 | TODO() 135 | } 136 | } 137 | ``` 138 | 139 |
companion object 144 | 145 | ```json 146 | { 147 | "adapter": "kotlin", 148 | "value": "mymod.MyMod\$Companion" 149 | } 150 | ``` 151 | 152 | ```kotlin 153 | package mymod 154 | class MyMod { 155 | companion object : ModInitializer { 156 | override fun onInitialize() { 157 | TODO() 158 | } 159 | } 160 | } 161 | ``` 162 | 163 | 165 | 166 | ```json 167 | { 168 | "adapter": "kotlin", 169 | "value": "mymod.MyMod\$Companion::init" 170 | } 171 | ``` 172 | 173 | ```kotlin 174 | package mymod 175 | class MyMod { 176 | companion object { 177 | fun init() { 178 | TODO() 179 | } 180 | } 181 | } 182 | ``` 183 | 184 | 186 | 187 | ```json 188 | { 189 | "adapter": "kotlin", 190 | "value": "mymod.MyMod\$Companion::initializer" 191 | } 192 | ``` 193 | 194 | ```kotlin 195 | package mymod 196 | class MyMod { 197 | companion object { 198 | val initializer = ModInitializer { 199 | TODO() 200 | } 201 | } 202 | } 203 | ``` 204 | 205 |
top level 211 | 212 | ```json 213 | { 214 | "adapter": "kotlin", 215 | "value": "mymod.MyModKt::init" 216 | } 217 | ``` 218 | 219 | File: `src/main/kotlin/mymod/MyMod.kt` 220 | ```kotlin 221 | package mymod 222 | 223 | fun init() { 224 | TODO() 225 | } 226 | ``` 227 | 228 |
232 | 233 | Companion objects can be used by appending `\$Companion` to the class. 234 | **Take care of `processResources` there**, it might try to expand it, in that case escape it. 235 | 236 | ## Bundled libraries 237 | 238 | `org.jetbrains.kotlin` namespace: 239 | - **`kotlin-stdlib`** ${KOTLIN_STDLIB_VERSION} [Docs](https://kotlinlang.org/docs/home.html), [API docs](https://kotlinlang.org/api/latest/jvm/stdlib/), [GitHub](https://github.com/JetBrains/kotlin) 240 | - **`kotlin-reflect`** ${KOTLIN_REFLECT_VERSION} [Docs](https://kotlinlang.org/docs/reflection.html), [API docs](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/) 241 | 242 | `org.jetbrains.kotlinx` namespace: 243 | - **`kotlinx-coroutines-core`** ${KOTLINX_COROUTINES_CORE_VERSION} [Guide](https://kotlinlang.org/docs/coroutines-guide.html), [API docs](https://kotlin.github.io/kotlinx.coroutines/), [GitHub](https://github.com/Kotlin/kotlinx.coroutines) 244 | - **`kotlinx-coroutines-jdk8`** ${KOTLINX_COROUTINES_CORE_VERSION} [API docs](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-jdk8/index.html) 245 | - **`kotlinx-serialization-core`** ${KOTLINX_SERIALIZATION_CORE_JVM_VERSION} [Guide](https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/serialization-guide.md), [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-core/index.html), [GitHub](https://github.com/Kotlin/kotlinx.serialization) 246 | - **`kotlinx-serialization-json`** ${KOTLINX_SERIALIZATION_JSON_JVM_VERSION} [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-json/index.html) 247 | - **`kotlinx-serialization-cbor`** ${KOTLINX_SERIALIZATION_CBOR_JVM_VERSION} [API docs](https://kotlin.github.io/kotlinx.serialization/kotlinx-serialization-cbor/index.html) 248 | - **`atomicfu`** ${ATOMICFU_JVM_VERSION} [GitHub](https://github.com/Kotlin/kotlinx.atomicfu) 249 | - **`kotlinx-datetime`** ${KOTLINX_DATETIME_JVM_VERSION} [GitHub](https://github.com/Kotlin/kotlinx-datetime) 250 | - **`kotlinx-io-core`** ${KOTLINX_IO_CORE_JVM_VERSION} [API docs](https://kotlin.github.io/kotlinx-io/kotlinx-io-core/index.html), [GitHub](https://github.com/Kotlin/kotlinx-io) 251 | - **`kotlinx-io-bytestring`** ${KOTLINX_IO_BYTESTRING_JVM_VERSION} [API docs](https://kotlin.github.io/kotlinx-io/kotlinx-io-bytestring/index.html) 252 | 253 | ## Available Versions 254 | 255 | https://maven.fabricmc.net/net/fabricmc/fabric-language-kotlin/ 256 | 257 | ## Updating README 258 | 259 | - Update the readme in `templates/README.template.md`. 260 | - Run `./gradlew processMDTemplates`. 261 | -------------------------------------------------------------------------------- /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" "$@" 253 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. --------------------------------------------------------------------------------