sya-ri / yatopiaplugintemplate

Yatopia Plugin Template Using EasySpigotAPI

YatopiaPluginTemplate

EasySpigotAPI を使って簡単にプラグインを作ることができます。

TODO

変更が必要なところがあります。

パッケージ名を設定しましょう。 ドメインを逆さにするのが定石になります。もしも自分のドメインを持っていない時は GitHub のアカウントを使いましょう。

Main.kt

package sample // TODO 固有のパッケージ名を設定する

e.g. GitHub のユーザー名が abcdef で、作るプラグインの名前が Sample だったら

package com.github.abcdef.sample

build.gradle.kts

configure<BukkitPluginDescription> {
    // ...
    main = "sample.Main" // TODO JavaPlugin を継承したクラスとパッケージを入力する
    // ...
}

e.g. GitHub のユーザー名が abcdef で、作るプラグインの名前が Sample だったら

configure<BukkitPluginDescription> {
    // ...
    main = "com.github.abcdef.sample.Main"
    // ...
}

plugin.yml

build.gradle.kts の中で設定できます。必要であれば設定しましょう。

configure<BukkitPluginDescription> {
    // plugin.yml の中身
}

Gradle Task

ktlintFormat

gradle ktlintFormat

ソースコードを綺麗にすることができます。

addKtlintFormatGitPreCommitHook

gradle addKtlintFormatGitPreCommitHook

Git Commit する時に ktlintFormat を実行します。やっておくことで必ずフォーマットしてくれるようになるので忘れがちな人にオススメです。

shadowJar

gradle shadowJar

Jar ファイルを生成します。build/libs フォルダの中に生成されます。