✓ Ultimate Friends! 2.3.5

UltimateFriends 2.3.5
Now with UUID and RedisBungee support!

Plugin UltimateFriends (for BungeeCord) is great for your bungee network. Players can easily manage their friend list, without any unnecessary commands! You can control this plugin using buttons in the chat.
You can browse your friend list, configure options, send messages to your friends or connect to server, where your friend is connected.
Simply awesome!

Features

• Clickable messages and buttons in chat
• Add/remove your friend with a few clicks
• Connect to server where your friend is
• Send messages to your friends, even if they are on another server
• Broadcast messages to all friends
• Every player can set his options:
  • Show/hide messages, if player connect to server
  • Show/hide messages, if player disconnect from server
  • Show/hide messages, if player change server
  • Allow/deny new requests for friendship
  • Allow/deny private messages
  • Show/hide friends broadcasts
• Customisable messages in config
• Customisable commands and aliases
• Data are stored in MySQL database
• Disable plugin on specific servers
• Add custom buttons below friend list
• Regex chat filter
• UUID or player names lookup!
• MultiLobby compatibility
• RedisBungee support

Config
Code (Text):

# select storage system and set params
# there is only "mysql" (for now)
storage:
module: "mysql"

mysql:
hostName: "localhost"
database: "gtfriends"
user: "root"
password: ""
port: 3306

# coolDown is between clicks or between commands (in milliseconds)
# (recommended: 1000-2000)
# cmd is main command and it will be suggested in chat
# usePermission - true => you must have "ultimatefriends.cmd" permission to use any command
commands:
coolDown: 1500
cmd: "f"
usePermission: false
aliases:
- "fr"
- "friend"
- "friends"

# define default options setting for new players
options:
default:
show_msg_join: true
show_msg_left: true
show_msg_switch: true
allow_requests: true
allow_private_msg: true
show_broadcast: true

# (recommended: max 48)
friendList:
maxFriends: 24 #default value - if player is not in any group

groups:
vip:
permission: "friends.vip"
maxFriends: 30
donator:
permission: "friends.donator"
maxFriends: 40

# enter full file name in /lang folder
language:
file: "lang_en_GB.yml"

# select communication module
# if you want to use redis then the RedisBungee plugin must be installed
# http://www.spigotmc.org/resources/redisbungee.211/
# "bungee" or "redis"
communication:
module: "bungee"

# Select if you want to use player names or player uuids
# If you're running offline server (not premium), use player names
# "name" or "uuid"
playerLookup:
type: "name"

# You can disable connection to these servers
# (you won't be able to switch servers with connect button
# in friend list and other players won't be able to connect
# to these servers with that button)
#
# You can disable connection from specific servers too.
# (connect button will not work on these servers)
#
# You can also disable whole plugin on any of your servers
# (recommended for Auth/login servers)
#
# just enter same server name as is it in bungee config
disable:
connection:
- "server2"
- "server3"
connectionFrom:
- "server4"
plugin:
- "server1"

#regex msg/bmsg filter
chat:
filters:
#antiyolo:
# #if the message contains this regex, it will be blocked - '(?i)' = case insensitive check
# regex: '(?i)(yolo)'
# #but if the message contains this ignore regex, it won't be blocked
# ignore: '(?i)((don''t)|(do not))([\s\d])(yolo)'
# #run command, if the message is blocked - "$player" is replaced by player name, "$msg" is replaced by message
# runCmd: "kick $player AntiYOLO: $msg"
#
#anticolor:
# regex: "&[0-9a-fk-or]"
# ignore: ""
# runCmd: ""
#something-else:
# regex: ""
# ignore: ""
# runCmd: ""
#another-filter:
# ...

# Custom buttons
# If you want to add custom button bellow friend list, you can do it here
# Format
# format;button_text;hover_text;TEXT/CMD/SUGGEST/URL;msg/command_to_run/command_to_suggest/web_page_to_open
# You must specify button format like in the lang files (there have to be '$') (there are some reasons for this formatting style)
# If you don't want to show hover text, just insert space between semicolon "..button_text; ;type.."
customButtons:
#- " &9[{&b}$&9];Cmds;&aClick to show commands;TEXT;- /f\n- /f msg <playerName> <msg>\n- /f bmsg <msg>\n- /f options\n- /f add <playerName>\n- /f remove <playerName>\n- /f connect <playerName>"
- " &8[{&7}$&8];About;&a&lUltimateFriends by\n&e&lM1nef4n\n&7Click to open page;URL;http://www.spigotmc.org/resources/ultimate-friends.3964/"
#- "\n&a[{&c&l}$&a];KILL ME;&cClick to kill yourself;CMD;/kill"
#- " &e[{&a}$&e];Report;&aClick and write hacker's name;SUGGEST;/report "
#- " $;Lobby; ;CMD;/lobby"

# bungee_server_name;display_name
# Display name will be used in messages
serverAliases:
- "server1;Survival Games"
- "server2;Lobby"


# Social Spy will be automatically enabled for players listed here
socialSpy:
default:
- "Insert-Player-Name-Here"

# You can change redis communication channels, if you want or
# change table names in DB and more...
# Simply do not touch this until I tell you
core:
ver: 2
gtApiPass: ""
lang:
reset: false
redisBungee:
msgSplit: ";"
channels:
fReq: "ultimateFriends_friendRequest"
fRem: "ultimateFriends_friendRemove"
msg: "ultimateFriends_message"
bMsg: "ultimateFriends_broadcast"
db:
tables:
fList: "friend_list"
options: "options"


Permissions

• ultimatefriends.cmd - optional (see here)
• ultimatefriends.spy - for /f spy (enable/disable social spy)
• ultimatefriends.autospy - for auto-enabled-spy on player join
• ultimatefriends.reload - for /f reload (won't reload core, storage, communication module, player lookup and command)
• ultimatefriends.filter.bypass - for bypassing chat filter

Translations

• You can download additional translations here
• If you translate original file (lang_en_GB.yml) to your language, you can send it to me and I can add it here. But please don't change formatting and variables order

Notes

• Plugin will create 2 tables in database (you can change table names in config.yml)
  • friend_list
  • options
• Using UUID system on non-premium (offline) server is not good idea, because players' uuids can change.