Velocity-Friends

This is a friends system for Velocity proxy servers that allows players to manage friendships, send messages, and interact across multiple servers.

What's New in Version 1.3.0:

• Server display in friends list - See which server each online friend is on
• Click-to-join functionality - Click on server names to instantly join your friends
• Direct server connection like join signs - No commands required
• Enhanced tab-completion for /msg and /tell aliases, and fix for /friends
• Improved config preservation - Comments and formatting maintained on updates

Commands:

• /friend add - Send a friend request to a player
• /friend accept - Accept a pending friend request
• /friend deny - Deny a friend request
• /friend remove - Remove a friend from your list
• /friend list - Show all your friends with online status and server location (click to join!)
• /friend requests - Show all pending friend requests
• /friend msg - Send a private message to a friend
• /friend reply - Reply to the last received message
• /friend broadcast - Send a message to all online friends
• /friend settings - Open the interactive settings menu
• /friend reload - Reload the plugin configuration (admin only)

Permissions:

• friends.use - Basic permission to use the friends system
• friends.reload - Permission to reload the plugin configuration

Settings Menu: Players can customize their experience with toggleable options:

• Friend Requests - Enable/disable receiving friend requests
• Notifications - Toggle friend online/offline notifications
• Messages - Enable/disable friend messages
• Status Message - Set a custom status visible to friends

Plugin Messaging API: The plugin provides a complete API for Spigot/Paper servers to interact with the friends system:

Available Requests:

• GET_FRIENDS - Retrieve all friends with names and online status
• GET_ONLINE_FRIENDS - Get only online friends
• GET_SETTINGS - Fetch a player's settings and status message
• UPDATE_SETTING - Change player settings from backend servers
• GET_PENDING_REQUESTS - List all pending friend requests
• ARE_FRIENDS - Check if two players are friends

Automatic Events:

• FRIEND_ONLINE - Triggered when a friend comes online
• FRIEND_OFFLINE - Triggered when a friend goes offline
• FRIEND_SERVER_SWITCH - Notified when a friend switches servers (NEW in 1.2.0)
• FRIEND_REQUEST - Sent when receiving a new friend request
• SETTING_CHANGED - Notified when settings are updated

Storage Options: Choose between JSON files or MySQL database:

JSON Mode (Default):

• Simple file-based storage
• No external dependencies
• Perfect for smaller networks

MySQL Mode:

• Scalable database storage
• HikariCP connection pooling
• Ideal for larger networks
• Tables: friendships, pending_requests, player_settings, player_names

Features:

• Cross-server friend system for Velocity networks
• NEW: Live server display - See which server each friend is on
• NEW: Click-to-join - Instantly join your friends by clicking their server
• Server switch tracking - See when friends move between servers with clickable notifications
• Private messaging between friends
• Broadcast messages to all online friends
• Customizable settings per player
• Offline player name display
• Console logging for moderation
• MySQL support with connection pooling
• JSON fallback for simplicity
• Plugin Messaging API for custom integrations
• Automatic username caching
• Interactive settings menu
• Configurable notifications (join/leave/server switch)

Supported Velocity Version: Velocity 3.3.0 and higher (Java 17+)

Important when setting up:

1. Choose your storage type in config.yml (json or mysql)
2. If using MySQL, configure database credentials
3. Restart the proxy server
4. Optionally integrate with Spigot/Paper plugins using the Plugin Messaging API

Just send me a message on Discord if you have any questions, suggestions, or requests for new plugins.