BoringAPI

BoringAPI - The Developer API for BoringGroups
This is the official, lightweight companion API for the BoringGroups plugin. It provides a clean, safe, and stable way for your plugins to interact with BoringGroups' data—such as getting player prefixes or modifying ranks—without needing to include the entire BoringGroups plugin in your project.



It also comes with built-in, automatic support for PlaceholderAPI, providing placeholders for other plugins to use without any extra configuration.

Note: This plugin does nothing on its own. It requires the main BoringGroups plugin to be installed and running.

Key Features

• Access Player Information: Easily get a player's group, full colored prefix, and all inherited permissions.
  
  
• Modify Player Data: Safely set a player's group. Perfect for webstores, custom commands, or automated ranking systems.
  
  
• Emoji Processing: Access the powerful emoji processor to replace shortcuts (like :smile in any string with their real characters, respecting player permissions.
  
  
• Built-in PlaceholderAPI Support: If PlaceholderAPI is installed, BoringAPI automatically registers a full set of placeholders for any other plugin to use. No extra configuration needed!
  
  
• Lightweight & Stable: Designed to be a minimal, stable dependency that will not break across BoringGroups updates.
  

How to Use BoringAPI in Your Plugin
Integrating with BoringAPI is simple. Just follow these three steps.

1. Add the Dependency Add BoringAPI to your project using Maven or Gradle.

Maven (pom.xml):

<repositories>
<!-- You will need to install BoringAPI to your local Maven repo first -->
<!-- Or use a repository like JitPack if you upload it to GitHub -->
</repositories>

<dependencies>
<dependency>
<groupId>me.beyondnova</groupId>
<artifactId>BoringAPI</artifactId>
<version>1.5</version> <!-- Use the latest version -->
<scope>provided</scope>
</dependency>
</dependencies>

2. Add to Your plugin.yml To ensure your plugin loads after the API, add BoringAPI as a softdepend.

name: YourPlugin
version: 1.0
main: com.yourplugin.Main
api-version: '1.21'
softdepend: [BoringAPI, PlaceholderAPI] # Add BoringAPI here

3. Get the API Instance in Your Code In your plugin's code, you can get the API instance and start using its methods. It's best to check if the API is available before using it.

Example:


Automatic PlaceholderAPI Support
If PlaceholderAPI is installed on the server, BoringAPI will automatically register the following placeholders for any other plugin to use:

• %boringgroups_group%
  
  • Displays the player's group name (e.g., "Admin").
    
• %boringgroups_prefix%
  
  • Displays the player's full, colored prefix, with emojis already processed.
    
• %boringgroups_rank_expiry%
  
  • Shows the time remaining on a player's temporary rank (e.g., "7d 12h" or "Permanent").
    
• %boringgroups_processemojis_<text>%
  
  • A powerful placeholder that processes any text you provide for emojis. For example, %boringgroups_processemojis_Hello :wave: %player_name%!% will display the waving hand emoji.