Skip to content

Commit

Permalink
Replace template with SimplePlayerPortals
Browse files Browse the repository at this point in the history
  • Loading branch information
tajobe committed May 22, 2022
1 parent 91a8ca2 commit facb58e
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 21 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# mc-kotlin-plugin-template
Opinionated template/starter for creating Minecraft plugins in Kotlin using the Spigot API
# SimplePlayerPortals
Simple yet flexible Bukkit/Spigot plugin for player-built portals in Minecraft

## Features

- Gradle axion-release-plugin for managing semver
- automatic updating of `CHANGELOG.md` and `main/resources/plugin.yml` when a release is made
- Github Actions to build PRs and automatically create Github releases when a release tag is pushed
- [`ktlint`](https://github.com/JLLeitschuh/ktlint-gradle) Gradle plugin
- Gradle build generates a standard plugin jar which will download dependencies declared as
[`libraries`](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/plugin/PluginDescriptionFile.html#getLibraries()) in
`plugin.yml` and an "offline"/shadowed jar containing necessary dependencies
- Easy-to-use configurable player created portals
- Named portal "channels" to link portals together
7 changes: 3 additions & 4 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -67,18 +67,17 @@ java {

repositories {
mavenCentral()
maven("https://hub.spigotmc.org/nexus/content/repositories/snapshots/")
maven("https://oss.sonatype.org/content/repositories/snapshots")
maven("https://repo.papermc.io/repository/maven-public/")
}

dependencies {
implementation(kotlin("stdlib-jdk8"))
compileOnly(group = "org.spigotmc", name = "spigot-api", version = "$mcApiVersion+")
compileOnly(group = "io.papermc.paper", name = "paper-api", version = "$mcApiVersion+")
}

tasks {
wrapper {
gradleVersion = "7.4.1"
gradleVersion = "7.4.2"
distributionType = Wrapper.DistributionType.ALL
}

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ kotlin.code.style=official

kotlinVersion=1.6.21
mcApiVersion=1.18
repoRef=SimpleMC/mc-kotlin-plugin-template
repoRef=SimpleMC/SimplePlayerPortals
2 changes: 1 addition & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.1-all.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
2 changes: 1 addition & 1 deletion settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ pluginManagement {
}
}

rootProject.name = "mc-kotlin-plugin-template"
rootProject.name = "simple-player-portals"
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package org.simplemc.plugintemplate
package org.simplemc.simpleplayerportals

import org.bukkit.plugin.java.JavaPlugin

/**
* KotlinPluginTemplate plugin
*/
class KotlinPluginTemplate : JavaPlugin() {
class SimplePlayerPortals : JavaPlugin() {

override fun onEnable() {
// ensure config file exists
Expand Down
6 changes: 3 additions & 3 deletions src/main/resources/plugin.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: KotlinPluginTemplate
main: org.simplemc.plugintemplate.KotlinPluginTemplate
name: SimplePlayerPortals
main: org.simplemc.simpleplayerportals.SimplePlayerPortals
version: "${version}"
api-version: "${apiVersion}"
website: https://github.com/SimpleMC/mc-kotlin-plugin-template
website: https://github.com/SimpleMC/SimplePlayerPortals
author: tajobe
libraries:
- org.jetbrains.kotlin:kotlin-stdlib-jdk8:${kotlinVersion}

0 comments on commit facb58e

Please sign in to comment.