CoordinateOffset

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

Spigot | Modrinth | Hangar | CurseForge | bStats

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.

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.

Features

Fully-configurable, flexible methods of determining how to apply offsets
Randomize offset when the player joins, dies, or changes world
Match offsets to the player's position, so they see themselves near the world's origin
Persist the same offset every time a player joins so that they don't notice coordinates changing
Configure different offsets per-player, per-world, and with permissions
Extensible API to flexibly get and set offsets
(Beta) Compatible with ViaVersion, ViaBackwards, BungeeCord, Waterfall, and Velocity

Requirements and Installation

Spigot, Paper (recommended), or a fork for Minecraft 1.17.x, 1.18.x, 1.19.x, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.20.4, 1.20.5, 1.20.6
PacketEvents (for Spigot) v2.3.0 or higher
An understanding of the implications of installing this plugin.

After ensuring that you meet the requirements, just grab the latest release and drop it in your server's plugins folder.

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:

constant - Specify the exact offset you want players to have.
disabled - Players will see their real coordinates.
random - Individually randomize each player's offset every time they join the server.
zeroAtLocation - Use an offset based on the player's starting location, so they see themselves near (0, 0).

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

coordinateoffset.bypass Players with this permission will never have their coordinates offsetted. It's a good idea to give this permission to anyone who needs to use coordinates for commands or administration.
coordinateoffset.query Allows you to use the /offset command, which tells you your current offset.
coordinateoffset.query.others Allows you to query other players' offsets with /offset <name>.
coordinateoffset.reload Allows you to reload the plugin config with /offsetreload.

API

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

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:

carlosdiamon / coordinateoffset Goto Github PK