logo
More

Do you need an account?

Are you a player on a server, or an owner/admin?

Only people who manage a server need an account to link to the plugin. Regular players can just use /audio in-game without needing to register

Continue with registration

Displaying OpenAudioMc variables with PlaceholderAPI

This document explains how to use the PlaceholderAPI integration to show OpenAudioMc values in chat, scoreboard, tablist and similar places. Placeholders are evaluated on your Spigot server only and cannot be used inside BungeeCord configuration files.

Overview

When players connect the OpenAudioMc plugin exposes a set of placeholders you can reference from any plugin or layout that supports PlaceholderAPI. You may adjust the exact text or formatting for some entries in the plugin config.yml file.

Available placeholders

  • %oa_is_connected% : Shows whether the player is connected to the web client. Example value Connected
  • %oa_is_in_voicechat% : Shows whether the player is currently in voice chat. Example value Connected
  • %oa_client_count% : Number of players capable of listening to music. Example value 5
  • %oa_voicechat_count% : Number of players currently using voice chat. Example value 30
  • %oa_voicechat_limit% : Maximum number of players allowed to use voice chat. Example value 100
  • %oa_voicechat_peers% : Number of players currently in voice chat range for this player. Example value 5
  • %oa_token% : The current session token for the player. Example value 123456

Usage examples

Use the placeholders inside any PlaceholderAPI compatible format string. Example scoreboard line:

Command Example
/scoreboard objectives setdisplay sidebar "Music" Then set a line using PlaceholderAPI such as Music : %oa_is_connected%
<>Required
[]Optional

Example for chat plugin placeholder format:

  • Now playing for you : %oa_client_count% listeners

Update frequency and behavior

Values are resolved on demand. That means placeholders may only update when the tablist, scoreboard or chat component itself refreshes. If you expect rapid updates make sure the target component is configured to refresh at the interval you need.

Configuration

Edit config.yml to tweak friendly labels or formatting that the plugin uses when exposing these values server side. Changes may require a reload or a server restart to take effect.

Troubleshooting

  • If a placeholder returns nothing check that PlaceholderAPI is installed and that the OpenAudioMc expansion is enabled.
  • If values look out of date verify the component using the placeholder is refreshing at the frequency you expect.

If you want I can convert these examples into a short snippet ready for your docs site or push this file into your repository as a new documentation page.