Skip to content

Commit

Permalink
Mark paper-plugin.yml as experimental (#2122)
Browse files Browse the repository at this point in the history
While paper plugins and their respective loading strategy have been
integrated into paper for a while now, the developer facing side of
paper plugins is still highly experimental.

Specifically the paper-plugin.yml file structure is still under active
development and its syntax might change without a deprecation cycle.
Its usage for general purpose plugin development is still hence
discouraged.

While developers that are familiar with the caveats of using paper
plugins but decide to do so anyway due to the already existing features
exist, this commit still adds a warning to ensure that developers not
familiar with the system do not accidentally use it for new projects,
preventing frustration down the line with potential missing features or
breaking changes over the usage of a plain plugin.yml file.
  • Loading branch information
lynxplay authored Dec 7, 2023
1 parent 3c8b1e5 commit 2968496
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/main/kotlin/platform/bukkit/creator/bukkit-platforms.kt
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@ import com.demonwav.mcdev.platform.PlatformType
import com.demonwav.mcdev.util.MinecraftTemplates
import com.demonwav.mcdev.util.MinecraftVersions
import com.demonwav.mcdev.util.SemanticVersion
import com.intellij.icons.AllIcons
import com.intellij.openapi.observable.util.bindBooleanStorage
import com.intellij.openapi.ui.validation.WHEN_GRAPH_PROPAGATION_FINISHED
import com.intellij.ui.content.AlertIcon
import com.intellij.ui.dsl.builder.Panel
import com.intellij.ui.dsl.builder.bindSelected

Expand Down Expand Up @@ -74,7 +76,11 @@ class PaperPlatformStep(parent: BukkitPlatformStep) : AbstractBukkitPlatformStep
override fun setupUI(builder: Panel) {
super.setupUI(builder)
with(builder) {
row("Paper manifest:") {
row("Paper Manifest:") {
icon(AlertIcon(AllIcons.General.Warning)).comment(
"Paper plugins are <a href=\"https://docs.papermc.io/paper/dev/getting-started/paper-plugins\">" +
"still experimental</a>, their usage is discouraged for general purpose development. "
)
checkBox("Use paper-plugin.yml")
.bindSelected(usePaperManifestProperty)
.validationRequestor(WHEN_GRAPH_PROPAGATION_FINISHED(propertyGraph))
Expand Down

0 comments on commit 2968496

Please sign in to comment.