Custom Placeholders

RocketPlaceholders allows you to create custom placeholders that can be used with PlaceholderAPI and MVdWPlaceholderAPI. This guide will teach you how to create your own placeholders.

Overview

Custom placeholders are stored in the placeholders folder. Each placeholder is defined in its own YAML file with a unique identifier.

Creating a Basic Placeholder

To create a custom placeholder, create a new file in the placeholders folder with the following structure:

placeholders:
  1:  # Unique identifier (CHANGE IT, DO NOT USE 0)
    placeholder: "test"  # The placeholder will be %rp_test% (PlaceholderAPI) or {rp_test} (MVdWPlaceholderAPI)
    text: "This is an example"

Placeholder Format

PlaceholderAPI: %rp_<name>% (e.g., %rp_test%)
MVdWPlaceholderAPI: {rp_<name>} (e.g., {rp_test})

Where <name> is the value you set in the placeholder field.

Public Placeholders

A public placeholder is visible to everyone with the same text:

placeholders:
  1:
    placeholder: "welcome"
    text: "Welcome to our server!"

Result: All players will see “Welcome to our server!” when using %rp_welcome%.

Permission-Based Placeholders

You can create placeholders that show different text based on permissions:

placeholders:
  1:
    placeholder: "test"
    text: "This is a test"  # Shown to players without permission
    permission: "example.1"  # Permission node
    text_with_permission: "this is a secret test!"  # Shown to players with permission

How it works:

Players without example.1 permission see: “This is a test”
Players with example.1 permission see: “this is a secret test!”

Examples

Example 1: Simple Welcome Message

placeholders:
  1:
    placeholder: "welcome"
    text: "Welcome to our amazing server!"

Example 2: Permission-Based Secret Message

placeholders:
  1:
    placeholder: "secret"
    text: "You don't have access"
    permission: "server.vip"
    text_with_permission: "Welcome, VIP member!"

Example 3: Multiple Placeholders

You can define multiple placeholders in the same file:

placeholders:
  1:
    placeholder: "welcome"
    text: "Welcome!"
  
  2:
    placeholder: "server"
    text: "Amazing Server"
  
  3:
    placeholder: "status"
    text: "Online"
    permission: "admin.status"
    text_with_permission: "Server Status: Online"

Using JavaScript Expressions

You can use JavaScript expressions for placeholder text (requires JShader):

placeholders:
  1:
    placeholder: "test"
    text: "'Hello World' === 'Hello World' ? 'YES' : 'NO'"  # This will return YES
    parsejs: true

The JavaScript feature requires RocketPlaceholders 1.9.1+ and JShader plugin. See the JavaScript Condition guide for more details.

Placeholder Identifiers

Important: Do not use 0 as an identifier. Always use numbers starting from 1 or higher.

Good:

placeholders:
  1:
    placeholder: "example"
    text: "Example"

Bad:

placeholders:
  0:  # DON'T USE 0!
    placeholder: "example"
    text: "Example"

Best Practices

Use descriptive names - Choose placeholder names that clearly indicate their purpose (e.g., welcome, server_name, player_count)
Organize by purpose - Group related placeholders together or create separate files for different categories
Document your placeholders - Add comments in your YAML files to explain what each placeholder does
Test thoroughly - Always test your placeholders in-game to ensure they work as expected
Use conditions for complex logic - For more advanced logic, use conditions instead of just permissions

Advanced: Using Conditions

For more complex placeholder logic, you can use conditions:

placeholders:
  1:
    placeholder: "rank"
    text: "Default"
    conditions:
      vip:
        type: PERMISSION
        value: "server.vip"
        text: "VIP"
      admin:
        type: PERMISSION
        value: "server.admin"
        text: "Admin"

See the Conditions guide for detailed information.

Troubleshooting

Q: My placeholder isn’t showing up
A: Make sure:

The placeholder identifier is not 0
The file is in the placeholders folder
You’ve restarted the server or reloaded the plugin
PlaceholderAPI is installed and working

Q: Permission-based placeholder shows the same text for everyone
A: Check that:

The permission node is correct
Players actually have the permission
The text_with_permission field is set

Q: Placeholder shows as %rp_name% instead of the text
A: This usually means PlaceholderAPI isn’t detecting the placeholder. Make sure:

PlaceholderAPI is installed and enabled
RocketPlaceholders is properly installed
You’re using the correct placeholder format

Configuration - Plugin configuration
Conditions - Advanced placeholder conditions
Custom Permissions - Legacy permission system (deprecated)

RocketJoin

RocketPlaceholders

MultiLang

Custom Placeholders

Custom Placeholders

Overview

Creating a Basic Placeholder

Placeholder Format

Public Placeholders

Permission-Based Placeholders

Examples

Example 1: Simple Welcome Message

Example 2: Permission-Based Secret Message

Example 3: Multiple Placeholders

Using JavaScript Expressions

Placeholder Identifiers

Best Practices

Advanced: Using Conditions

Troubleshooting

​Custom Placeholders

​Overview

​Creating a Basic Placeholder

​Placeholder Format

​Public Placeholders

​Permission-Based Placeholders

​Examples

​Example 1: Simple Welcome Message

​Example 2: Permission-Based Secret Message

​Example 3: Multiple Placeholders

​Using JavaScript Expressions

​Placeholder Identifiers

​Best Practices

​Advanced: Using Conditions

​Troubleshooting

​Related Guides

Custom Placeholders

Overview

Creating a Basic Placeholder

Placeholder Format

Public Placeholders

Permission-Based Placeholders

Examples

Example 1: Simple Welcome Message

Example 2: Permission-Based Secret Message

Example 3: Multiple Placeholders

Using JavaScript Expressions

Placeholder Identifiers

Best Practices

Advanced: Using Conditions

Troubleshooting

Related Guides