-
-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: rebrand "paper plugins" as "lifecycle plugins"
- Loading branch information
1 parent
4a113f1
commit 4b00f1b
Showing
20 changed files
with
135 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
slug: /reference/lifecycle-plugins | ||
description: A guide to the ins and outs of lifecycle plugins. | ||
--- | ||
|
||
# Lifecycle Plugins | ||
|
||
This documentation page serves to explain all the new semantics and possible confusions that lifecycle plugins may introduce. | ||
|
||
:::info | ||
|
||
Developers can get more information on lifecycle plugins [here](docs/paper/dev/advanced/lifecycle-plugins.mdx). | ||
|
||
::: | ||
|
||
## What are they? | ||
|
||
Lifecycle plugins are plugins which are loaded by Paper's new plugin loading framework. Lifecycle plugins are used by developers to | ||
take advantage of modern systems Mojang provides, for example, datapacks. | ||
|
||
![Plugin List](assets/plugin-list.png) | ||
|
||
## What is the difference? | ||
|
||
When enabled, lifecycle plugins are **identical** to traditional paper plugins. This allows plugins to still fully communicate and support each other, meaning that even if a | ||
plugin is a traditional paper plugin or lifecycle plugin, they are both able to depend on each other just fine. | ||
|
||
Lifecycle plugins only support being loaded by Paper's Plugin Loader and may use new API unavailable to Bukkit plugins. | ||
|
||
### How do I add Lifecycle plugins? | ||
|
||
Lifecycle plugins are added the same as traditional paper plugins, therefore, you can follow [this guide](docs/paper/admin/getting-started/adding-plugins.md). | ||
|
||
### Cyclic plugin loading | ||
|
||
With the introduction of lifecycle plugins, Paper introduces a new plugin loader that fixes some odd issues. | ||
However, as a result, this now causes [cyclic loading](docs/paper/dev/advanced/lifecycle-plugins.mdx#cyclic-plugin-loading) between plugins to no longer be supported. | ||
|
||
If Paper detects a loop, your server will be shut down with an error. | ||
|
||
:::danger[Legacy] | ||
|
||
If your server **requires** this circular loading, you can enable this by adding the [`-Dpaper.useLegacyPluginLoading=true`](system-properties.md#paperuselegacypluginloading) startup flag. | ||
Please note that this may not be supported in the future. | ||
|
||
::: |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import DocCardList from "@theme/DocCardList"; | ||
import { useCurrentSidebarCategory } from "@docusaurus/theme-common"; | ||
|
||
# Advanced Topics | ||
|
||
This section contains advanced topics for Paper plugin developers. | ||
Be sure to read the [Getting Started](/paper/dev/getting-started) guide before diving into these topics. | ||
|
||
--- | ||
|
||
<DocCardList items={useCurrentSidebarCategory().items} /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
docs/paper/dev/getting-started/userdev.mdx → docs/paper/dev/advanced/userdev.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.