Player Relay

# 📡 Player Relay **Player Relay** makes it easy to share your in-game status with friends through **self-hosted relays**. When you join a relay, your player information (position, health, XP, etc.) is broadcast so others can see it - perfect for: * Finding lost friends on a server * Checking your groups status at a glance ## ✨ Features * 🖥️ **Client-Only** - works anywhere, even on vanilla servers * 🌐 **Auto Hosting** - optionally start a relay automatically when the game launches * 🧩 **Mod Support** * **(https://modrinth.com/mod/xaeros-minimap) / (https://modrinth.com/mod/xaeros-worldmap)** * Display tracked players on your map and in the world * Share waypoints with connected players * **(https://modrinth.com/mod/ping-wheel)** * Send and receive player pings * Ping color based on name color set in config ## ⚙️ Commands * `/prelay` * `host` - start hosting a relay * `connect` - connect to a relay * `stop` - stop hosting relay and also disconnect from any connected relays * `players` - show the connected player list * `inv` - view a player's inventory * `echest` - view a player's (or your own) ender chest * `config` - open config screen * `/prelay_waypoints` * `list` - list all shared waypoints * `accept` - accept all shared waypoints * Enter an index to specify 1 waypoint to accept ## 🔧 Requirements * (https://modrinth.com/mod/fabric-api) * (https://modrinth.com/mod/yacl) ## 💡 Notes * **Never share your real IP address with people you don’t trust.** \ To let others connect to your hosted relay, you have to give them your public IP. * **If your router doesn’t support UPnP**, you may need to *manually port forward* your hosting port so others can connect. * **Want to avoid exposing your real IP or can’t use UPnP/port forwarding?** \ You can use a virtual LAN (VLAN) service like (https://www.zerotier.com/) or (https://vpn.net/). These tools create a private virtual network between all players. \ Everyone must join the same virtual network for the relay to work, and players will see only the virtual IP, not your real one. ## 🐛 Found a Bug? Please report any problems you find to (https://github.com/HintSystem/Player-Relay/issues)