Orebfuscator

Orebfuscator - Anti X-Ray

Orebfuscator empowers server owners to protect their server from X-Ray Clients and Texture Packs, all while offering a high degree of configurability. This is achieved through modifying network packets without altering your game world, guaranteeing a secure and reliable experience for users. With Orebfuscator, you can tailor the settings to suit your server's needs, ensuring precise control over the visibility of specific blocks. This means that not only does Orebfuscator safeguard your world's integrity, but it also empowers you to fine-tune your Anti-X-Ray measures for the best gameplay experience.

Features

• Seamless Integration: Plug & Play functionality for effortless use.
• Extensive Configuration: Highly customizable settings to tailor the experience to your liking.
• Server Compatibility: Designed for Spigot-based servers 1.16 and newer (primarily tested on Spigot).
• Block Obfuscation: Conceal non-visible blocks from players' view.
• Block-Entity Support: Hide block entities such as Chests and Furnaces.
• Dynamic Block Visibility: Adjust block visibility based on player proximity and distance.

Requirements

• Java 17 or higher
• Spigot, Paper, Folia or compatible forks (1.16 or newer)
• ProtocolLib 5.2.0 or later

Installation

1. Download ProtocolLib
2. Download Orebfuscator
3. Place both plugins in your plugins directory
4. Start your server and configure Orebfuscator to your liking

Legacy support

For compatibility with Java 11 or Minecraft 1.9.4 and later, you can use any legacy release prior to version 5.5.0. Please note that these legacy releases will no longer receive regular support or updates. However, they may receive critical security and vulnerability patches if necessary.

Why use Orebfuscator over Paper's built-in anti-xray?

• Orebfuscator offers a two level cache for already obfuscated chunks to safe on computing power
• Orebfuscator provides more advanced configuration to tune every little detail to your liking
• Orebfuscator adds the proximity hider which is able to hide surface blocks and reveal them should a player be close enough to them
• Orebfuscator is designed to run in the main game thread as little as possible (which will lessen its impact on TPS)
• Orebfuscator can hide Tile-/Block-Entities (chest, furnace, etc.) correctly without leaving them in chunk packets

Maven

To include the API in your Maven project, add the following configuration to your pom.xml:

<repositories>
  <repository>
    <id>codemc-repo</id>
    <url>https://repo.codemc.io/repository/maven-public/</url>
  </repository>
  <!-- Additional repositories can be added here if needed -->
</repositories>

<dependencies>
  <dependency>
    <groupId>net.imprex</groupId>
    <artifactId>orebfuscator-api</artifactId>
    <version>5.2.4</version>
  </dependency>
  <!-- Add other dependencies as required -->
</dependencies>

Still having trouble getting Orebfuscator to run check out our common issues.