UltraStaffChat Bungeecord

Official Documentation for 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

/stafflist

/stafflist, /sclist, /slist

usc.stafflist

/scafk

/scafk

staffchat.afk

/usc

/usc (reload/debug)

None

/usc reload

/usc reload

ultrastaffchat.reload

/usc debug

/usc debug

ultrastaffchat.usedebug

Other Permissions:

Read StaffChat: staffchat.read Join Broadcast: staffchat.join Leave Broadcast: staffchat.leave Switch Broadcast: staffchat.switch

Configuration

config.yml
# _ _ _ _ ____ _ __ __ ____ _ _
# | | | | | |_ _ __ __ _/ ___|| |_ __ _ / _|/ _|/ ___| |__ __ _| |_
# | | | | | __| '__/ _` \___ \| __/ _` | |_| |_| | | '_ \ / _` | __|
# | |_| | | |_| | | (_| |___) | || (_| | _| _| |___| | | | (_| | |_
# \___/|_|\__|_| \__,_|____/ \__\__,_|_| |_| \____|_| |_|\__,_|\__|
#
# UltraStaffChat - config.yml - Configuration.
# Copyright 2020 Joshua Sing & Myles Newton | All rights reserved.
#
# Helpful Links:
# Support | https://discord.joshualovescode.dev
# Docs | https://docs.joshualovescode.dev/plugins/ultrastaffchat-bungeecord#configuration
#
# [ UltraStaffChat | MySQL Configuration ]
# MySQL | Do you want to use MySQL?
mysql-enabled: false
# MySQL | Address
mysql-address: "localhost"
# MySQL | Port
mysql-port: 3306
# MySQL | User [ I do not suggest using "root" for security reasons. ]
mysql-user: "ultrastaffchat"
# MySQL | User Password
mysql-pass: "UltraStaffChatUserPassw0rd"
# MySQL | Database
mysql-db: "ultrastaffchat"
# [ UltraStaffChat | Discord Webhook Configuration ]
# Discord | Do you want to use the discord webhook?
discord-link-enabled: false
# Discord | Webhook URL
discord-link-url: "https://discordapp.com/api/webhooks/XXXXXXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# Discord | Webhook Username
discord-link-username: "UltraStaffChat"
# Discord | Webhook
discord-link-embed: true
# Discord | Join Messages
discord-link-join: true
# Discord | Leave Messages
discord-link-leave: true
# Discord | StaffChat Format [ Placeholders: Player {player}, Server {server}, Message {message} ]
discord-link-staffmessage-layout: "[StaffChat] **{player}**: {message}"
# Discord | Embed Color [ HEX ]
discord-link-embed-color: "#5555FF"
# [ UltraStaffChat | Staff List Configuration ]
# List | Do you want to allow players with a permission to do '/stafflist'?
stafflist-enabled: true
# List | Header [ Placeholders: {count} ]
stafflist-header: "&7({count}) &c&lOnline Staff Members&c:"
# List | Format [ Will be sent for each staff member online, Placeholders: {player}, {server} ]
stafflist-format: "&4{player} &7- &4{server}"
# [ UltraStaffChat | Toggle Configuration ]
# Toggle | Do you want to allow staff members to do '/sctoggle'?
staffchat-toggle-enabled: true
# Toggle | ON Message
staffchat-toggle-message-on: "&8[&4&lStaffChat&8] &cStaffChat Toggled On!"
# Toggle | OFF Message
staffchat-toggle-message-off: "&8[&4&lStaffChat&8] &cStaffChat Toggled Off!"
# [ UltraStaffChat | Mute Configuration ]
# Mute | Do you want to allow staff members to hide their staff chat?
staffchat-mute-enabled: true
# Mute | MUTED Message
staffchat-mute-message-on: "&8[&4&lStaffChat&8] &cStaffChat Muted!"
# Mute | UNMUTED Message
staffchat-mute-message-off: "&8[&4&lStaffChat&8] &cStaffChat Unmuted!"
# [ UltraStaffChat | AFK Configuration ]
# AFK | Do you want to allow staff members to mark themselves as afk?
staffchat-afk-enabled: true
# AFK | Broadcast [ Placeholders: {player} ]
staffchat-afk-msg-on: "&7{player} is now &c&lAFK&7."
# AFK | Broadcast [ Placeholders: {player} ]
staffchat-afk-msg-off: "&7{player} is no longer &c&lAFK&7."
# [ UltraStaffChat | Join Configuration ]
# Join | Do you want to notify all online staff when another staff member joins?
announce-staff-join: true
# Join | Should we display the join message to the user that joined?
announce-staff-join-self: true
# Join | Message [ Placeholders: Player {player}, {server} ]
announce-staff-join-msg: "&7[&a&l+&7] &7[{server}] &a{player}"
# [ UltraStaffChat | Leave Configuration ]
# Leave | Do you want to notify all online staff when another staff member leaves?
announce-staff-leave: true
# Leave | Should we display the leave message to the user that left?
announce-staff-leave-self: true
# Leave | Message [ Placeholders: Player {player} ]
announce-staff-leave-msg: "&7[&c&l-&7] &c{player}"
# [ UltraStaffChat | Server Switch Configuration ]
# Switch | Do you want to notify all online staff when another staff switches servers?
announce-staff-switch: true
# Switch | Do you want the message to show to the user who switched?
announce-staff-switch-showmbm: true
# Switch | Message [ Placeholders: Player {player}, New Server: {newserver}, Old Server: {oldserver} ]
announce-staff-switch-msg: "&8[&4&lStaffChat&8] &c{player} joined &4{newserver}&c from &4{oldserver}&c."
# [ UltraStaffChat | Update Configuration ]
# Update | Do you want to notify administrators when a update is available? [ Recommended! ]
announce-update: true
# Update | Notification [ Placeholders: {newversion}, {oldversion}, {newline} ]
update-announce-msg: "&8[&9&lUltraStaffChat&8] &cA &cupdate &cis &cavailable!{newline}&cCurrent &cversion: &c{oldversion}, &cNew &cversion: &c{newversion}"
# [ UltraStaffChat | General Configuration ]
# StaffChat | Format [ 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 | Do you want to let staff members use a prefix in their message to make it go to staff chat?
msg-prefix-send: true
# StaffChat | Prefix [ Cannot be "/" ]
msg-prefix: "#"
# StaffChat | No Permission Message.
nopermission: "&cNo Permission."
# StaffChat | Usage Message
usage: "&cUsage: /staffchat <message>"
# [ UltraStaffChat | Permission Configuration ]
# Permission | Staff List
stafflist-perm: "usc.stafflist"
# Permission | Toggle
staffchat-toggle-perm: "staffchat.toggle"
# Permission | Mute
staffchat-mute-perm: "staffchat.mute"
# Permission | AFK
staffchat-afk-perm: "staffchat.afk"
# Permission | Join Broadcast
announce-staff-join-perm: "staffchat.join"
# Permission | Leave Broadcast
announce-staff-leave-perm: "staffchat.leave"
# Permission | Switch Broadcast
announce-staff-switch-perm: "staffchat.switch"
# Permission | Join Update Notification
update-announce-perm: "ultrastaffchat.notifyupdate"
# Permission | Talk
staffchattalkperm: "staffchat.talk"
# Permission | Read
staffchatreadperm: "staffchat.read"
# Permission | Config Reload
reloadperm: "ultrastaffchat.reload"
# Permission | Debug
debugperm: "ultrastaffchat.usedebug"
# [ UltraStaffChat | System Configuration ]
# System | Configuration File Version [ Don't change! ]
version: 35

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.