QuickPearls Official Documentation
Welcome to the official documentation for QuickPearls! This guide will explain how the plugin works behind the scenes, how to configure its core features, and where to get support if you need it.
[HR][/HR]
⚙️ How it Works
Unlike traditional plugins that rely on heavy Bukkit
Code (Text):
ProjectileLaunchEvent
or
Code (Text):
PlayerTeleportEvent
(which run on the main server thread and cause TPS drops),
QuickPearls intercepts raw network packets using
PacketEvents.
- Packet Interception: When a player throws an Ender Pearl, we intercept the packet before the server processes it.
- Physics Calculation: Our internal engine calculates the exact trajectory and collision boxes, considering blocks like slabs, stairs, and beds.
- Glitch Prevention: If the calculation predicts the player will land inside a solid block or phase through a 1x1 wall, the teleport is instantly cancelled and refunded.
- Execution: All this happens in a fraction of a millisecond, completely asynchronous, guaranteeing zero impact on your server's TPS.
[HR][/HR]
The Auto-Language System
QuickPearls comes with a smart localization system that eliminates the need for players to manually select their language.
How does it work?
When a player logs in, the plugin reads their Minecraft client settings (e.g.,
,
,
). If the player's client is in Spanish, QuickPearls will automatically send them messages using the
file.
Forcing a Global Language
If you prefer all your players to see the same language regardless of their client settings, simply change the mode in
:
Code (YAML):
# Language configuration
language
:
# Change 'auto' to 'en' or 'es' to force a single language globally.
mode
: 'auto'
You can also do this in-game using the command:
Code (Text):
/quickpearls lang en
[HR][/HR]
Understanding "Pearl-Thru" & Physics
The Anti-Glitch engine is powerful, but sometimes you
want pearls to pass through certain blocks (like string in HCF bases or cobwebs).
Config Snippet: Block Lists
Inside
, you will find the
Thru section. Here you can define exactly what happens when a pearl hits specific blocks:
Code (YAML):
# Block Lists (Compatible with 1.8 - 1.21+)
Thru
:
# Allow pearls to pass completely through Fence Gates
FenceGates
: true
# Allow pearls to pass completely through Cobwebs
Cobweb
: true
# Blocks where pearls will be instantly cancelled and refunded
DisabledBlocks
:
- FENCES
- THIN_GLASS
- Tip for PvP Servers: Enable
and
to allow smooth raiding and base escaping, while adding
to
Code (Text):
DisabledBlocks
to prevent glitching into claims.
[HR][/HR]
⏱️ Cooldowns & Integrations
QuickPearls features a built-in cooldown system optimized for combat.
Code (YAML):
# Cooldown system configuration
cooldown:
enabled
: true
duration
: 15.0
# Kohi-Style XP Bar Display for competitive servers
kohiDisplay:
enabled
: true
PlaceholderAPI
You can display the player's active cooldown on your scoreboard, action bar, or menus using:
Code (Text):
%quickpearls_cooldown%
Lazarus Core
If you use Lazarus, QuickPearls will automatically detect it. Set
Code (Text):
removeSilentLazarusCooldown: true
in the refund section to ensure Lazarus doesn't spam your players with errors when QuickPearls refunds a pearl!
[HR][/HR]
Support & Discord
Running into issues? Need help configuring your server's physics? We are here to help!
Before opening a ticket, please ensure:
- You are running the latest version of QuickPearls.
- You have the latest version of PacketEvents installed.
- You have attached your server
file.