Skip to content

feature(adventure): add notes about archival of -platform #767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kezz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feature(adventure): add notes about archival of -platform #767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/content/docs/adventure/platform/bukkit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ import { LATEST_ADVENTURE_SUPPORTED_MC, LATEST_ADVENTURE_PLATFORM_RELEASE } from
The Adventure platform implementation for Bukkit targets Paper, Spigot, and Bukkit for
Minecraft 1.7.10 through {LATEST_ADVENTURE_SUPPORTED_MC}.

:::caution
:::danger

This page documents only the *legacy* platform adapter for Bukkit. Most users should use [Paper](/paper)'s native implementation instead.
This native implementation provides more functionality, better integration with the server, and does not require the `BukkitAudiences` adapter.
Adventure platform implementation for Bukkit/Spigot and the Minecraft/Bungeecord component serializers are no longer maintained.
The Adventure team no longer provides support for using these libraries.

We recommend that users of these libraries update to modern software that [natively support's Adventure](/adventure/platform/native) (e.g., [Paper](/paper)).

:::

Expand Down
8 changes: 5 additions & 3 deletions src/content/docs/adventure/platform/bungeecord.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ import { LATEST_ADVENTURE_PLATFORM_RELEASE } from "/src/utils/versions";
Adventure targets the latest version of BungeeCord and BungeeCord-compatible
forks, such as Waterfall.

:::caution
:::danger

The BungeeCord platform is intended for legacy environments only.
Most developers will want to write plugins for [Velocity](/velocity), which natively implements the Adventure API. No adapters required!
Adventure platform implementation for Bungeecord and the Bungeecord component serializer is no longer maintained.
The Adventure team no longer provides support for using these libraries.

We recommend that users of these libraries update to modern software that [natively support's Adventure](/adventure/platform/native) (e.g., [Velocity](/velocity)).

:::

Expand Down
31 changes: 22 additions & 9 deletions src/content/docs/adventure/platform/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,6 @@ If you still cannot figure out the issue by yourself, you can always ask in the

### Content:
* [Native support](/adventure/platform/native)
* [Bukkit](/adventure/platform/bukkit)
* [Usage](/adventure/platform/bukkit#usage)
* [Component serializers](/adventure/platform/bukkit#component-serializers)
* [BungeeCord](/adventure/platform/bungeecord)
* [Usage](/adventure/platform/bungeecord#usage)
* [Component serializers](/adventure/platform/bungeecord#component-serializers)
* [SpongeAPI](/adventure/platform/spongeapi)
* [Usage](/adventure/platform/spongeapi#usage)
* [Modded (Fabric and NeoForge shared API)](/adventure/platform/modded)
* [Dependency](/adventure/platform/modded#dependency)
* [Basic use](/adventure/platform/modded#basic-use)
Expand All @@ -53,7 +45,28 @@ If you still cannot figure out the issue by yourself, you can always ask in the
* [Server](/adventure/platform/neoforge#server)
* [Commands](/adventure/platform/neoforge#commands)
* [Client](/adventure/platform/neoforge#dependency)
* [ViaVersion](/adventure/platform/viaversion)
* [Implementing platforms](/adventure/platform/implementing)
* [Services](/adventure/platform/implementing#services)
* [Conventional behaviors](/adventure/platform/implementing#conventional-behaviors)

### Legacy platforms

:::danger

Adventure platform implementations for Bungeecord, Bukkit/Spigot, and Sponge API 7, as well as associated serializers, are no longer maintained.
The Adventure team no longer provides support for using these libraries.

We recommend that users of these libraries update to modern platforms that [natively support Adventure](/adventure/platform/native) (e.g., Velocity, Paper, Sponge API 8+).
For users who develop for modded platforms, we recommend that you use [adventure-platform-mod](/adventure/platform/modded) for near-native support for Fabric and NeoForge.

:::

* [Bukkit](/adventure/platform/bukkit)
* [Usage](/adventure/platform/bukkit#usage)
* [Component serializers](/adventure/platform/bukkit#component-serializers)
* [BungeeCord](/adventure/platform/bungeecord)
* [Usage](/adventure/platform/bungeecord#usage)
* [Component serializers](/adventure/platform/bungeecord#component-serializers)
* [SpongeAPI](/adventure/platform/spongeapi)
* [Usage](/adventure/platform/spongeapi#usage)
* [ViaVersion](/adventure/platform/viaversion)
8 changes: 5 additions & 3 deletions src/content/docs/adventure/platform/spongeapi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ import { LATEST_ADVENTURE_PLATFORM_RELEASE } from "/src/utils/versions";

Adventure provides a platform for SpongeAPI 7 for *Minecraft: Java Edition* 1.12.

:::caution[Warning]
:::danger

For SpongeAPI 8 and up (targeting *Minecraft: Java Edition* 1.16.4), Adventure is the native text library, so no platform adapter is needed.
Sponge's API interfaces directly extend Adventure's rather than needing a `SpongeAudiences` adapter.
Adventure platform implementation for SpongeAPI 7 is no longer maintained.
The Adventure team no longer provides support for using these libraries.

We recommend that users of these libraries update to modern software that [natively support's Adventure](/adventure/platform/native) (e.g., SpongeAPI 8+).

:::

Expand Down
9 changes: 9 additions & 0 deletions src/content/docs/adventure/platform/viaversion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ slug: adventure/platform/viaversion
description: Using Adventure with ViaVersion.
---

:::danger

Adventure platform implementation for ViaVersion is no longer maintained.
The Adventure team no longer provides support for using these libraries.

We recommend that users of these libraries update to modern platforms that [natively support Adventure](/adventure/platform/native) (e.g., Velocity, Paper, Sponge API 8+).

:::

On supported platforms (Sponge 7 and Bukkit), Adventure is able to enhance its functionality
by using the [ViaVersion](https://hangar.papermc.io/ViaVersion/ViaVersion) API
to send packets directly to the client. This allows, for instance, for a plugin on a Minecraft
Expand Down
4 changes: 3 additions & 1 deletion src/utils/versions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ export const LATEST_USERDEV_RELEASE = userdevVersions[0];
export const LATEST_ADVENTURE_SUPPORTED_MC = "1.21.11";
export const LATEST_ADVENTURE_SUPPORTED_MC_RANGE = LATEST_ADVENTURE_SUPPORTED_MC;
export const LATEST_ADVENTURE_API_RELEASE = "5.1.1";
export const LATEST_ADVENTURE_PLATFORM_RELEASE = "4.4.1";
export const LATEST_ADVENTURE_PLATFORM_MOD_RELEASE = "6.8.0";
export const LATEST_ANSI_RELEASE = "1.1.1";

// legacy
export const LATEST_ADVENTURE_PLATFORM_RELEASE = "4.4.1";