PaperMC Docs

https://docs.papermc.io/
Admin
Comprehensive documentation for PaperMC projects including Paper, Velocity, Folia, Adventure, and...
Tokens:266,445
Snippets:2,691
Trust Score:10
Update:17 hours ago
Show doc for...
Tokens:
Raw
### Velocity proxy startup log output

Source: https://docs.papermc.io/velocity/getting-started/

Sample console output after starting the Velocity proxy, showing boot messages, plugin loading, listening address, and completion time. Use this to verify the proxy launched successfully.

```text
[05:41:13 INFO]: Booting up Velocity 4.2.1-SNAPSHOT (git-74c932e5-b363)...
[05:41:13 INFO]: Loading localizations...
[05:41:13 INFO]: Connections will use epoll channels, libdeflate (Linux aarch64) compression, OpenSSL (Linux aarch64) ciphers
[05:41:13 INFO]: Loading plugins...
[05:41:13 INFO]: Loaded 0 plugins
[05:41:13 INFO]: Listening on /[0:0:0:0:0:0:0:0%0]:25565
[05:41:13 INFO]: Done (0.36s)!
```

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

### Run Waterfall proxy with basic Java command

Source: https://docs.papermc.io/waterfall/getting-started/

Starts the Waterfall proxy with 512 MB of initial and maximum heap memory. Replace 'waterfall-###.jar' with the actual JAR filename.

```bash
java -Xms512M -Xmx512M -jar waterfall-###.jar
```

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

### Run Waterfall proxy with Aikar's recommended flags

Source: https://docs.papermc.io/waterfall/getting-started/

Starts the Waterfall proxy with Aikar's recommended JVM flags for improved performance. Adjust memory by changing the -Xms and -Xmx values.

```bash
java -Xms512M -Xmx512M -XX:+UseG1GC -XX:G1HeapRegionSize=4M -XX:+UnlockExperimentalVMOptions -XX:+ParallelRefProcEnabled -XX:+AlwaysPreTouch -jar waterfall-###.jar
```

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

### MySQL connection setup with HikariCP

Source: https://docs.papermc.io/paper/dev/using-databases/

Configures a HikariDataSource for a standalone MySQL database. Requires a running MySQL instance. The example sets the JDBC URL, credentials, and pool size, then obtains a connection using try-with-resources to auto-close it.

```java
public class DatabaseManager {

    public void connect() {
        HikariConfig config = new HikariConfig();
        config.setJdbcUrl("jdbc:mysql://localhost:3306/mydatabase"); // Address of your running MySQL database
        config.setUsername("username"); // Username
        config.setPassword("password"); // Password
        config.setMaximumPoolSize(10); // Pool size defaults to 10

        config.addDataSourceProperty("", ""); // MISC settings to add
        HikariDataSource dataSource = new HikariDataSource(config);

        try (Connection connection = dataSource.getConnection()) {
            // Use a try-with-resources here to autoclose the connection.
            PreparedStatement sql = connection.prepareStatement("SQL");
            // Execute statement
        } catch (Exception e) {
            // Handle any exceptions that arise from getting / handing the exception.
        }
    }
}
```

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

### Run Paper server with Java command

Source: https://docs.papermc.io/paper/getting-started/

Short terminal command to start a Paper server. Requires Java 25 and a downloaded paper.jar in the current directory; replace paper.jar with your JAR name. Adjust RAM via Xms and Xmx values; --nogui disables Vanilla's GUI to avoid double interfaces when using the command line.

```bash
java -Xms4G -Xmx4G -jar paper.jar --nogui
```

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

### Expected output of java -version for Java 25

Source: https://docs.papermc.io/misc/java-install/

Example output from the java -version command after a successful Java 25 installation. Look for 'openjdk 25' at the start and '64-Bit' in the last line.

```text
openjdk version "25" 2025-09-16
OpenJDK Runtime Environment (build 25+36-3489)
OpenJDK 64-Bit Server VM (build 25+36-3489, mixed mode, sharing)
```

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

### Getting the latest version with curl and jq

Source: https://docs.papermc.io/misc/downloads-service/

Requires jq (install with `sudo apt-get install jq` on Debian/Ubuntu). Fetches the latest available Minecraft version for the given project from the PaperMC downloads API.

```sh
#!/usr/bin/env sh

PROJECT="paper"
USER_AGENT="cool-project/1.0.0 ([email protected])"

LATEST_VERSION=$(curl -s -H "User-Agent: $USER_AGENT" https://fill.papermc.io/v3/projects/${PROJECT} | \
    jq -r '.versions | to_entries[0] | .value[0]')

echo "Latest version is $LATEST_VERSION"
```

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

### Add snapshot repository with Maven

Source: https://docs.papermc.io/adventure/getting-started/

Adds the Maven snapshot repository for Adventure snapshot builds in a pom.xml file.

```xml
<repositories>
  <repository>
    <id>central-snapshots</id>
    <url>https://central.sonatype.com/repository/maven-snapshots/</url>
  </repository>
</repositories>
```

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

### Set up MinecraftServerAudiences on NeoForge server

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

Initializes a MinecraftServerAudiences instance on the NeoForge logical server, registering lifecycle callbacks to clear platform data between game instances. Accessing the audience provider before the server starts throws an IllegalStateException.

```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
        );
    }
}
```

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

### Launch Velocity on macOS or Linux with start.sh

Source: https://docs.papermc.io/velocity/getting-started/

Creates a start.sh script to launch Velocity on macOS or Linux. Requires Java 25. After saving, run 'chmod u+x start.sh' to make it executable, then run './start.sh'.

```shell
#!/bin/sh

java -Xms1G -Xmx1G -XX:+UseG1GC -XX:G1HeapRegionSize=4M -XX:+UnlockExperimentalVMOptions -XX:+ParallelRefProcEnabled -XX:+AlwaysPreTouch -XX:MaxInlineLevel=15 -jar velocity*.jar
```

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

### GET /v3/projects/{project}/versions/{version}/builds

Source: https://docs.papermc.io/misc/downloads-service/

Retrieves the list of builds for a specific project and Minecraft version. The response is an array of build objects, each containing an id, channel (e.g., STABLE), and download URLs.

```APIDOC
## GET /v3/projects/{project}/versions/{version}/builds

### Description
Retrieves the list of builds for a specific project and Minecraft version. The response is an array of build objects, each containing an id, channel (e.g., STABLE), and download URLs.

### Method
GET

### Endpoint
https://fill.papermc.io/v3/projects/{project}/versions/{version}/builds

### Parameters
#### Path Parameters
- **project** (string) - Required - The project identifier (e.g., "paper").
- **version** (string) - Required - The Minecraft version (e.g., "26.3").

### Request Example
```sh
curl -s -H "User-Agent: cool-project/1.0.0 ([email protected])" https://fill.papermc.io/v3/projects/paper/versions/26.3/builds
```

### Response
#### Success Response (200)
- **id** (integer) - The build number.
- **channel** (string) - The channel of the build (e.g., "STABLE").
- **downloads** (object) - An object containing download URLs, e.g., "server:default".

#### Response Example
```json
[
  {
    "id": 123,
    "channel": "STABLE",
    "downloads": {
      "server:default": {
        "url": "https://example.com/download"
      }
    }
  }
]
```

```

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

### Launch Velocity on Windows with start.bat

Source: https://docs.papermc.io/velocity/getting-started/

Creates a start.bat file to launch Velocity on Windows. Requires Java 25. Change 'velocity.jar' to the name of the downloaded JAR or rename the JAR to 'velocity.jar'. Double-click the file to run.

```batch
@echo off
java -Xms1G -Xmx1G -XX:+UseG1GC -XX:G1HeapRegionSize=4M -XX:+UnlockExperimentalVMOptions -XX:+ParallelRefProcEnabled -XX:+AlwaysPreTouch -XX:MaxInlineLevel=15 -jar velocity.jar
pause
```

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

### GET /v3/projects/{project}

Source: https://docs.papermc.io/misc/downloads-service/

Retrieves the available versions for a given project. The response contains a versions object where each key is a version group and the value is an array of version strings.

```APIDOC
## GET /v3/projects/{project}

### Description
Retrieves the available versions for a given project. The response contains a versions object where each key is a version group and the value is an array of version strings.

### Method
GET

### Endpoint
https://fill.papermc.io/v3/projects/{project}

### Parameters
#### Path Parameters
- **project** (string) - Required - The project identifier (e.g., "paper").

### Request Example
```sh
curl -s -H "User-Agent: cool-project/1.0.0 ([email protected])" https://fill.papermc.io/v3/projects/paper
```

### Response
#### Success Response (200)
- **versions** (object) - An object mapping version groups to arrays of version strings.

#### Response Example
```json
{
  "versions": {
    "1.20": ["1.20.1", "1.20.2"]
  }
}
```

```

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

### Example response for LatestStableBuildDownloadURL

Source: https://docs.papermc.io/misc/downloads-service/

Example JSON response returned by the query. It shows the latest stable version (1.21.10), build number 48, and the download details including the file name, URL, SHA256 checksum, and size in bytes.

```json
{
    "data": {
        "project": {
            "key": "paper",
            "versions": {
                "edges": [
                    {
                        "node": {
                            "key": "1.21.10",
                            "builds": {
                                "edges": [
                                    {
                                        "node": {
                                            "number": 48,
                                            "download": {
                                                "name": "paper-1.21.10-48.jar",
                                                "url": "https://fill-data.papermc.io/v1/objects/bfca155b4a6b45644bfc1766f4e02a83c736e45fcc060e8788c71d6e7b3d56f6/paper-1.21.10-48.jar",
                                                "checksums": {
                                                    "sha256": "bfca155b4a6b45644bfc1766f4e02a83c736e45fcc060e8788c71d6e7b3d56f6"
                                                },
                                                "size": 54185955
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    }
}
```

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

### User-Agent header examples

Source: https://docs.papermc.io/misc/downloads-service/

All requests must include a valid User-Agent header that clearly identifies your software or company, is not generic (e.g., curl, wget), and includes a contact URL or email address. These are example User-Agent strings.

```text
mc-image-helper/1.39.11 (https://github.com/itzg/docker-minecraft-server)
nodecraft/packifier/1.0.0 ([email protected])
```

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

### velocity.toml [servers] section initial configuration

Source: https://docs.papermc.io/velocity/getting-started/

Initial `[servers]` section in `velocity.toml`. Each key is a server name and the value is the IP address and port. The `try` list defines the order Velocity attempts when a player logs in or is kicked. Replace `lobby` in `try` if you rename that server.

```toml
[servers]
# Configure your servers here. Each key represents the server's name, and the value
# represents the IP address of the server to connect to.
lobby = "127.0.0.1:30066"
factions = "127.0.0.1:30067"
minigames = "127.0.0.1:30068"

# In what order we should try servers when a player logs in or is kicked from a server.
try = [
  "lobby",
  "factions"
]
```

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

### Install prerequisites for Java on Debian-based systems

Source: https://docs.papermc.io/misc/java-install/

Run these commands to update the package list and install required tools (ca-certificates, apt-transport-https, gnupg, wget) before adding the Corretto repository.

```bash
sudo apt-get update
sudo apt-get install ca-certificates apt-transport-https gnupg wget
```

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

### Multiple dependency examples

Source: https://docs.papermc.io/paper/dev/getting-started/paper-plugins/

Examples of declaring multiple dependencies with different load orders and classpath requirements. The first requires ProtocolLib to load before, the second loads a shop plugin after, and the third accesses another plugin's classpath.

```yaml
# Suppose we require ProtocolLib to be loaded for our plugin
ProtocolLib:
  load: BEFORE
  required: true

# Now, we are going to register some details for a shop plugin
# So the shop plugin should load after our plugin
SuperShopsXUnlimited:
  load: AFTER
  required: false

# Now, we are going to need to access a plugins classpath
# So that we can properly interact with it.
SuperDuperTacoParty:
  required: true
  join-classpath: true

```

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

### Getting data from PDC with getOrDefault

Source: https://docs.papermc.io/paper/dev/pdc/

Retrieves a value from the world's PersistentDataContainer using the same key and world as the adding-data example. Use getOrDefault instead of get when a non-null value is required, such as for Adventure's Component#text(String); the default "<null>" is returned if the key is absent.

```java
NamespacedKey key = ...; // Use the same key as the adding-data example
World world = ...; // Use the same world as the adding-data example

PersistentDataContainer pdc = world.getPersistentDataContainer();

// Utilize the data from the PDC
String value = pdc.getOrDefault(key, PersistentDataType.STRING, "<null>");

// Do something with the value
player.sendPlainMessage(value);
```

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

### Implement PluginBootstrap in ExamplePluginBootstrap.java

Source: https://docs.papermc.io/paper/dev/getting-started/paper-plugins/

Defines a bootstrapper by implementing PluginBootstrap and overriding bootstrap() and createPlugin(). The createPlugin() method returns a new ExamplePlugin instance with a custom constructor parameter. Bootstrappers are experimental and may change as more API is introduced.

```java
public final class ExamplePluginBootstrap implements PluginBootstrap {

    @Override
    public void bootstrap(final BootstrapContext context) {

    }

    @Override
    public JavaPlugin createPlugin(final PluginProviderContext context) {
        return new ExamplePlugin("My custom parameter");
    }

}
```

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

### Add Adventure API dependency with Maven

Source: https://docs.papermc.io/adventure/getting-started/

Declares the Adventure API dependency in a Maven pom.xml file.

```xml
<dependency>
  <groupId>net.kyori</groupId>
  <artifactId>adventure-api</artifactId>
  <version>5.2.0</version>
</dependency>
```

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

### softdepend: list of optional plugins

Source: https://docs.papermc.io/paper/dev/plugin-yml/

Specifies plugins that are needed for full functionality but are not required for loading.

```yaml
softdepend: [Vault, WorldEdit]
```

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

### ExamplePlugin.java - Main class extending JavaPlugin

Source: https://docs.papermc.io/paper/dev/project-setup/

Entry point for a Paper plugin. Registers the plugin as an event listener and sends a plain message to players on join. The class should be named descriptively, not 'Main'.

```java
package com.example.paperplugin;

import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;

public final class ExamplePlugin extends JavaPlugin implements Listener {
    @Override
    public void onEnable() {
        this.getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onPlayerJoin(PlayerJoinEvent event) {
        event.getPlayer().sendPlainMessage("Hello, " + event.getPlayer().getName() + "!");
    }
}

```

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

### loadbefore: load before other plugins

Source: https://docs.papermc.io/paper/dev/plugin-yml/

Specifies plugins that should be loaded after your plugin, useful when another plugin needs your API.

```yaml
loadbefore: [Vault, FactionsUUID]
```

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

### Check Java version with java -version

Source: https://docs.papermc.io/misc/java-install/

Run this command in your terminal to verify that Java 25 was installed successfully. The output should start with 'openjdk 25' and contain '64-Bit' in the last line. If you see 'java: command not found', try creating a new terminal session.

```bash
java -version
```

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

### Set system property with -D flag in start command

Source: https://docs.papermc.io/paper/reference/system-properties/

Add system properties to your server start command using the -D flag. The example sets com.mojang.eula.agree to true. When using PowerShell, wrap properties containing a dot in quotes, e.g. "-Dcom.mojang.eula.agree=true".

```bash
java -Dcom.mojang.eula.agree=true -jar paper.jar
```

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

### Create and register a TranslationStore

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

Shows how to build a message-format TranslationStore, register a single translation, and add it to the global translator. Use TranslationStore#component(Key) for component-based stores. Additional methods exist for bulk registration from resource bundles.

```java
// As above, every translator needs an identifying name!
// Could also use TranslationStore#component(Key) to work with components instead.
final TranslationStore.StringBased<MessageFormat> myStore = TranslationStore.messageFormat(Key.key("mynamespace:mykey"));

// You can add translations one-by-one, or in bulk. Consult the Javadocs for a full list of methods.
myStore.register("mytranslation.key", Locale.US, new MessageFormat("Hello {0}!", Locale.US));

// You can then register this to the global translator so the translations are available there!
GlobalTranslator.translator().addSource(myStore);
```

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

### SQLite connection setup with Class.forName and DriverManager

Source: https://docs.papermc.io/paper/dev/using-databases/

Initializes the SQLite JDBC driver and creates a Connection to a file-based database. The driver is bundled with Paper, so no shading is required. The connection URL points to a database file under plugins/ExamplePlugin/.

```java
public class DatabaseManager {

    public void connect() {
        Class.forName("org.sqlite.JDBC");
        Connection connection = DriverManager.getConnection("jdbc:sqlite:plugins/ExamplePlugin/database.db");
    }
}
```

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

### LatestStableBuild

Source: https://docs.papermc.io/misc/downloads-service/

Query to retrieve the latest stable build number for the latest version of a project. It filters builds by the STABLE channel and orders them descending to get the most recent build.

```APIDOC
## GraphQL Query: LatestStableBuild

### Description
Retrieves the latest stable build number for the latest version of a project. It filters builds by the STABLE channel and orders them descending to get the most recent build.

### Endpoint
https://fill.papermc.io/graphql

### Query
```graphql
query LatestStableBuild {
    project(key: "paper") {
        key
        versions(first: 1, orderBy: {direction: DESC}) {
            edges {
                node {
                    key
                    builds(filterBy: { channel: STABLE }, first: 1, orderBy: { direction: DESC }) {
                        edges {
                            node {
                                number
                            }
                        }
                    }
                }
            }
        }
    }
}
```

### Response Example
```json
{
    "data": {
        "project": {
            "key": "paper",
            "versions": {
                "edges": [
                    {
                        "node": {
                            "key": "1.21.10",
                            "builds": {
                                "edges": [
                                    {
                                        "node": {
                                            "number": 48
                                        }
                                    }
                                ]
                            }
                        }
                    }
                ]
            }
        }
    }
}
```
```

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

### load field

Source: https://docs.papermc.io/paper/dev/plugin-yml/

Tells the server when to load the plugin. Can be STARTUP or POSTWORLD; defaults to POSTWORLD if not specified.

```yaml
load: STARTUP
```

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

### Add snapshot repository with Gradle Groovy DSL

Source: https://docs.papermc.io/adventure/getting-started/

Adds the Maven snapshot repository for Adventure snapshot builds in a Gradle Groovy DSL build file (build.gradle).

```groovy
repositories {
  maven {
    name = 'central-snapshots'
    url = 'https://central.sonatype.com/repository/maven-snapshots/'
  }
}
```

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

### Add snapshot repository with Gradle Kotlin DSL

Source: https://docs.papermc.io/adventure/getting-started/

Adds the Maven snapshot repository for Adventure snapshot builds in a Gradle Kotlin DSL build file (build.gradle.kts).

```kotlin
repositories {
  maven(url = "https://central.sonatype.com/repository/maven-snapshots/") {
    name = "central-snapshots"
  }
}
```

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

### Downloading the latest stable build with curl and jq

Source: https://docs.papermc.io/misc/downloads-service/

Requires jq. Downloads the latest stable build for a given project and Minecraft version, falling back to the newest version with a stable build if the requested version has none. Checks for API errors and exits with a message if no stable builds are available. Always serve and use stable builds; experimental builds are prone to error and unsupported.

```sh
#!/usr/bin/env sh

PROJECT="paper"
MINECRAFT_VERSION="26.3"
USER_AGENT="cool-project/1.0.0 ([email protected])"

# First check if the requested version has a stable build
BUILDS_RESPONSE=$(curl -s -H "User-Agent: $USER_AGENT" https://fill.papermc.io/v3/projects/${PROJECT}/versions/${MINECRAFT_VERSION}/builds)

# Check if the API returned an error
if echo "$BUILDS_RESPONSE" | jq -e '.ok == false' > /dev/null 2>&1; then
  ERROR_MSG=$(echo "$BUILDS_RESPONSE" | jq -r '.message // "Unknown error"')
  echo "Error: $ERROR_MSG"
  exit 1
fi

# Try to get a stable build URL for the requested version
PAPERMC_URL=$(echo "$BUILDS_RESPONSE" | jq -r 'first(.[] | select(.channel == "STABLE") | .downloads."server:default".url) // "null"')
FOUND_VERSION="$MINECRAFT_VERSION"

# If no stable build for requested version, find the latest version with a stable build
if [ "$PAPERMC_URL" == "null" ]; then
  echo "No stable build for version $MINECRAFT_VERSION, searching for latest version with stable build..."

  # Get all versions for the project (using the same endpoint structure as the "Getting the latest version" example)
  # The versions are organized by version group, so we need to extract all versions from all groups
  # Then sort them properly as semantic versions (newest first)
  VERSIONS=$(curl -s -H "User-Agent: $USER_AGENT" https://fill.papermc.io/v3/projects/${PROJECT} | \
    jq -r '.versions | to_entries[] | .value[]' | \
    sort -V -r)

  # Iterate through versions to find one with a stable build
  for VERSION in $VERSIONS; do
    VERSION_BUILDS=$(curl -s -H "User-Agent: $USER_AGENT" https://fill.papermc.io/v3/projects/${PROJECT}/versions/${VERSION}/builds)

    # Check if this version has a stable build
    STABLE_URL=$(echo "$VERSION_BUILDS" | jq -r 'first(.[] | select(.channel == "STABLE") | .downloads."server:default".url) // "null"')

    if [ "$STABLE_URL" != "null" ]; then
      PAPERMC_URL="$STABLE_URL"
      FOUND_VERSION="$VERSION"
      echo "Found stable build for version $VERSION"
      break
    fi
  done
fi

if [ "$PAPERMC_URL" != "null" ]; then
  # Download the latest Paper version
  curl -o server.jar $PAPERMC_URL
  echo "Download completed (version: $FOUND_VERSION)"
else
  echo "No stable builds available for any version :("
  exit 1
fi
```

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

### Add Adventure API dependency with Gradle Groovy DSL

Source: https://docs.papermc.io/adventure/getting-started/

Declares the Adventure API dependency in a Gradle Groovy DSL build file (build.gradle). Requires the mavenCentral() repository.

```groovy
repositories {
  mavenCentral()
}

dependencies {
  implementation 'net.kyori:adventure-api:5.2.0'
}
```

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

### Start server with remote debugger arguments

Source: https://docs.papermc.io/paper/dev/debugging/

Use these JVM arguments in your server startup script to enable remote debugging. Place them after the `java` command and before `-jar`. The `suspend=n` setting lets the server start without waiting for a debugger connection.

```bash
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar paper-26.3.jar --nogui
```

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

### Add Adventure API dependency with Gradle Kotlin DSL

Source: https://docs.papermc.io/adventure/getting-started/

Declares the Adventure API dependency in a Gradle Kotlin DSL build file (build.gradle.kts). Requires the mavenCentral() repository.

```kotlin
repositories {
  mavenCentral()
}

dependencies {
  implementation("net.kyori:adventure-api:5.2.0")
}
```

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

### description field

Source: https://docs.papermc.io/paper/dev/plugin-yml/

Provides a short plugin description shown in plugin info commands.

```yaml
description: An example plugin
```

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

### Optimal builder usage with static imports

Source: https://docs.papermc.io/paper/dev/component-api/introduction/

Shows the recommended builder approach to create the same component as the previous example, using static method imports to reduce verbosity. The comment notes Adventure Components are designed for use with static method imports.

```java
/* This is an optimal use of the builder to create
   the same component. Also note that Adventure
   Components are designed for use with static method imports
   to make code less verbose */
final Component component = text()
    .content("Hello").color(color(0x13f832))
    .append(text(" world!", GREEN))
    .build();
```

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

### Import Amazon Corretto public key and apt repository

Source: https://docs.papermc.io/misc/java-install/

Adds the Corretto signing key and repository to /etc/apt/sources.list.d/corretto.list for Debian-based distributions.

```bash
wget -O - https://apt.corretto.aws/corretto.key | sudo gpg --dearmor -o /usr/share/keyrings/corretto-keyring.gpg && \
echo "deb [signed-by=/usr/share/keyrings/corretto-keyring.gpg] https://apt.corretto.aws stable main" | sudo tee /etc/apt/sources.list.d/corretto.list
```

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

### Send a message using MinecraftClientAudiences audience

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

Use MinecraftClientAudiences.of().audience() to get the client audience and send a message. This only works when the player is in-game. The full Audience interface is available, including localization.

```java
void doThing() {
  // Get the audience
  final Audience client = MinecraftClientAudiences.of().audience();

  // Do something. This will only work when the player is ingame.
  client.sendMessage(Component.text("meow", NamedTextColor.DARK_PURPLE));
}
```

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

### Velocity shutdown command and output

Source: https://docs.papermc.io/velocity/getting-started/

Console interaction to shut down the proxy: type `end` and press enter. The output shows the shutdown messages and closing of the endpoint. If using the Windows batch script, the window will prompt to press a key.

```text
> end
[05:42:10 INFO]: Shutting down the proxy...
[05:42:10 INFO]: Closing endpoint /0.0.0.0:25565
```

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

### id field example

Source: https://docs.papermc.io/velocity/dev/velocity-plugin-json/

Shows the required id field. Plugin IDs must start with a lowercase letter and may contain lowercase letters, digits, hyphens, and underscores. Total length must not exceed 64 characters.

```json
{"id": "a_cool_plugin"}
```

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

### Create and show a notice dialog with Dialog#create

Source: https://docs.papermc.io/paper/dev/dialogs/

Builds a minimal notice-type Dialog using Dialog#create, requiring a base (built from a title Component) and a type, then shows it to a player with player.showDialog(dialog).

```java
Dialog dialog = Dialog.create(builder -> builder.empty()
    .base(DialogBase.builder(text("Title")).build())
    .type(DialogType.notice())
);
player.showDialog(dialog);
```
Tokens:
Raw