multichatsponge.yml

############################################################
# +------------------------------------------------------+ #
# |                   MultiChatSponge                    | #
# +------------------------------------------------------+ #
############################################################

# By Revilo410

##################
#   DON'T EDIT   #
version: "1.8"   #
##################

This is the config version, do not touch it or your plugin might break!

---

# Specify the name of this server here for the %SERVER% placeholder
server_name: "SPONGE"

Since Sponge does not have a way to set the server name in the same way as Spigot, this setting will be used to tell MultiChat what to call this server. This is used for the %SERVER% placeholder.

---

############################################################
# +------------------------------------------------------+ #
# |                        Global                        | #
# +------------------------------------------------------+ #
############################################################

# Should this server use a different format for the global chat than the one assigned in the Proxy Plugins folder?
# ( Useful if you want to use local placeholders that may only be present on one server )
override_global_format: false

# The format to use for the global chat if the setting above is set to true
# 
# USES STANDARD MINECRAFT '&X' COLOUR/FORMAT CODES
# %NAME% = The name of the sender
# %DISPLAYNAME% = The display name of the sender
# %PREFIX% = The prefix of the sender
# %SUFFIX% = The suffix of the sender
# %NICK% = The nickname of the sender
# %SERVER% = The server of the sender
# %WORLD% = The world of the sender
# %MODE% = The chat mode of the player, "Global" or "Local", %M% will do "G" or "L"
#
# Will display as [FORMAT] [MESSAGE]
override_global_format_format: "&5[&dG&5] &f%DISPLAYNAME%&f: "

The above settings allow you to define an "overriding" global chat format. This means that messages sent from this server to the global chat will use this format rather than the one defined in your main MultiChat config.yml file.

---

############################################################
# +------------------------------------------------------+ #
# |                        Local                         | #
# +------------------------------------------------------+ #
############################################################

# The local chat format for this server
# 
# USES STANDARD MINECRAFT '&X' COLOUR/FORMAT CODES
# %NAME% = The name of the sender
# %DISPLAYNAME% = The display name of the sender
# %PREFIX% = The prefix of the sender
# %SUFFIX% = The suffix of the sender
# %NICK% = The nickname of the sender
# %WORLD% = The world of the sender
# %SERVER% = The server of the sender
#
# Will display as [FORMAT] [MESSAGE]
local_chat_format: "&3[&bL&3] &f%DISPLAYNAME%&f: &7"

This section allows you to define how the local chat works for this server. You can set the format multichat will use.

---

############################################################
# +------------------------------------------------------+ #
# |                  MultiChat Nicknames                 | #
# +------------------------------------------------------+ #
############################################################

# Players will be blocked from using any nicknames on this list!
# Regular expressions can be used
# (?i) is the regular expression term to ignore case
nickname_blacklist:
- "(?i)Notch"
- "(?i)Jeb"
#- "[1234567890]+.*" # <-- Example to block any nicknames starting with a number!

# Should a prefix be displayed before nicknames to differentiate them from real names?
show_nickname_prefix: false

# What should the prefix before nicknames be?
nickname_prefix: "~"

# The maximum length for nicknames
nickname_length_limit: 20

# The minimum length for nicknames
nickname_length_min: 3

# Should formatting codes such as "&3" be counted in the length of the nickname?
nickname_length_limit_formatting: false

These settings can be used to control how nicknames work on the local server. In the nickname blacklist you can specify nicknames you do not want players to be allowed to use. These work using regular expressions to make it easier. Putting the characters "(?i)" at the start will make it case-insensitive.

If the prefix setting is set to true then MultiChat will display the prefix before a players nickname so it is clear that is not their real name.

For example, if my name is Revilo410, I might be displayed in chat as "[Owner]Revilo410", but if I then nicknamed myself to "Revilo", I would be displayed as "[Owner]~Revilo". This is similar to plugins like Essentials.

There are also options to control the min and max lengths of nicknames set (this can be overridden by giving players multichatsponge.nick.anylength permission)

---

# Should MultiChat use a database to store nicknames instead of regular files?
# (PLEASE NOTE THE SERVER MUST BE RESTARTED FOR THIS TO TAKE EFFECT)
nickname_sql: false

# If the above option is true, MultiChat will use SQLite by default. Set the below to true if you would prefer to use MySQL.
mysql: false
mysql_url: "" # For example "localhost:3306"
mysql_database: "" # Put the name of your MySQL database here
mysql_user: ""
mysql_pass: ""

The above settings allow you to configure an SQL database for MultiChatSponge. By setting nickname_sql to true MultiChat will start using SQLite for nicknames. You can migrate from file based storage to SQL by running /multichatsponge migratetosql from console. If you prefer to use MySQL instead of SQLite then set mysql: true as well as nickname_sql: true. You can then configure the settings for your MySQL below.

Note that while it is possible to convert to SQL from file based storage, it is not yet possible to go back the other way.

In order to run the /multichatsponge migratetosql command you need to have turned on the applicable SQL settings as described above and restarted your server.