UltraStaffChat - Bungeecord

Official Documentation for JoshuaLovesCode's UltraStaffChat - Bungeecord.

Install & Setup

To install and setup UltraStaffChat - Bungeecord:

  • Download the plugin from the Official Plugin Page

  • Add the plugin to your Proxy's /plugins/ folder.

  • Type the end command in your Proxy's console

  • Start the Proxy again.

  • Go to the /plugins/ folder and locate the UltraStaffChat folder. Then open the config.yml file.

  • Change everything to your liking and save the file.

  • Run the /usc reload command In-game. (This will reload the configuration file.)

  • Done! Have any questions? Check the FAQ at the bottom of this page or join the Official Support Discord!

Commands and Default Permissions

<> Required | () Not required

Command

Usage

Default Permission

/staffchat

/staffchat <msg>

staffchat.talk

/sc

/sc <msg>

staffchat.talk

/sctoggle

/sctoggle

staffchat.toggle

/staffchattoggle

/staffchattoggle

staffchat.toggle

/scmute

/scmute

staffchat.mute

/staffchatmute

/staffchatmute

staffchat.mute

/scafk

/scafk

staffchat.afk

/usc

/usc (reload/debug)

None

/usc reload

/usc reload

ultrastaffchat.reload

/usc debug

/usc debug

ultrastaffchat.usedebug

If you think any other command/placeholder/feature should be added, Please suggest it in my Discord!

Configuration

This is the config file, It was changed to be easier to read in the 2.0.0 Update.

config.yml
# ## ## ## ######## ####### # ######## ######### # ######## ######## ######## ## ## # ########
# ## ## ## ## ## ## ### ## ## ### ## ## ## ## ## ### ##
# ## ## ## ## ####### ## ## ######## ## ## ## ######## ######## ## ######## ## ## ##
# ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
# ###### ######## ## ## ## ## ## ######## ## ## ## ## ## ######## ## ## ## ## ##
#
# Copyright 2019 Joshua Sing | All rights reserved.
# For additional help with this configuration file please go here: https://docs.joshualovescode.dev/plugins/ultrastaffchat-bungeecord/#configuration
# To suggest/report anything please join my discord: https://discord.joshualovescode.dev
# Config Version (DO NOT EDIT!!!)
config-version: 31
# [ STAFFCHAT MYSQL CONFIGURATION ]
# If enabled UltraStaffChat will log every staffchat message in to MySQL.
mysql-enabled: false
mysql-address: "localhost"
mysql-port: 3306
mysql-user: "ultrastaffchat"
mysql-pass: "UltraStaffChatUserPassw0rd"
mysql-db: "ultrastaffchat"
# [ STAFFCHAT DISCORD CONFIGURATION ]
# Discord Link - Enabled. (If true all StaffChat messages will also go to discord.)
discord-link-enabled: false
# Discord Link - WebHook URL
discord-link-url: "https://discordapp.com/api/webhooks/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# Discord Link - Username
discord-link-username: "UltraStaffChat"
# Discord Link - Embed or Text? (If true messages will be embeds. If false messages will be text.)
discord-link-embed: true
# Discord Link - Send Staff Join Messages? (Uses same permission as the join broadcast.) Note: Only works if announce-staff-join = true
discord-link-join: true
# Discord Link - Send Staff Leave Messages? (Uses same permission as the leave broadcast.) Note: Only works if announce-staff-leave = true
discord-link-leave: true
# Discord Link - StaffChat Layout (Placeholders: Player {player}, Server {server}, Message {message}) Note: Don't use color codes here!
discord-link-staffmessage-layout: "[StaffChat] {player}: {message}"
# [ STAFFCHAT TOGGLE CONFIGURATION ]
# StaffChat Toggle - Enabled. (If true players can toggle their StaffChat.)
staffchat-toggle-enabled: true
# StaffChat Toggle - Permission.
staffchat-toggle-perm: "staffchat.toggle"
# StaffChat Toggle - ON Message.
staffchat-toggle-message-on: "&8[&4&lStaffChat&8] &cStaffChat Toggled On!"
# StaffChat Toggle - OFF Message.
staffchat-toggle-message-off: "&8[&4&lStaffChat&8] &cStaffChat Toggled Off!"
# [ STAFFCHAT MUTE CONFIGURATION ]
# StaffChat Mute - Enabled. (If true players can mute their StaffChat.)
staffchat-mute-enabled: true
# StaffChat Mute - Permission.
staffchat-mute-perm: "staffchat.mute"
# StaffChat Mute - MUTED Message.
staffchat-mute-message-on: "&8[&4&lStaffChat&8] &cStaffChat Muted!"
# StaffChat Mute - UNMUTED Message.
staffchat-mute-message-off: "&8[&4&lStaffChat&8] &cStaffChat Unmuted!"
# [ STAFFCHAT AFK CONFIGURATION ]
# StaffChat AFK - Enabled. (If true players will be able to tag them self/others as afk)
staffchat-afk-enabled: true
# StaffChat AFK - Permission.
staffchat-afk-perm: "staffchat.afk"
# StaffChat AFK - AFK Broadcast Message. ( Placeholders: {player} )
staffchat-afk-msg-on: "&7{player} is now &c&lAFK&7."
# StaffChat AFK - No Longer AFK Broadcast Message. ( Placeholders: {player} )
staffchat-afk-msg-off: "&7{player} is no longer &c&lAFK&7."
# [ STAFFCHAT JOIN CONFIGURATION ]
# StaffChat Join - Announce? (If true when a player with the perm joins it will broadcast a message.)
announce-staff-join: true
# StaffChat Join - Permission. (Players with this permission will receive a message when another player with this permission joins.)
announce-staff-join-perm: "staffchat.join"
# StaffChat Join - Message. (Placeholders: Player {player})
announce-staff-join-msg: "&7[&a&l+&7] &a{player}"
# [ STAFFCHAT LEAVE CONFIGURATION ]
# StaffChat Leave - Announce? (If true players will receive a message when other players leave with the perm.)
announce-staff-leave: true
# StaffChat Leave - Permission. (Players with this permission will receive a message when another player with this permission leaves.)
announce-staff-leave-perm: "staffchat.leave"
# StaffChat Leave - Message. (Placeholders: Player {player})
announce-staff-leave-msg: "&7[&c&l-&7] &c{player}"
# [ STAFFCHAT UPDATE NOTIFICATION CONFIGURATION ]
# StaffChat Update Notify - Announce? (If true players will receive a message on join if the plugin needs a update.) (Recommended!)
announce-update: true
# StaffChat Update Notify - Permission. (Permission to receive notification on join.)
update-announce-perm: "ultrastaffchat.notifyupdate"
# StaffChat Update Notify - Message. (Placeholders: {newversion} {oldversion})
update-announce-msg: "&8[&c&lUltraStaffChat&8] &cA &cupdate &cis &cavailable! &cCurrent &cversion: &c{oldversion}, &cNew &cversion: &c{newversion}"
# [ STAFFCHAT GENERAL CONFIGURATION ]
# StaffChat - Layout. (Placeholders: Player {player}, Server {server}, Message {message})
staffchatlayout: "&8[&4&lStaffChat&8] &4{player}&c: &c{message}"
# StaffChat - Message Color. (Example "&c")
staffchatcolor: "&c"
# StaffChat - Message Prefix Enabled. (If enabled players can send messages to StaffChat with the below prefix.)
msg-prefix-send: true
# StaffChat - Message Prefix. (Only used if msg-prefix-send: true) Note: cannot be /
msg-prefix: "#"
# StaffChat - Talk Permission.
staffchattalkperm: "staffchat.talk"
# StaffChat - Read Permission.
staffchatreadperm: "staffchat.read"
# StaffChat - No Permission Message.
nopermission: "&cNo Permission."
# StaffChat - Config Reload Perm.
reloadperm: "ultrastaffchat.reload"
# StaffChat - Usage Message.
usage: "&cUsage: /staffchat <message>"
# [ ULTRASTAFFCHAT ADVANCED CONFIGURATION ]
# UltraStaffChat - Debug Permission. ( Allows use of "/usc debug" which is only used to give some info that is helpful during support )
debugperm: "ultrastaffchat.usedebug"

Make sure to use a program like NotePad++ to edit the configuration file!

Terms of Use

By using UltraStaffChat you agree to the following:

  • You must not decompile the plugin.

  • You must not use any form of code from the plugin.

  • You must not redistribute the plugin.

  • You must not claim this plugin as your own.

  • You must not remove the credit command from this plugin.

  • You must not remove/edit any code from the plugin.

  • You must not block the credit command with another plugin.

Note: I (Joshua Sing) reserve the right to change the terms of use of this plugin at anytime.

Frequently Asked Questions

This is a list of questions I get often with their answers. If you're question isn't here please ask us in the Official Support Discord!

I keep getting the No Permission message even though I have the Permissions.

Make sure you using a permission plugin such as LuckPerms that has Bungeecord support.

Make sure that all the permissions are correct.

If you have changed the permissions in your Config file make sure that you are giving those permissions and not the default ones.

Will add more questions soon.