FriendsProxy | Velocity Proxy addon for Friends

=====================================
HEADER
=====================================

FriendsProxy - by PlayerPicked
The Velocity add-on for Friends. One friend list for every server.

- Network join, leave & switch alerts
- Click a server name to follow
- Every friend's server, always live
- One small config.toml

Add-on · Friends
Live: presence on every server (proxy → redis → servers)
Velocity: one jar on your proxy
Redis: the same one Friends uses

config.toml
[redis] host · port · password
max-connections · timeout

Compatibility: Velocity · Redis · For Friends 2.0


=====================================
SHOWCASE
=====================================

Take Friends across your whole network.
A small Velocity plugin that shares who is online and where. With it, Friends works the same on every server behind your proxy.

01 Presence · 02 Follow · 03 How it works · 04 Setup

-------------------------------------
01 · Presence
Know when friends join, leave or switch.
-------------------------------------
The proxy sees every connect and disconnect, and tells every Friends server about it right away.
- Joined the network
- Moved to a server (from → to)
- Left the network

Example chat (you on lobby, friends anywhere):
[+] MonGen joined the network.
[→] MonGen moved to smp.
[→] Alex moved to skyblock.
[-] Steve left the network.
Friends online (live):
MonGen - smp - Available
Alex - skyblock - Busy

-------------------------------------
02 · Follow
Click the server name. Join your friend.
-------------------------------------
The server in a switch message is clickable. One click and the proxy sends you to the same server.
- Only between friends
- The friend decides (teleport on/off)
- Works from any server

Example:
[→] MonGen moved to smp. (Click to join them)
Following MonGen: lobby → smp
Are you friends? yes
MonGen allows friend teleport: on
Send to server: connect smp

-------------------------------------
03 · How it works
Velocity tells. Redis carries. Friends listens.
-------------------------------------
FriendsProxy publishes three events to Redis. Every Friends server picks them up and keeps each player's current server up to date.
- Runs after other plugins (last priority)
- Locations refreshed every minute
- No database on the proxy

Diagram: Velocity + FriendsProxy → Redis pub/sub → lobby, smp, skyblock (each running Friends)
Published events:
PlayerJoinedNetwork - MonGen · lobby
PlayerSwitchedServer - MonGen · lobby → smp
PlayerLeftNetwork - Steve · skyblock

-------------------------------------
04 · Setup
Three steps and you are live.
-------------------------------------
No commands, no database. Just the proxy, the Redis you already use, and one switch in each Friends config.
1. Drop the jar into Velocity
2. Set your Redis in config.toml
3. Turn on Redis in Friends (every server)

PROXY - plugins/FriendsProxy/config.toml
# FriendsProxy configuration

[redis]
host = "localhost"
port = 6379
# Leave empty if Redis has no password.
password = ""

# Connection pool size
max-connections = 8
timeout-millis = 2000

EACH SERVER - plugins/Friends/config.yml
# Name of this server in the proxy
server-name: "lobby"

redis:
enabled: true
host: "localhost"
port: 6379
password: ""

-------------------------------------
Also included
-------------------------------------
- Lightweight: Only Jedis inside, relocated.
- Self-healing: Player locations resent every minute.
- Fails softly: Redis down? A warning, never a crash.


=====================================
FOOTER
=====================================

Need a hand?
Questions, bug reports and feature ideas are all welcome on our Discord.

- Support Discord: Setup help, config questions and update news from the developers. → Join the server
- Needs Friends: Install Friends on every server behind the proxy. → Get Friends
- Found a bug? Send us your config and console log. → Open a ticket
- Enjoying it? A review helps other server owners find us. → Leave a review

Get FriendsProxy
FriendsProxy is a PlayerPicked plugin · playerpicked.com