https://github.com/itsdoot/solace
A Kotlin extension library for the Sponge ecosystem.
https://github.com/itsdoot/solace
Last synced: over 1 year ago
JSON representation
A Kotlin extension library for the Sponge ecosystem.
- Host: GitHub
- URL: https://github.com/itsdoot/solace
- Owner: ItsDoot
- License: mit
- Created: 2018-06-14T18:54:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-13T03:32:08.000Z (almost 8 years ago)
- Last Synced: 2025-02-02T20:52:38.827Z (over 1 year ago)
- Language: Kotlin
- Size: 121 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Solace [](https://jitpack.io/#xDotDash/Solace) [](https://jitpack.io/#xDotDash/Solace)
A Kotlin extension library for the Sponge ecosystem.
## FAQ
**Q: What's the difference between this library, and similar ones already available?**
In Solace *everything* is `inline`'d, making it easier for Ore reviewers to decompile and read projects which use Solace.
Also, even though Solace shades the Kotlin standard library and runtime into its jar,
it does so without causing issues with other plugins who do the same, because it relocates Kotlin to `solace.kotlin`.
Then, the only additional thing that projects that use Solace have to do,
is to relocate Kotlin references itself to `solace.kotiln`.
## Gradle Setup
To use Solace, your `build.gradle` should look *similar* to this:
```groovy
plugins {
id "org.jetbrains.kotlin.jvm" version ""
id "org.jetbrains.kotlin.kapt" version ""
id "com.github.johnrengelman.shadow" version "2.0.4"
}
configurations {
compile.extendsFrom(kapt)
compile.extendsFrom(shadow)
}
repositories {
mavenCentral()
maven { url "https://repo.spongepowered.org/maven/" }
maven { url 'https://jitpack.io' }
}
dependencies {
compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:"
kapt 'org.spongepowered:spongeapi:7.1.0-SNAPSHOT'
compile 'com.github.xDotDash:solace:'
}
shadowJar {
configurations = [project.configurations.shadow]
relocate 'kotlin', 'solace.kotlin'
classifier = null
}
build.dependsOn(shadowJar)
compileKotlin {
kotlinOptions {
jvmTarget = "1.8"
}
}
```
**NOTE:** We aren't actually using the shadow plugin to shade Kotlin.
We are only using it to relocate references in our code, to use Solace's shaded Kotlin version.
### Next:
Simply add Solace as a dependency in your `@Plugin` like so:
```kotlin
@Plugin(id = "my-plugin", dependencies = [
Dependency(id = "solace", version = "3.4.0")
])
class MyPlugin
```
Finally, for Server Admins to use your plugin, they must now plop the Solace jar for your required version into the `mods`/`plugins` folder as well.