{"id":13621722,"url":"https://github.com/spigradle/spigradle","last_synced_at":"2025-04-15T01:33:43.984Z","repository":{"id":40381702,"uuid":"227876875","full_name":"spigradle/spigradle","owner":"spigradle","description":"Intelligent Gradle plugin for Bukkit, Bungeecord and NukkitX.","archived":false,"fork":false,"pushed_at":"2025-01-17T00:04:56.000Z","size":1032,"stargazers_count":120,"open_issues_count":18,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-17T01:21:53.360Z","etag":null,"topics":["bukkit","bungeecord","gradle","gradle-plugin","kotlin","minecraft","nukkit","nukkitx","paper","spigot","spigot-gradle"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spigradle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-13T16:13:29.000Z","updated_at":"2025-01-17T00:04:58.000Z","dependencies_parsed_at":"2024-05-11T19:51:34.554Z","dependency_job_id":null,"html_url":"https://github.com/spigradle/spigradle","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spigradle%2Fspigradle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spigradle%2Fspigradle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spigradle%2Fspigradle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spigradle%2Fspigradle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spigradle","download_url":"https://codeload.github.com/spigradle/spigradle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248989468,"owners_count":21194592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bukkit","bungeecord","gradle","gradle-plugin","kotlin","minecraft","nukkit","nukkitx","paper","spigot","spigot-gradle"],"created_at":"2024-08-01T21:01:09.894Z","updated_at":"2025-04-15T01:33:43.978Z","avatar_url":"https://github.com/spigradle.png","language":"Kotlin","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"readme":"# Spigradle\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n[![License](https://img.shields.io/github/license/EntryPointKR/Spigradle.svg)](https://github.com/EntryPointKR/Spigradle/blob/master/LICENSE)\n[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/kr.entree.spigradle)](https://plugins.gradle.org/plugin/kr.entree.spigradle)\n[![TeamCity CI](https://ci.entree.dev/app/rest/builds/buildType(id:Spigradle_Build)/statusIcon)](https://ci.entree.dev/buildConfiguration/Spigradle_Build?branch=%3Cdefault%3E\u0026buildTypeTab=overview\u0026mode=builds\u0026guest=1)\n\nAn intelligent Gradle plugin used to develop plugins for Spigot, Bungeecord and NukkitX.\n\n# Benefits\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n- [Description file](https://entree.dev/spigradle/docs/spigradle/kr.entree.spigradle.module.spigot/-spigot-extension/index.html) generation: `plugin.yml` and/or `bungee.yml`\n\n- Main class detection\n\n- Debug tasks\n\n- Shortcuts for [repository](#repositories) and [dependency](#dependencies)\n\n```groovy\nplugins {\n    id 'java'\n    id 'kr.entree.spigradle' version '2.4.5'\n}\n\ngroup 'org.sample'\nversion '1.0-SNAPSHOT'\n\ndependencies {\n    compileOnly spigot('1.16.5')\n}\n\nspigot {\n    depends 'ProtocolLib'\n    softDepends 'SomeLibrary'\n    commands {\n        create('mycmd') {\n            aliases 'cmd'\n        }\n    }\n}\n```\n\n# Table of contents\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n- [Plugins](#plugins)\n  - [Spigot](#spigot)\n  - [Bungeecord](#bungeecord)\n  - [NukkitX](#nukkitx)\n- [Requirements](#requirements)\n- [Repositories](#repositories)\n- [Dependencies](#dependencies)\n- [See also](#see-also)\n- [Supporters](#supporters)\n- [The Spigot plugin](docs/spigot_plugin.md)\n- [The Bungeecord plugin](docs/bungeecord_plugin.md)\n- [The Nukkit plugin](docs/nukkit_plugin.md)\n- [Sample](https://github.com/spigradle/spigradle-sample)\n\n# Plugins\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n## Spigot\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n[Documentation](docs/spigot_plugin.md)\n\n### Demo\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n- [Groovy - build.gradle](https://github.com/spigradle/spigradle-sample/tree/master/spigot/spigot.gradle)\n- [Kotlin - build.gradle.kts](https://github.com/spigradle/spigradle-sample/tree/master/spigot-kotlin/spigot-kotlin.gradle.kts)\n\nGroovy DSL\n\n```groovy\nplugins {\n    id 'java'\n    id 'kr.entree.spigradle' version '2.4.5'\n}\n\ndependencies {\n    compileOnly spigot('1.16.5')\n}\n\nspigot {\n  depends 'ProtocolLib'\n  softDepends 'SomeLibrary'\n  commands {\n    create('mycmd') {\n      aliases 'cmd'\n    }\n  }\n  // if you want to exclude all [spigot.libraries]:\n  // `excludeLibraries = ['*']`\n}\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin DSL\u003c/summary\u003e\n\n```kotlin\nimport kr.entree.spigradle.kotlin.*\n\nplugins {\n    kotlin(\"jvm\") version \"1.3.72\"\n    id(\"kr.entree.spigradle\") version \"2.4.5\"\n}\n\ndependencies {\n    implementation(kotlin(\"stdlib-jdk8\"))\n    compileOnly(spigot(\"1.16.5\"))\n}\n\nspigot {\n  depends = listOf(\"ProtocolLib\")\n  softDepends = listOf(\"SomeLibrary\")\n  commands {\n    create(\"mycmd\") {\n      aliases = listOf(\"cmd\")\n    }\n  }\n  // if you want to exclude all [spigot.libraries]:\n  // `excludeLibraries = listOf(\"*\")`\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eGroovy Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath 'kr.entree:spigradle:2.4.5'\n    }\n}\n\napply plugin: 'kr.entree.spigradle'\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath(\"kr.entree:spigradle:2.4.5\")\n    }\n}\n\napply(plugin = \"kr.entree.spigradle\")\n```\n\n\u003c/details\u003e\n\n## Bungeecord\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n[Documentation](docs/bungeecord_plugin.md)\n\n### Demo\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n- [Groovy - build.gradle](https://github.com/spigradle/spigradle-sample/tree/master/bungeecord/bungeecord.gradle)\n- [Kotlin - build.gradle.kts](https://github.com/spigradle/spigradle-sample/tree/master/bungeecord-kotlin/bungeecord-kotlin.gradle.kts)\n\nGroovy DSL\n\n```groovy\nplugins {\n    id 'java'\n    id 'kr.entree.spigradle.bungee' version '2.4.5'\n}\n\ndependencies {\n    compileOnly bungeecord('1.15')\n}\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin DSL\u003c/summary\u003e\n\n```kotlin\nplugins {\n    kotlin(\"jvm\") version \"1.3.72\"\n    id(\"kr.entree.spigradle.bungee\") version \"2.4.5\"\n}\n\ndependencies {\n    implementation(kotlin(\"stdlib-jdk8\"))\n    compileOnly(bungeecord(\"1.15\"))\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eGroovy Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath 'kr.entree:spigradle:2.4.5'\n    }\n}\n\napply plugin: 'kr.entree.spigradle.bungee'\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath(\"kr.entree:spigradle:2.4.5\")\n    }\n}\n\napply(plugin = \"kr.entree.spigradle.bungee\")\n```\n\n\u003c/details\u003e\n\n## NukkitX\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n[Documentation](docs/nukkit_plugin.md)\n\n### Demo\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n- [Groovy - build.gradle](https://github.com/spigradle/spigradle-sample/tree/master/nukkit/nukkit.gradle)\n- [Kotlin - build.gradle.kts](https://github.com/spigradle/spigradle-sample/tree/master/nukkit-kotlin/nukkit-kotlin.gradle.kts)\n\nGroovy DSL\n\n```groovy\nplugins {\n    id 'java'\n    id 'kr.entree.spigradle.nukkit' version '2.4.5'\n}\n\ndependencies {\n    compileOnly nukkit('1.0')\n}\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin DSL\u003c/summary\u003e\n\n```kotlin\nplugins {\n    kotlin(\"jvm\") version \"1.3.72\"\n    id(\"kr.entree.spigradle.nukkit\") version \"2.4.5\"\n}\n\ndependencies {\n    implementation(kotlin(\"stdlib-jdk8\"))\n    compileOnly(bungeecord(\"1.15\"))\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eGroovy Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath 'kr.entree:spigradle:2.4.5'\n    }\n}\n\napply plugin: 'kr.entree.spigradle.nukkit'\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eKotlin Legacy\u003c/summary\u003e\n\n```groovy\nbuildscript {\n    repositories {\n        gradlePluginPortal()\n    }\n    dependencies {\n        classpath(\"kr.entree:spigradle:2.4.5\")\n    }\n}\n\napply(plugin = \"kr.entree.spigradle.nukkit\")\n```\n\n\u003c/details\u003e\n\n# Requirements\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\nAll the plugins requires Gradle 5.4.2+, recommends the latest.\n\nTo update your gradle wrapper:\n\n```\ngradlew wrapper --gradle-version 6.9.1 --distribution-type all\n```\n\n# Repositories\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n|  Name         |  URL                                                           | Relations                               | Aliases       |\n|---------------|----------------------------------------------------------------|-----------------------------------------|---------------|\n| spigotmc()    | https://hub.spigotmc.org/nexus/content/repositories/snapshots/ |                                         | spigot()      |\n| sonaytype()   | https://oss.sonatype.org/content/repositories/snapshots/       |                                         | bungeecord()  |\n| papermc()     | https://papermc.io/repo/repository/maven-public/               |                                         | paper()       |\n| jitpack()     | https://jitpack.io                                             | Vault                                   | vault()       |\n| protocolLib() | https://repo.dmulloy2.net/nexus/repository/public/             |                                         |               |\n| enginehub()   | https://maven.enginehub.org/repo/                              | worldguard, worldedit, commandhelper... |               |\n| codemc()      | https://repo.codemc.org/repository/maven-public/               | BStats                                  | bStats()      |\n| enderZone()   | https://ci.ender.zone/plugin/repository/everything/            | EssentialsX                             | essentialsX() |\n| frostcast()   | https://ci.frostcast.net/plugin/repository/everything          | BanManager                              | banManager()  |\n| nukkitX()     | https://repo.nukkitx.com/maven-snapshots                       | NukkitX                                 |               |\n\n### Groovy usage\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n```groovy\nrepositories {\n    engienhub()\n}\n```\n\n### Kotiln usage\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n```kotlin\nimport kr.entree.spigradle.kotlin.*\n\nrepositories {\n    enginehub()\n}\n```\n\n# Dependencies\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n|  Name             |  Signature                                       | Default version          | Official repository      |\n|-------------------|--------------------------------------------------|--------------------------|--------------------------|\n| spigot(version)   | org.spigotmc:spigot-api:$version                 | 1.16.1-R0.1-SNAPSHOT     | spigotmc()               |\n| spigotAll()       | org.spigotmc:spigot:$version                     | 1.16.1-R0.1-SNAPSHOT     | spigotmc()               |\n| bungeecord()      | net.md-5:bungeecord-api:$version                 | 1.16-R0.4-SNAPSHOT       | spigotmc()               |\n| minecraftServer() | org.spigotmc:minecraft-server:$version           | 1.16.1-SNAPSHOT          | mavenLocal(), BuildTools |\n| paper()           | com.destroystokyo.paper:paper-api:$version       | 1.16.1-R0.1-SNAPSHOT     | papermc()                |\n| bukkit()          | org.bukkit:bukkit:$version                       | 1.16.1-R0.1-SNAPSHOT     | mavenLocal(), BuildTools |\n| craftbukkit()     | org.bukkit:craftbukkit:$version                  | 1.16.1-R0.1-SNAPSHOT     | mavenLocal(), BuildTools |\n| lombok()          | org.projectlombok:lombok:$version                | 1.18.36                  | mavenCentral()           |\n| spigradle()       | kr.entree:spigradle:$version                     | 2.4.5       | mavenCentral()           |\n| protocolLib()     | com.comphenix.protocol:ProtocolLib:$version      | 4.5.1                    | protocolLib()            |\n| vault()           | com.github.MilkBowl:VaultAPI:$version            | 1.7                      | jitpack()                |\n| vaultAll()        | com.github.MilkBowl:Vault:$version               | 1.7.3                    | jitpack()                |\n| luckPerms()       | me.lucko.luckperms:luckperms-api:$version        | 5.1                      | mavenCentral()           |\n| worldedit()       | com.sk89q.worldedit:worldedit-bukkit:$version    | 7.1.0                    | enginehub()              |\n| worldguard()      | com.sk89q.worldguard:worldguard-bukkit:$version  | 7.0.3                    | enginehub()              |\n| essentialsX()     | net.ess3:EssentialsX:$version                    | 2.17.2                   | enderZone()              |\n| banManager()      | me.confuser.banmanager:BanManagerBukkit:$version | 7.3.0-SNAPSHOT           | frostcast()              |\n| commandhelper()   | com.sk89q:commandhelper:$version                 | 3.3.4-SNAPSHOT           | enginehub()              |\n| bStats()          | org.bstats:bstats-bukkit:$version                | 1.7                      | codemc()                 |\n| bStatsLite()      | org.bstats:bstats-bukkit-lite:$version           | 1.7                      | codemc()                 |\n| nukkit            | cn.nukkit:nukkit:$version                        | 2.0.0-SNAPSHOT           | nukkitX()                |\n\n### Groovy usage\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n```groovy\ndependencies {\n    compileOnly spigot(\"1.16.5\") // or just spigot()\n}\n```\n\n### Kotlin usage\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n```kotlin\nimport kr.entree.spigradle.kotlin.*\n\ndependencies {\n    compileOnly(spigot(\"1.16.5\")) // or just spigot()\n}\n```\n\n# See also\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n- [The Spigot plugin](docs/spigot_plugin.md)\n- [The Bungeecord plugin](docs/bungeecord_plugin.md)\n- [The Nukkit plugin](docs/nukkit_plugin.md)\n- [Gradle Kotlin DSL Primer](https://docs.gradle.org/current/userguide/kotlin_dsl.html)\n\n# Supporters\n\n[comment]: \u003c\u003e (!! Do not edit this file but 'docs/templates' or 'docs/root-templates', See [CONTRIBUTING.md] !!)\n\n\u003ca href=\"https://www.jetbrains.com/?from=Spigradle\"\u003e \n    \u003cimg src=\"assets/jetbrains.svg\" alt=\"JetBrains OS License\"/\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspigradle%2Fspigradle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspigradle%2Fspigradle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspigradle%2Fspigradle/lists"}