PlaceholderAPI Integration

InviteMe integrates with PlaceholderAPI to expose player invitation data as placeholders. Use these in scoreboards, tab lists, chat plugins, and more.

Prerequisites

• PlaceholderAPI installed on your server
• InviteMe installed and configured

---

Available Placeholders

All InviteMe placeholders use the %inviteme_*% prefix.

Player Invitation Limits

These show how many invitations a player can make:

Placeholder	Returns	Example
%inviteme_max_invites%	Maximum invitations allowed	5 or ∞
%inviteme_used_invites%	Invitations already made	3
%inviteme_remaining_invites%	Remaining slots	2 or ∞
%inviteme_has_unlimited%	Whether player has unlimited invites	true / false

Player Invitation Status

These show if/how a player was invited:

Placeholder	Returns	Example
%inviteme_is_invited%	Player was invited by someone	true / false
%inviteme_invited_by%	Name of who invited this player	Alice or None
%inviteme_inviter_uuid%	UUID of who invited this player	550e8400-... or N/A
%inviteme_is_invited_temp%	Invitation is temporary	true / false
%inviteme_invite_expires_in%	Time until expiry	5 days / 3 hours / Permanent
%inviteme_invite_expires_formatted%	Expiry date formatted	15 Mar / Permanent
%inviteme_invite_date%	Invitation date	26/05/2026 or N/A
%inviteme_days_since_invite%	Days since invitation	15 or 0
%inviteme_invite_timestamp%	Invitation timestamp (epoch)	1716000000 or 0

Player Invitations Made

These show who a player has invited:

Placeholder	Returns	Example
%inviteme_invited_players%	Count of invitations made	3
%inviteme_invited_list%	Names of invited players (up to 5, then +X more)	Alice, Bob, Charlie

Boost System Statistics

These show XP boost progress:

Placeholder	Returns	Example
%inviteme_boost_active%	Has active boost right now (online only)	true / false
%inviteme_boost_partners%	Number of active boost partners (online only)	2
%inviteme_boost_multiplier%	Configured XP multiplier (from config, not live state)	1.5
%inviteme_boost_percentage%	Boost bonus as a percentage ((multiplier − 1) × 100)	50%

Visual Displays

These show progress bars and rankings:

Placeholder	Returns	Example
%inviteme_invites_bar%	Visual progress bar	█████░░░░░
%inviteme_invites_percentage%	Percentage used	60%
%inviteme_status%	Status summary	Limited / Full / Unlimited
%inviteme_rank%	Ranking position	5 or N/A

Server-Wide Statistics

These return global server data:

Placeholder	Returns	Example
%inviteme_total_invites%	Total invitations across server	47
%inviteme_total_players%	Total invited players	43
%inviteme_top_inviter%	Player with most invites	Alice
%inviteme_top_inviter_count%	Top inviter’s count	12

---

Setup

PlaceholderAPI is detected automatically. No extra configuration needed in InviteMe.

Verify it’s active:

/im debug

Test a placeholder in chat (requires a chat plugin that supports PlaceholderAPI):

/papi parse PlayerName %inviteme_used_invites%

---

Usage Examples

Server List Motd (AdvancedServerList)

Show invitation status before players join:

profiles:
  # Temporary invites
  - condition: "${player inviteme_is_invited} == true && ${player inviteme_is_invited_temp} == true"
    motd:
      - "<yellow>⏰ Temporary invite"
      - "<gray>Expires in: ${player inviteme_invite_expires_in}"
      - "<gray>Invited by: ${player inviteme_invited_by}"
      - "<dark_gray>On: ${player inviteme_invite_date}"

  # Permanent invites
  - condition: "${player inviteme_is_invited} == true && ${player inviteme_is_invited_temp} == false"
    motd:
      - "<green>✓ Permanently invited!"
      - "<gray>By: ${player inviteme_invited_by}"
      - "<dark_gray>Since: ${player inviteme_invite_date} (${player inviteme_days_since_invite} days)"

  # Not invited
  - condition: "${player inviteme_is_invited} == false"
    motd:
      - "<red>❌ You are not invited"
      - "<gray>Contact server staff for access"

Scoreboard (using CMI, Scoreboard-Revived, etc.)

lines:
  - "&6Your Invitations"
  - "&f%inviteme_used_invites%&7/&f%inviteme_max_invites%"
  - "%inviteme_invites_bar%"
  - ""
  - "&6Invited by"
  - "&f%inviteme_invited_by%"

Tab List (using TAB plugin)

header: "&6InviteMe Status"
footer: "&7Invites: &f%inviteme_used_invites%&7/&f%inviteme_max_invites% &7| Rank: &f%inviteme_rank%"

Holographic Displays

/hd create invites_stats &6Server Invitation Stats
/hd addline invites_stats &fTotal invitations: &6%inviteme_total_invites%
/hd addline invites_stats &fInvited players: &6%inviteme_total_players%
/hd addline invites_stats &fTop inviter: &6%inviteme_top_inviter% (&f%inviteme_top_inviter_count%&6)

---

Troubleshooting

Placeholders show as literal text (%inviteme_count% not replaced)

1. Confirm PlaceholderAPI is installed and enabled:

   /plugins
   # Look for: PlaceholderAPI [enabled]

2. Confirm InviteMe detects it:

   /im debug
   # Should show: PlaceholderAPI: Installed ✓
   # If "Not installed": PlaceholderAPI loaded after InviteMe → restart server

3. Test the placeholder directly:

   /papi parse YourName %inviteme_used_invites%

%inviteme_inviter% returns empty

The player has no inviter recorded — they may have been added via /im sync or manually to the whitelist before InviteMe was installed. This is expected.

Placeholders work for some players but not others

This can happen if a player joined before InviteMe was installed. Their data may not be in InviteMe’s database. Run:

/im sync

---

Next Steps

• 🔗 LuckPerms: LuckPerms Integration
• 📖 Commands: /im Command Guide
• ⚙️ Configuration: Config Reference