Back to mods
PAPIProxyBridge project artwork

Modrinth · Minecraft mod

PAPIProxyBridge

A bridge library plugin for using PlaceholderAPI on proxy servers

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which PAPIProxyBridge release should I use?

Updated 2 months ago
Latest stable file 1.8.4
Game version 1.17.1, 1.18, 1.18.1
Loader velocity

PAPIProxyBridge 1.8.4 targets 1.17.1, 1.18, 1.18.1 with velocity. Do not install it on the client. It must be installed on the dedicated server. No extra mods listed for this file.

Where it goes

Is PAPIProxyBridge required on the client, server, or both?

Do not install it on the client. It must be installed on the dedicated server.

Client Not supported
Dedicated server Required
Loader for this release velocity
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This file is marked server-only.

What else does PAPIProxyBridge 1.8.4 need?

1.8.4. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add PAPIProxyBridge without breaking your instance.

Built for PAPIProxyBridge 1.8.4. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.8.4. It targets 1.17.1, 1.18, 1.18.1 with velocity; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Do not install it on the client. It must be installed on the dedicated server.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.8.4. It opens that exact file at the source.

About this project

What does PAPIProxyBridge add?

​

PAPIProxyBridge is a library bridge plugin you install on both your backend and proxy servers that allows proxy plugins to format text with PlaceholderAPI placeholders.

For server owners

This is a library plugin intended for use with plugins that implement its API. There is nothing to configure.

Install the latest version of the plugin alongside the PlaceholderAPI plugin on your Spigot (1.16.5+) or the PlaceholderAPI mod on your Fabric (1.19.3+) server, then install the plugin on your BungeeCord or Velocity proxy server.

Note this plugin is not a replacement for PlaceholderAPI. You still need to install PlaceholderAPI on your Spigot/Fabric server.

For developers

PAPIProxyBridge exposes a cross-platform API to let you format text with PlaceholderAPI placeholders.

Adding the library to your project

PAPIProxyBridge is available on repo.william278.net (view javadocs here). First, add the maven repository to your build.gradle:

repositories {
    maven { url 'https://repo.william278.net/releases/' }
}

Then add the dependency:

dependencies {
    implementation 'net.william278:papiproxybridge:1.6'
}
Example usage

The PlaceholderAPI class exposes the API for formatting placeholders. At the moment, only singleton non-bracketed placeholders are supported (more in the future).

Get an instance of the class with PlaceholderAPI.getInstance(), then use the #formatPlaceholders method to format a string with placeholders on a player (specified with UUID for cross-platform simplicity).

The method returns a CompletableFuture (since we don't want to lock threads while the proxy networks with players on the backend) that you can use to accept the formatted string.

// Format a string with placeholders
final PlaceholderAPI api = PlaceholderAPI.createInstance();
final UUID player = player.getUniqueId();
api.formatPlaceholders("Hello %player_name%!", player).thenAccept(formatted -> {
    player.sendMessage(formatted);
});

Never invoke #join() on calls to #formatPlaceholders; this is unsafe.

PAPIProxyBridge caches resolved requests for 30000 milliseconds (30 seconds), to avoid causing excessive traffic over your server's network channels. You can adjust how long to cache requests for using the PlaceholderAPI#setCacheExpiry(long) method.

There also exists #formatComponentPlaceholders. This method allows you to supply a string containing placeholders and receive an adventure component containing the formatted text, which may contain formatting and chat events.

Project description from Modrinth.

Pick your setup

PAPIProxyBridge by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

31 available setups

Showing the newest 12 of 25 game versions. Older files are in the list below.

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

PAPIProxyBridge versions and loaders

100 of 100 releases match

Looking for an older file? The official Modrinth project page is in Resources.