Proxy Configuration

Proxy Configuration

Applies to both the BungeeCord and the Velocity module — the configuration is identical.

Proxy	Folder
Velocity	plugins/fmessage/
BungeeCord	plugins/FMessageBungee/

File	Purpose
config.yml	private-message, spy and language settings
database.yml	database connection
lang_<code>.yml	all FMessage messages + ACF framework messages

Both YAML files carry a version key managed by BoostedYAML: on update, new options are merged into your file automatically. Do not edit or remove version.

---

config.yml

version: 1

lang: "en"
format:
  senderChatFormat: "&f[&7me &f => &7 {target}&f]&7: &r{message}"
  targetChatFormat: "&f[&7{sender} &f => &7 me&f]&7: &r{message}"
  spyChatFormat: "&f[&7{sender} &f => &7 {target}&f]&7: &r{message}"

Key	Description
version	Configuration schema version — managed by the plugin, leave as is
lang	Language code of the file to load, i.e. lang_<code>.yml. Shipped: en, fr. See Languages.
format.senderChatFormat	What the author of a private message sees
format.targetChatFormat	What the recipient sees
format.spyChatFormat	What /chatspy watchers see, and what is written to the proxy console

Placeholders

Placeholder	Replaced by
{sender}	nickname of the author, or their username if they have none
{target}	nickname of the recipient, or their username if they have none
{message}	the message body

Colours use legacy ampersand codes (&0–&f, &k–&o, &r). Hex colours and MiniMessage are not supported. Colour codes typed inside a player's own message are only rendered if the author holds fmessage.colors; in the spy format the message is always rendered with colours.

There is no group format in config.yml. Group messages are formatted by the acf-fmessage.group_msg key of the language file — see Languages.

---

database.yml

version: 1
database:
  url: "jdbc:mariadb://localhost:3306/test"
  user: "root"
  password: ""

Key	Description
database.url	JDBC URL of the database
database.user	Database user
database.password	Password for that user

Important — the driver is MariaDB

FMessage bundles and forces the MariaDB JDBC driver (org.mariadb.jdbc.Driver). Your URL must therefore start with jdbc:mariadb://, even when you are connecting to a MySQL server — the MariaDB driver talks to MySQL just fine.

# ✅ correct, MariaDB *and* MySQL servers
url: "jdbc:mariadb://127.0.0.1:3306/fmessage"

# ❌ will fail to connect
url: "jdbc:mysql://127.0.0.1:3306/fmessage"

The database (schema) itself must already exist and the user must be allowed to CREATE TABLE — FMessage creates its four tables on startup if they are missing. See Database.

Connections are pooled with HikariCP, with prepared-statement caching enabled (250 statements, 2048 characters).

Extra JDBC parameters

Anything the MariaDB driver accepts can be appended to the URL, for example:

url: "jdbc:mariadb://db.example.net:3306/fmessage?useSSL=true&connectTimeout=5000"

---

Applying changes

Configuration is read once at startup. There is no reload command in this version — restart the proxy after editing config.yml, database.yml or a language file.

---

See also: Bukkit Configuration for the backend-server side.