Configuration โ
Main configuration for FlectonePulse
, without which the plugin cannot function
โ๏ธ Setting โ
๐ Path config.yml
โ๏ธ Default
โ
yml
console: "Console"
version: "0.5.4"
language: "en_us"
language-player: true
metrics: true
bungeecord: false
velocity: false
clusters: []
log-filter:
- "Paper Async Command Builder"
- "Caught previously unhandled exception :"
- "Error received from Telegram GetUpdates Request"
- "OkHttp TaskRunner"
database:
type: SQLITE
name: "flectonepulse"
host: "localhost"
port: "3306"
user: "root"
password: "1234"
parameters: "?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8"
module:
enable: true
console
โ
Used to display the name when the message is created by the console
version
โ
The current version of the plugin, used for proper transitions between plugin versions
WARNING
Do not change the plugin version unless you know what you're doing!
language
โ
Localization used for all plugin messages
WARNING
The selected localization must be from the localizations
folder
You can create and use your own localizations. To do this:
- Copy one of the files
- Rename it, preferably as in the game
- Now you can modify any messages inside this file
Example
I want to translate the plugin into Belarusian
- I copy the file
ru_ru.yml
- Rename it to
be_by.yml
- Done!
language-player
โ
When enabled, each player's Minecraft localization will be checked, and based on that, the message from localizations will be shown.
If the localization does not exist, the one from configuration will be used.
VERY IMPORTANT TO UNDERSTAND
If you modify the message lists with language-player
enabled, you need to do this in all localizations, otherwise visual errors may occur.
metrics
โ
Allows the plugin to collect statistics about the server and plugin parameters
bungeecord
โ
TO MAKE THE PLUGIN WORK WITH BUNGEECORD:
- Enable it here
- For BungeeCord server, place the
FlectonePulse-bungee.jar
file in theplugins
folder - Restart BungeeCord and the servers where FlectonePulse is installed
velocity
โ
TO MAKE THE PLUGIN WORK WITH VELOCITY:
- Enable it here
- For Velocity server, place the
FlectonePulse-velocity.jar
file in theplugins
folder - Restart Velocity and the servers where FlectonePulse is installed
clusters
โ
A list of clusters to which the server should be connected. Only used when proxy mode is enabled. If the list is empty, the server will receive messages from all other servers.
HOW TO USE?
You need to enter the cluster name on the servers where the message will be received and sent
yaml
clusters:
- "test_cluster"
This connects the servers together, and messages will only be exchanged between these clusters.
log-filter
โ
The idea is borrowed from here, thanks to @Whitescan
A list is specified with messages that should not be shown, using keywords found in the message.
EXAMPLE I WANT TO FILTER
Then you should add: Unknown or incomplete command
or command
or Unknown
database
โ
You can use environment variables, for example ${VALUE}
Database Setup
type
โ
Currently supported:
SQLite
- localMYSQL
- server-side
name
โ
Database name
host
(for MySQL) โ
The address of the server hosting the database
port
(for MySQL) โ
The port for connecting to the database server
user
(for MySQL) โ
The username to be used for database connection
password
(for MySQL) โ
The password for the database connection
parameters
(for MySQL) โ
Connection parameters for the database
module โ
Enables or disables all modules
- Each module has a parent (the one above it)
EXAMPLE
yaml
house:
door:
chair:
house
is the parent for door
and chair
- Each module depends on the
enable
status of its parent
EXAMPLE
yaml
house:
enable: false
door:
enable: true
chair:
enable: true
Since house
is disabled, regardless of whether door
and chair
are enabled, they will also be disabled.