Mod

PAPIProxyBridge

Quick rating

PAPIProxyBridge

No reviews yet

A bridge library plugin for using PlaceholderAPI on proxy servers

No Theme
No Genre
Server Utility
API/Library
Mod Loaders
Fabric
Paper
Spigot
Minecraft

Community voices

Reviews

Versions
Loading versions…
Match includes

Click once to include, again to exclude, again to clear

Rating Any
Any 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0
Min
Max
Play Status
Reviews
Time Played
hrs+
Verified developers only
Has developer response
List view
Grid view
Compact view
Sort by
Date
Rating
Helpful
Unhelpful
Edited
Sort ascending
Delete this review?

This removes your review from the project. You can write a new review after.

Review submitted for moderation

Your review has been sent to moderators, who will check that it meets our guidelines before it appears publicly.

No reviews yet. Be the first to review this project!

Get it on

Available Platforms

Compatibility

Supported Environments

Dev Environment
Client Unknown
Server Unknown

About

Project Details

Type
Mod
License
Apache License 2.0
Latest Version
1.8.4
Authors

For authors

Embed Badge

If you're the author of this project, you can embed a live badge anywhere that supports HTML or Markdown. It updates automatically whenever ratings change.

Custom banner text
ModDex rating badge preview

Use HTML for any page that supports it, or Markdown for README files and Markdown-based descriptions.

Identifiers

Platform IDs

Modrinth ID

Resources

External Links

About

Description

papiproxybridge_header.png GitHubDiscord

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.

Screenshots

Gallery

This project has no gallery images yet.

Versions

Files

Relations

Project Relations

More like this

Similar Mods

Suggestions use data such as tags, dependencies, dependents, descriptions, titles, and more to rank how much they overlap with this mod.

On ModDex

Community snapshot

0
Ratings
0
Followers
0
In stacks

By the numbers

Statistics

~45,000
Downloads
Last Updated
CurseForge
Created
Last synced
When ModDex last fetched and imported data for this project from CurseForge or Modrinth. High-traffic and active projects are checked more often.
Next pipeline sync