Adventure

https://docs.papermc.io/adventure/
Admin
Adventure is a Java library providing a unified API for handling text components, chat messages,...
Tokens:45,107
Snippets:403
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Using MiniMessage presets and customizing a builder

Source: https://docs.papermc.io/adventure/minimessage/api

Shows how to obtain a MiniMessage instance from a preset, get a pre-configured builder, add custom tag resolvers, and build a custom instance. The example uses the NON_INTERACTABLE preset to disable interactable features.

```java
// You can get a pre-built MiniMessage instance based on any preset.
final MiniMessage miniMessage = MiniMessage.miniMessage(MiniMessage.Preset.NON_INTERACTABLE);


// Alternatively, you can get a pre-configured builder...
final MiniMessage.Builder builder = MiniMessage.builder(MiniMessage.Preset.NON_INTERACTABLE);


// ...then add your own tags or override other settings if needed...
builder.editTags(tags -> {
  tags
    .resolver(new MyCustomTagResolver())
    .resolver(fetchExternalTags());
});


// ...and finally, build your MiniMessage instance!
final MiniMessage myCustomMiniMessageInstance = builder.build();

```

--------------------------------

### Click tag examples

Source: https://docs.papermc.io/adventure/minimessage/format

Examples of the click tag with run_command and copy_to_clipboard actions. Note that since 1.19.1, commands requiring signed arguments may not execute.

```text
<click:run_command:/seed>Click</click> to show the world seed!
Click <click:copy_to_clipboard:Haha you suck> this </click>to copy your score!
```

--------------------------------

### Hover tag example with show_text

Source: https://docs.papermc.io/adventure/minimessage/format

Example of the hover tag using the show_text action with a MiniMessage string as value.

```text
<hover:show_text:'<red>test'>TEST
```

--------------------------------

### Keybind Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Displays the configured key for a specific action.

```text

Press <red><key:key.jump> to jump!

```

--------------------------------

### Basic MiniMessage deserialization example

Source: https://docs.papermc.io/adventure/minimessage/api

Shows how to obtain a MiniMessage instance and deserialize a MiniMessage string into a Component, then send it to a player. The example uses the default tag set and is not in strict mode.

```java
final Audience player = ...;
final MiniMessage mm = MiniMessage.miniMessage();


final Component parsed = mm.deserialize("Hello <rainbow>world</rainbow>, isn't <underlined>MiniMessage</underlined> fun?");


player.sendMessage(parsed);

```

--------------------------------

### Hover tag example with show_item

Source: https://docs.papermc.io/adventure/minimessage/format

Example of the hover tag using the show_item action with item type, count, and data components.

```text
<hover:show_item:diamond_sword:1:enchantments:'{sharpness:3,knockback:2}'>Very sharp sword!</hover>
```

--------------------------------

### Transition Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Transitions between colors based on a phase parameter.

```text

<transition:#00ff00:#ff0000:0>|||||||||</transition>
<transition:white:black:red:[phase]>Hello world [phase]</transition>

```

--------------------------------

### Decoration tag example

Source: https://docs.papermc.io/adventure/minimessage/format

Example of the decoration tag using underlined and bold decorations.

```text
<underlined>This is <bold>important</bold>!
```

--------------------------------

### Reset tag example

Source: https://docs.papermc.io/adventure/minimessage/format

Example of the reset tag, which closes all open tags. In strict mode, reset tags are forbidden.

```text
<yellow><bold>Hello <reset>world!
```

--------------------------------

### Create custom styling tags with Placeholder.styling

Source: https://docs.papermc.io/adventure/minimessage/dynamic-replacements

Shows how to define custom styling tags for colors, hover events, and click commands. Each example replaces the tag with the specified style.

```java
Placeholder.styling("fancy", TextColor.color(150, 200, 150)); // will replace the color between "<fancy>" and "</fancy>"
Placeholder.styling("my_hover", HoverEvent.showText(Component.text("test"))); // will display your custom text as hover
Placeholder.styling("my_cmd", ClickEvent.runCommand("/mycmd is cool")); // will create a clickable text which will run your specified command.
```

--------------------------------

### Constructing a Sound with Sound.sound()

Source: https://docs.papermc.io/adventure/sound

Creates a Sound instance using a Key and Sound.Source. The first example uses a built-in sound key with standard volume and pitch; the second uses a custom resource pack key with a higher pitch. If a client does not know the sound, it will be ignored with a warning in the client log.

```java
// Create a built-in sound using standard volume and pitch
Sound musicDisc = Sound.sound(Key.key("music_disc.13"), Sound.Source.MUSIC, 1F, 1F);


// Create a sound from our resource pack with a higher pitch
Sound myCustomSound = Sound.sound(Key.key("adventure", "rawr"), Sound.Source.AMBIENT, 1F, 1.1F);
```

--------------------------------

### Basic MiniMessage example with rainbow and clickable text

Source: https://docs.papermc.io/adventure/minimessage

A simple MiniMessage string demonstrating the format. It uses the <rainbow> tag for rainbow-colored text, <blue> and <u> tags for blue underlined text, and a <click:open_url:'https://docs.papermc.io/adventure/minimessage/'> tag to make the text clickable. This example is suitable for users learning the MiniMessage syntax.

```text
Hello <rainbow>world</rainbow>, isn't <blue><u><click:open_url:'https://docs.papermc.io/adventure/minimessage/'>MiniMessage</click></u></blue> fun?
```

--------------------------------

### BungeeCord ComponentBuilder to Adventure equivalent

Source: https://docs.papermc.io/adventure/migration/bungeecord-chat-api

Shows the BungeeCord ComponentBuilder example and its Adventure equivalent, where the Adventure version uses Component.text() as a base and appends components with explicit styles.

```java
new ComponentBuilder("hello")
  .color(ChatColor.GOLD)
  .append(" world", FormatRetention.NONE)
  .build()
```

```java
Component.text()
  .append(Component.text("hello", NamedTextColor.GOLD))
  .append(Component.text(" world"))
  .build()
```

--------------------------------

### Tag syntax examples

Source: https://docs.papermc.io/adventure/minimessage/format

Shows three visually identical ways to write the same MiniMessage text, demonstrating that end tags are optional outside strict mode.

```minimessage
<yellow>Hello <blue>World<yellow>!
<yellow>Hello <blue>World</blue>!
<yellow>Hello </yellow><blue>World</blue><yellow>!</yellow>
```

--------------------------------

### Insert a style with Placeholder.styling

Source: https://docs.papermc.io/adventure/minimessage/dynamic-replacements

Creates custom styling tags. The example applies a click event, red color, and bold decoration to the text between the tags.

```java
MiniMessage.miniMessage().deserialize("<my_style>Hello :)</my_style> How are you?",
    Placeholder.styling("my_style", ClickEvent.suggestCommand("/say hello"), NamedTextColor.RED, TextDecoration.BOLD));
// will apply a click event, a red text color and bold decoration to the text
```

--------------------------------

### Score Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Inserts a score component from the server scoreboard.

```text

You have won <score:rymiel:gamesWon/> games!

```

--------------------------------

### Create an active BossBar for mutation example

Source: https://docs.papermc.io/adventure/bossbar

Creates an active boss bar that will be used to demonstrate automatic updates when its properties are changed.

```java
final BossBar bossBar = BossBar.bossBar(Component.text("Cat counter"), 0, BossBar.Color.RED, BossBar.Overlay.PROGRESS);
```

--------------------------------

### Set up MinecraftServerAudiences in a Fabric mod initializer

Source: https://docs.papermc.io/adventure/platform/fabric

Initializes the Adventure audience provider on server start and clears it on server stop. Throws IllegalStateException if accessed without a running server. Required before acquiring audiences for players or CommandSource instances.

```java
public class MyMod implements ModInitializer {


    private volatile MinecraftServerAudiences adventure;


    public MinecraftServerAudiences adventure() {
        if (this.adventure == null) {
            throw new IllegalStateException("Tried to access Adventure without a running server!");
        }
        return this.adventure;
    }


    @Override
    public void onInitialize() {
        // Register with the server lifecycle callbacks
        // This will ensure any platform data is cleared between game instances
        // This is important on the integrated server, where multiple server instances
        // can exist for one mod initialization.
        ServerLifecycleEvents.SERVER_STARTING.register(server -> this.adventure = MinecraftServerAudiences.of(server));
        ServerLifecycleEvents.SERVER_STOPPED.register(server -> this.adventure = null);
    }
}
```

--------------------------------

### Head tag examples: UUID, texture, and name

Source: https://docs.papermc.io/adventure/minimessage/format

Three examples of the Head tag: using a UUID, using a texture path, and using a player name with the outer layer disabled. The tag inserts a player head.

```text
My favorite dev is <head:1f085b2d-9548-4159-a8c7-f3ccdf0c2054>.
```

```text
Do you prefer <head:entity/player/wide/steve> Steve or <head:entity/player/slim/alex> Alex?
```

```text
Thanks <head:Strokkur24:false> for the docs!
```

--------------------------------

### Gradle (Kotlin) dependency setup for Adventure mod shared

Source: https://docs.papermc.io/adventure/platform/modded

Adds the Maven snapshot repository and the `adventure-platform-mod-shared` dependency for Minecraft 26.3. Use with Loom or ModDevGradle.

```kotlin
repositories {
  // for development builds
  maven(url = "https://central.sonatype.com/repository/maven-snapshots/") {
    name = "central-snapshots"
    mavenContent { snapshotsOnly() }
  }
  // for releases
  mavenCentral()
}


dependencies {
  // Common module (Loom or ModDevGradle)
  compileOnly("net.kyori:adventure-platform-mod-shared:7.2.0") // for Minecraft 26.3
}
```

--------------------------------

### Selector Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Inserts a selector component, optionally with a separator.

```text

Hello <selector:@e[limit=5]>, I'm <selector:@s>!

```

--------------------------------

### Customizing MiniMessage with a builder

Source: https://docs.papermc.io/adventure/minimessage/api

Shows how to create a MiniMessage instance using the builder, specifying custom tag resolvers. The example uses StandardTags.color() and StandardTags.decorations() along with a custom resolver.

```java
final MiniMessage mm = MiniMessage.builder()
    .tags(TagResolver.builder()
      .resolver(StandardTags.color())
      .resolver(StandardTags.decorations())
      .resolver(this.someResolvers)
      .build()
    )
    .build();

```

--------------------------------

### Gradle (Groovy) dependency setup for Adventure mod shared

Source: https://docs.papermc.io/adventure/platform/modded

Adds the Maven snapshot repository and the `adventure-platform-mod-shared` dependency for Minecraft 26.3. Use with Loom or ModDevGradle.

```groovy
repositories {
  // for development builds
  maven {
    name = 'central-snapshots'
    url = 'https://central.sonatype.com/repository/maven-snapshots/'
    mavenContent { snapshotsOnly() }
  }
  // for releases
  mavenCentral()
}


dependencies {
  // Common module (Loom or ModDevGradle)
  compileOnly('net.kyori:adventure-platform-mod-shared:7.2.0') // for Minecraft 26.3
}
```

--------------------------------

### Tags with arguments

Source: https://docs.papermc.io/adventure/minimessage/format

Examples of tags that take arguments, such as hover and click events, showing the <tag:argument>content</tag> syntax.

```minimessage
<hover:show_text:"<red>test:TEST">TEST
<click:run_command:test>TEST
```

--------------------------------

### Fallback Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Displays a translation key or a fallback string if the translation is unavailable.

```text

You should get a <lang_or:block.minecraft.diamond_block:'Dirt Block'>!

```

--------------------------------

### Sponge plugin using injected SpongeAudiences

Source: https://docs.papermc.io/adventure/platform/spongeapi

Example plugin that injects SpongeAudiences via Guice. Provides an accessor method to retrieve the instance for use with players or MessageReceiver.

```java
@Plugin(/* [...] */)
public class MyPlugin {
    private final SpongeAudiences adventure;


    @Inject
    MyPlugin(final SpongeAudiences adventure) {
        this.adventure = adventure;
    }


    public SpongeAudiences adventure() {
        return this.adventure;
    }
}

```

--------------------------------

### Insert a component with Placeholder.component

Source: https://docs.papermc.io/adventure/minimessage/dynamic-replacements

Replaces a tag with a component. The component is inserted as-is, without parsing. The example inserts a red text component 'TEST' for the tag 'name'.

```java
MiniMessage.miniMessage().deserialize("<gray>Hello <name> :)", Placeholder.component("name", Component.text("TEST", NamedTextColor.RED)));
```

--------------------------------

### Serialize and deserialize with JSONComponentSerializer.json()

Source: https://docs.papermc.io/adventure/serializer/json

Shows basic usage of the JSON serializer: converting a Component to a JSON string and back. The example uses Component.text("Hello world", NamedTextColor.LIGHT_PURPLE) and JSONComponentSerializer.json().

```java
// Component to text
final String json = JSONComponentSerializer.json().serialize(Component.text("Hello world", NamedTextColor.LIGHT_PURPLE));


// JSON string to component
final Component component = JSONComponentSerializer.json().deserialize(json);
```

--------------------------------

### Insert a choice with MiniMessage choice formatter

Source: https://docs.papermc.io/adventure/minimessage/dynamic-replacements

Shows how to insert a number and format text based on the number using the choice formatter. It accepts a ChoiceFormat pattern. In this example, the output is 'I met many developers!'.

```java
MiniMessage.miniMessage().deserialize("<gray>I met <choice:'0#no developer|1#one developer|1<many developers'>!", Formatter.choice("choice", 5));
```

--------------------------------

### Shadow Color tag examples

Source: https://docs.papermc.io/adventure/minimessage/format

Examples of the shadow color tag, including optional alpha value and the alias to disable shadow.

```text
<shadow:yellow>Hello <shadow:aqua:0.5>World</shadow>!
<shadow:#FF5555>This is a <shadow:#55FF55>test!
<shadow:#000000FF><b>Thicc
```

--------------------------------

### Color (verbose) tag examples

Source: https://docs.papermc.io/adventure/minimessage/format

Examples of the verbose color tag using the <color:...> syntax with named or hex colors.

```text
<color:yellow>Hello <color:blue>World</color:blue>!
<color:#FF5555>This is a <color:#55FF55>test!
```

--------------------------------

### Sound.sound(Key, Sound.Source, float, float)

Source: https://docs.papermc.io/adventure/sound

Constructs a Sound object with a specified key, source, volume, and pitch. The key can be a built-in sound or a custom resource pack sound.

```APIDOC
## Sound.sound(Key, Sound.Source, float, float)

### Description
Constructs a Sound object with a specified key, source, volume, and pitch. The key can be a built-in sound or a custom resource pack sound.

### Method
Sound.sound(Key, Sound.Source, float, float)

### Parameters
- **key** (Key) - Required - The sound identifier (e.g., Key.key("music_disc.13") or Key.key("adventure", "rawr")).
- **source** (Sound.Source) - Required - The sound source (e.g., Sound.Source.MUSIC, Sound.Source.AMBIENT).
- **volume** (float) - Required - The volume/radius of the sound.
- **pitch** (float) - Required - The pitch of the sound, from 0 to 2.

### Request Example
```java
// Create a built-in sound using standard volume and pitch
Sound musicDisc = Sound.sound(Key.key("music_disc.13"), Sound.Source.MUSIC, 1F, 1F);

// Create a sound from our resource pack with a higher pitch
Sound myCustomSound = Sound.sound(Key.key("adventure", "rawr"), Sound.Source.AMBIENT, 1F, 1.1F);
```

### Response
No return value; constructs a Sound object.
```

--------------------------------

### Get pointers from an audience

Source: https://docs.papermc.io/adventure/audiences

Use the pointer system to retrieve arbitrary information from an audience, such as UUID or display name, with get and getOrDefault.

```java
// get the uuid from an audience member, returning an Optional<UUID>
audience.get(Identity.UUID);


// get the display name, returning a default
audience.getOrDefault(Identity.DISPLAY_NAME, Component.text("no display name!"));
```

--------------------------------

### NBT tag example: health

Source: https://docs.papermc.io/adventure/minimessage/format

Example of the NBT tag using an entity selector and a path to display health. The syntax is <nbt:entity:'@s':Health/>.

```text
Your health is <nbt:entity:'@s':Health/>
```

--------------------------------

### Create a TextComponent with fluent API

Source: https://docs.papermc.io/adventure/text

Builds a text component with colored and styled text using the fluent API. The example creates a line saying "You're a Bunny! Press <key> to jump!" with a custom color, a light purple bold keybind, and appends multiple text parts. The resulting component can be sent to a client.

```java
// Creates a line of text saying "You're a Bunny! Press <key> to jump!", with some coloring and styling.
final TextComponent textComponent = Component.text("You're a ")
  .color(TextColor.color(0x443344))
  .append(Component.text("Bunny", NamedTextColor.LIGHT_PURPLE))
  .append(Component.text("! Press "))
  .append(
    Component.keybind("key.jump")
      .color(NamedTextColor.LIGHT_PURPLE)
      .decoration(TextDecoration.BOLD, true)
  )
  .append(Component.text(" to jump!"));
// now you can send `textComponent` to something, such as a client
```

--------------------------------

### Color tag examples

Source: https://docs.papermc.io/adventure/minimessage/format

Examples of the color tag using named colors and hex colors. The tag colors the next parts. Hex colors use the format #RRGGBB.

```text
<yellow>Hello <blue>World</blue>!
<red>This is a <green>test!
<#00ff00>R G B!
```

--------------------------------

### Sprite tag examples: blocks, items, and custom namespace

Source: https://docs.papermc.io/adventure/minimessage/format

Three examples of the Sprite tag: using the blocks atlas, the items atlas, and a custom namespace. The tag inserts a sprite from the specified atlas.

```text
Look at my <sprite:blocks:block/stone>!
```

```text
This item costs 10 x <sprite:"minecraft:items":item/porkchop>.
```

```text
This is a custom texture from a namespace: <sprite:items:"custom:item/ruby">
```

--------------------------------

### Pride tag examples: default and trans flags

Source: https://docs.papermc.io/adventure/minimessage/format

Two examples of the Pride tag: one using the default flag and one using the trans flag. The tag applies a gradient to the enclosed text.

```text
Happy <pride>pride month</pride>!
```

```text
Kyori supports <pride:trans>trans rights</pride>!
```

--------------------------------

### SoundStop.all()

Source: https://docs.papermc.io/adventure/sound

Constructs a SoundStop that stops all sounds.

```APIDOC
## SoundStop.all()

### Description
Constructs a SoundStop that stops all sounds.

### Method
SoundStop.all()

### Request Example
```java
SoundStop.all()
```

### Response
Returns a SoundStop object.
```

--------------------------------

### Newline Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Inserts a newline character into the text.

```text

Let me insert a <newline>line break here.
<hover:show_text:'<red>Hover with a<newline><green>line break'>Text with<newline>line break</hover>

```

--------------------------------

### Create a custom clickable tag with TagResolver

Source: https://docs.papermc.io/adventure/minimessage/dynamic-replacements

Creates a custom tag 'click_by_version' that opens Adventure javadocs for a given version. The tag expects one argument (the version) and throws an error if missing. Usage: <click_by_version:'5.2.0'>.

```java
TagResolver.resolver("click_by_version", (args, context) -> {
  final String version = args.popOr("version expected").value();
  return Tag.styling(ClickEvent.openUrl("https://jd.papermc.io/adventure/" + version + "/"));
});
// creates a tag to get javadocs of adventure by the version: <click_by_version:'5.2.0'>
```

--------------------------------

### Font Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Changes the font of the text using a namespaced key.

```text

Nothing <font:uniform>Uniform <font:alt>Alt  </font> Uniform
<font:myfont:custom_font>Uses a custom font from a resource pack</font>

```

--------------------------------

### Construct and show a BossBar with Audience

Source: https://docs.papermc.io/adventure/bossbar

Shows how to construct a BossBar with a component title, progress from 0 to 1, a color, and an overlay, then send it to an Audience and store it for later hiding. The color is downsampled for clients below 1.9.

```java
private @Nullable BossBar activeBar;


public void showMyBossBar(final Audience target) {
  final Component name = Component.text("Awesome BossBar");
  // Creates a red boss bar which has no progress and no notches
  final BossBar emptyBar = BossBar.bossBar(name, 0, BossBar.Color.RED, BossBar.Overlay.PROGRESS);
  // Creates a green boss bar which has 50% progress and 10 notches
  final BossBar halfBar = BossBar.bossBar(name, 0.5F, BossBar.Color.GREEN, BossBar.Overlay.NOTCHED_10);
  // etc..
  final BossBar fullBar = BossBar.bossBar(name, 1, BossBar.Color.BLUE, BossBar.Overlay.NOTCHED_20);


  // Send a bossbar to your audience
  target.showBossBar(fullBar);


  // Store it locally to be able to hide it manually later
  this.activeBar = fullBar;
}


public void hideActiveBossBar(final Audience target) {
  target.hideBossBar(this.activeBar);
  this.activeBar = null;
}
```

--------------------------------

### Insertion Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Allows text to be inserted into chat via shift-click.

```text

Shift-click <insert:test>this</insert> to insert!

```

--------------------------------

### Send a required resource pack using ResourcePackRequest

Source: https://docs.papermc.io/adventure/resource-pack

Defines a static ResourcePackInfo with a URI and SHA-1 hash, then sends a required resource pack request to an Audience. The prompt is displayed to the user if they haven't yet chosen to allow server resource packs.

```java
private static final ResourcePackInfo PACK_INFO = ResourcePackInfo.resourcePackInfo()
  .uri(URI.create("https://example.com/resourcepack.zip"))
  .hash("2849ace6aa689a8c610907a41c03537310949294")
  .build();


public void sendResourcePack(final Audience target) {
  final ResourcePackRequest request = ResourcePackRequest.resourcePackRequest()
    .packs(PACK_INFO)
    .prompt(Component.text("Please download the resource pack!"))
    .required(true)
    .build();


  // Send the resource pack request to the target audience
  target.sendResourcePacks(request);
}


public void sendOptionalResourcePack(final Audience target) {
  final ResourcePackRequest request = ResourcePackRequest.resourcePackRequest()
    .packs(PACK_INFO)
    .prompt(Component.text("Please download the resource pack!"))
    .required(false)
    .build();


  // Send the resource pack request to the target audience
  target.sendResourcePacks(request);
}
```

--------------------------------

### Create a MiniMessage tag resolver for PlaceholderAPI placeholders

Source: https://docs.papermc.io/adventure/faq

Use this method to create a TagResolver that resolves PlaceholderAPI placeholders for a given player. The tag format is `<papi:[papi_placeholder]>`, for example `<papi:luckperms_prefix>`. The resolver parses the placeholder with PlaceholderAPI, converts the legacy string to a Component using LegacyComponentSerializer, and returns a self-closing inserting tag. Credit to mbaxter.

```java
/**
* Creates a tag resolver capable of resolving PlaceholderAPI tags for a given player.
*
* @param player the player
* @return the tag resolver
*/
public TagResolver papiTag(final Player player) {
    return TagResolver.resolver("papi", (argumentQueue, context) -> {
        // Get the string placeholder that they want to use.
        final String papiPlaceholder = argumentQueue.popOr("papi tag requires an argument").value();


        // Then get PAPI to parse the placeholder for the given player.
        final String parsedPlaceholder = PlaceholderAPI.setPlaceholders(player, '%' + papiPlaceholder + '%');


        // We need to turn this ugly legacy string into a nice component.
        final Component componentPlaceholder = LegacyComponentSerializer.legacySection().deserialize(parsedPlaceholder);


        // Finally, return the tag instance to insert the placeholder!
        return Tag.selfClosingInserting(componentPlaceholder);
    });
}
```

--------------------------------

### Rainbow Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Applies a rainbow color effect to text, with an optional reverse flag and phase.

```text

<yellow>Woo: <rainbow>||||||||||||||||||||||||</rainbow>!
<yellow>Woo: <rainbow:!>||||||||||||||||||||||||</rainbow>!
<yellow>Woo: <rainbow:2>||||||||||||||||||||||||</rainbow>!
<yellow>Woo: <rainbow:!2>||||||||||||||||||||||||</rainbow>!

```

--------------------------------

### Set up MinecraftServerAudiences for server-side Adventure

Source: https://docs.papermc.io/adventure/platform/neoforge

Creates a MinecraftServerAudiences instance in a @Mod class, registering server lifecycle callbacks to manage the instance between game instances. Throws IllegalStateException if accessed without a running server.

```java
@Mod("my_mod")
public class MyMod {


    private volatile MinecraftServerAudiences adventure;


    public MinecraftServerAudiences adventure() {
        if (this.adventure == null) {
            throw new IllegalStateException("Tried to access Adventure without a running server!");
        }
        return this.adventure;
    }


    public MyMod() {
        // Register with the server lifecycle callbacks
        // This will ensure any platform data is cleared between game instances
        // This is important on the integrated server, where multiple server instances
        // can exist for one mod initialization.
        NeoForge.EVENT_BUS.addListener((ServerStartingEvent e) ->
            this.adventure = MinecraftServerAudiences.of(e.getServer())
        );
        NeoForge.EVENT_BUS.addListener((ServerStoppedEvent e) ->
            this.adventure = null
        );
    }
}
```

--------------------------------

### Translatable Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Displays Minecraft messages using the player's locale with optional placeholders.

```text

You should get a <lang:block.minecraft.diamond_block>!
<lang:commands.drop.success.single:'<red>1':'<blue>Stone'>!

```

--------------------------------

### Gradient Tag Example

Source: https://docs.papermc.io/adventure/minimessage/format

Applies a gradient color effect using hex or named colors, with an optional phase.

```text

<yellow>Woo: <gradient>||||||||||||||||||||||||</gradient>!
<yellow>Woo: <gradient:#5e4fa2:#f79459>||||||||||||||||||||||||</gradient>!
<yellow>Woo: <gradient:#5e4fa2:#f79459:red>||||||||||||||||||||||||</gradient>!
<yellow>Woo: <gradient:green:blue>||||||||||||||||||||||||</gradient>!

```
Tokens:
Raw