🍇DS-PearlFix

Welcome to the official documentation for DS-PearlFix! Here you'll find everything you need to know to configure and use the plugin effectively.

About DS-PearlFix

DS-PearlFix is a lightweight plugin designed to address a specific Minecraft exploit where players can use Ender Pearls to bypass walls, barriers, and corners. This plugin ensures fair gameplay by preventing this glitch without introducing additional complexity.


How to Configure DS-PearlFix

The plugin requires minimal configuration, as its primary purpose is to resolve the Ender Pearl glitch. However, customization options are available through the Settings.yml file.

Settings.yml File

Below is a detailed explanation of the configuration file and how to adjust it according to your server's needs:

# Version of the configuration file, do not
# modify this file or you will disrupt the
# version and a new file will be created.
Config-Version: 5.0
Plugin-Version: 5.3

# Plugin messages, you can edit them according to your needs.
Messages:
  Prefix: '<aqua>DS-</aqua><white>PearlFix</white> <dark_gray><bold>» </bold></dark_gray>'
  Reload: '<green>Plugin ready!'
  No-Perms: "<red>You don't have permission to do that"
  Unsafe-Location: "<red>Teleport canceled due to unsafe location!"
  No-Corner: "<red>You can’t teleport to a corner!"
  No-Bedrock: "<red>You can’t teleport to the Bedrock!"
  Very-Close: "<red>You can’t throw a pearl so close to a block!"
  Block-Glitch-Message: "<red>%player% just tried to block glitch using an enderpearl at %coords%"

# Permission required to bypass the plugin
Permissions:
  Staff: 'pearlfix.message'
  Bypass: 'pearlfix.bypass'
  Reload: 'pearlfix.reload'

# Launch verification distance of the EnderPearl. I recommend NOT altering
# this value, but it is editable according to your needs. However, making
# it shorter could hinder detection, while making it longer could render the EnderPearl useless
Check-Distance: 1.25

Configuration Key Details:

  • Config-Version & Plugin-Version: These keys should not be modified. They are essential for version control and error detection. If changed, your settings will reset during an update.

  • Messages: Fully customizable messages. You can adjust them to match your server’s theme.

    • Example: The Block-Glitch-Message includes placeholders like %player% and %coords% for personalized error reporting.

  • Permissions:

    • pearlfix.reload: Required to reload the plugin.

    • pearlfix.bypass: Allows players or staff to bypass glitch detection.

  • Check-Distance: Configures the detection radius in blocks for Ender Pearls. Altering this value may impact performance or glitch prevention effectiveness.


Commands and Permissions

Commands:

  • /pearlfix reload: Reloads the plugin configuration.

Permissions:

  • pearlfix.reload: Grants access to reload the plugin.

  • pearlfix.bypass: Allows players or staff to bypass glitch detection.


Error and Version Control System

DS-PearlFix includes a robust system for detecting configuration errors. If any issues are found during a version update, invalid configurations are automatically reset and moved to a separate directory for review. This ensures uninterrupted server performance.


Demonstration and Examples

DS-PearlFix works seamlessly in the background to ensure a fair playing environment. For example, if a player attempts to teleport through a corner using an Ender Pearl, they will receive the following message (customizable in Settings.yml):

No-Corner: "<red>You can’t teleport to a corner!"

Server logs will also record the event for administrative review:

[DS-PearlFix] PlayerName attempted to glitch using an Ender Pearl at [x, y, z].

For further assistance or questions, feel free to reach out to the FruitForge support team. Thank you for using DS-PearlFix!

Last updated