Mirage aims to protect your server against xray users. In addition to the wonderful features of the project, this plugin includes a unique technology (Dynamism) that makes it the best solution against xray users. How does it work? Mirage modifies the packets before they are sent to the players to prevent malicious users from viewing hidden ores in your world, see below for more details on what makes this plugin so unique. This plugin aims to be highly configurable, efficient and fast by using the power of Mixin, it integrates with Aikar’s timings system to allow you to monitor its performances. In addition to being a powerful protection, Mirage can be used by developers as a powerful tool to make appear fake giant structures. This feature gave the project its name.
The jar file must be at the root of the
mods/ folder, not in
mods/plugins/ or any sub folder!
Mirage will generate an optimized configuration for each world. These configurations might be modified to disable the plugin in a specific world, to modify the set of ores that will be hidden or even to modify the modifier itself. Configuration files can be found in the
config/mirage/worlds/ folder and are well documented to help you find your way but for more information, open this page: Configuration.
In this plugin, a modifier is an algorithm used to modify data sent to players. Mirage provides an API to create and register your own modifiers but by default 6 modifiers are included in this plugin. For more information about how to use and configure these modifiers, open this page: Modifiers.
Dynamism (aka dynamic obfuscation) is available since version 1.3.0. This technology allows the modifiers to specify that some blocks are only visible if the player is close enough. Dynamism is very optimized, this allows to hide small structures like a spawner or very big ones such as a water dungeon without causing lags. For example, if you’re using the default configuration, the water dungeons will gradually appear as the player approaches. The required distance is configured to not impact the gameplay but only xray users.
Mirage automatically connects to the Ore repository to check for updates. By default, the console and all players having the permission
mirage.update.notify will be notified when an update is available but it can be disabled by editing the following configuration file:
- Fix generation sometimes causing partial deobfuscation
- Add async obfuscation
- Add support for LanternServer