joshuaprince / CoordinateOffset

⛏️ A Minecraft Spigot/Paper plugin that configurably obfuscates players' coordinates.
GNU Affero General Public License v3.0
17 stars 7 forks source link
bukkit minecraft minecraft-plugin papermc spigotmc

CoordinateOffset

A Minecraft Spigot/Paper plugin that configurably obfuscates players' coordinates.

Icon

GitHub Release Discord Ko-Fi Donations

bStats Servers bStats Players Modrinth Downloads Spigot Downloads Hangar Downloads CurseForge Downloads

Minecraft offers a useful debug menu (F3) that allows anyone to easily see their coordinates in the world. This makes it easy to save points of interest and share locations with friends (or enemies).

However, not all multiplayer servers want coordinates to be so easily accessible. /gamerule reducedDebugInfo can administratively hide coordinates from the F3 menu, but it is trivial for a player to add a client-side mod that shows them.

Image demonstrating coordinate offsetting

CoordinateOffset is a plugin for Spigot and Paper servers that modifies every coordinate in packets between the server and client. The player still sees the exact same world they would normally see. But no matter which mods they install, they cannot see their real coordinates.

Why?

This plugin isn't intended for all servers. Here are a few ideas that might make CoordinateOffset useful:

Features

Requirements and Installation

After ensuring that you meet the requirements, just grab the latest release and drop it in your server's plugins folder. Then follow steps below to configure how coordinates are affected for each player.

Configuration

Main article: Configuration Guide

The main configuration file is automatically generated after the first run at plugins/CoordinateOffset/config.yml.

defaultOffsetProvider: random

The default configuration contains four predefined "offset providers". An "offset" refers to the amount that the player's coordinates should appear to be shifted from their real location. Get started by picking a strategy that matches the type of offsetting you're trying to achieve:

You can customize these providers further, use different providers for different players/worlds/groups, and define your own providers. See the complete Configuration Guide.

Commands

/offset [player]

Gets your or someone else's current offset and real coordinates.

/offsetreload

Reload the configuration from config.yml.

Permissions

API

You can use or extend CoordinateOffset in your own plugin by using the API. Please see the API Guide.

Support

Credits

Special thanks to Cavallium for developing CoordinatesObfuscator, which CoordinateOffset is a fork of. CoordinateOffset's packet translation logic was heavily modeled after the work done by CoordinatesObfuscator.

Libraries used: