Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 12, 2025

This PR adds comprehensive documentation for ServiceIO's PlaceholderAPI integration introduced in version 2.3.0, based on direct analysis of the ServiceIO source code.

What's Added

New Documentation Page: content/docs/serviceio/placeholders.mdx

Documents all ServiceIO placeholders using the format %serviceio_<placeholder>%, including:

  • Player Information: prefix, suffix, displayname
  • Economy (Standard): balance, balance_<world>, balance_formatted, balance_formatted_<world>
  • Economy (Bank System): bank, bank_balance, bank_balance_formatted with world-specific variants
  • Bank Management: banks, banks_<world> for listing available banks
  • Permission Groups: group, groups
  • VaultUnlocked Compatibility: Complete set of %vaultunlocked_*% placeholders for compatibility reasons

Key Features

  • Complete placeholder reference extracted directly from ServiceIO source code analysis
  • World-specific variants for economy and bank placeholders
  • Practical examples for chat formats, scoreboards, world-specific usage, and multi-bank setups
  • Requirements section detailing ServiceIO v2.3.0+ and PlaceholderAPI dependencies
  • Enhanced troubleshooting guide for common placeholder issues with proper usage validation
  • Professional formatting using fumadocs components with proper type attributes and MDX structure

Navigation Update: Added the new placeholders page to the ServiceIO documentation section in meta.json, positioned logically in the Introduction section.

The documentation now accurately reflects all 20+ placeholders available in the ServiceIO codebase and provides developers with everything needed to implement ServiceIO placeholders in their configurations.

Fixes #97.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link
Contributor Author

Copilot AI commented Sep 12, 2025

@NonSwag 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Copilot AI and others added 2 commits September 12, 2025 09:54
Co-authored-by: NonSwag <54660361+NonSwag@users.noreply.github.com>
Co-authored-by: NonSwag <54660361+NonSwag@users.noreply.github.com>
Copilot AI changed the title [WIP] Document ServiceIO placeholders Add ServiceIO PlaceholderAPI documentation Sep 12, 2025
Copilot AI requested a review from NonSwag September 12, 2025 09:58
Copilot finished work on behalf of NonSwag September 12, 2025 09:58
@NonSwag
Copy link
Member

NonSwag commented Sep 12, 2025

You now have the appropriate permissions to perform tests and access the ServiceIO repository
Look at the ServiceIO code and create a list of all available placeholders
@copilot

…ource code

Co-authored-by: NonSwag <54660361+NonSwag@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Sep 12, 2025

You now have the appropriate permissions to perform tests and access the ServiceIO repository
Look at the ServiceIO code and create a list of all available placeholders
@copilot

I've analyzed the ServiceIO source code and updated the documentation with the complete list of all available placeholders. The analysis revealed many more placeholders than initially documented:

Key findings:

  • Economy placeholders: Both standard economy (balance, balance_formatted) and bank system (bank, bank_balance, bank_balance_formatted)
  • World-specific variants: Most economy placeholders support world-specific versions (e.g., %serviceio_balance_world%)
  • Bank management: Additional placeholders for listing banks (%serviceio_banks%)
  • VaultUnlocked compatibility: Complete set of advanced multi-currency placeholders using %vaultunlocked_*% format

The documentation now includes 20+ placeholders with practical examples for different use cases including world-specific economy, multi-bank setups, and advanced features.

Commit: fb36155

Copilot AI changed the title Add ServiceIO PlaceholderAPI documentation Add comprehensive ServiceIO PlaceholderAPI documentation Sep 12, 2025
Copilot finished work on behalf of NonSwag September 12, 2025 10:13
4. ServiceIO has successfully detected and registered the service provider
</Callout>

If a placeholder returns empty or default values, check your ServiceIO configuration and ensure the appropriate service providers are properly installed and configured. No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there will never be "default values"
there is only improper placeholder usage (not formatted and shows the literal placeholder)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated troubleshooting text to clarify that placeholders show literal text instead of expected values when improperly used, rather than mentioning "default values" in commit 6db60d1

@NonSwag
Copy link
Member

NonSwag commented Sep 12, 2025

@copilot
look at the requested changes

Co-authored-by: NonSwag <54660361+NonSwag@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Sep 12, 2025

@copilot
look at the requested changes

I've addressed all the requested changes in commit 6db60d1:

  • Fixed version numbers (2.3.1 → 2.3.0)
  • Removed unnecessary import statement
  • Added type attributes to callouts
  • Updated VaultUnlocked wording for clarity
  • Removed MOTD example
  • Enhanced troubleshooting section

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • fonts.gstatic.com
    • Triggering command: node /home/REDACTED/work/docs/docs/node_modules/.bin/next build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested a review from NonSwag September 12, 2025 10:39
Copilot finished work on behalf of NonSwag September 12, 2025 10:39
@NonSwag NonSwag marked this pull request as ready for review September 12, 2025 18:05
@NonSwag NonSwag merged commit 26f9a55 into main Sep 12, 2025
2 checks passed
@NonSwag NonSwag deleted the copilot/fix-97 branch September 12, 2025 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document ServiceIO placeholders

2 participants