FlectonePulse — Documentation

Complete guide to setting up and using FlectonePulse

Frequently Asked Questions (FAQ)

1. What is FlectonePulse and what is it used for?

FlectonePulse is a plugin for Minecraft servers that allows full customization of messages, chat, commands, and integrations. It supports all popular platforms (Bukkit, Spigot, Paper, Purpur, Folia, BungeeCord, Velocity) and provides a flexible text formatting system, automatic player language detection, and integrations with Discord, Telegram, and Twitch.

2. How to install FlectonePulse?

1. Download the plugin from Modrinth.
2. Place the plugin file in the plugins folder of your server.
3. Restart the server.
4. Configure the settings in the configuration files.

File	Documentation Link	Explanation
config.yml	Configuration	Main FlectonePulse configuration, essential for proper operation. This is where the database, plugin language, proxy mode, etc., are configured.
command.yml	Commands	Configuration of all custom commands. They can be used by typing /flectonepulse:command_name in Minecraft.
integration.yml	Integrations	Configuration of interactions with external plugins and services.
message.yml	Messages	Configuration of FlectonePulse messages (conditions for their appearance and content). Do not confuse with message format configuration, which is done in the /localizations/... files.
localizations/...	Specified in each section of the commands and messages documentation	This folder contains files with settings for each player language (see language). This is where the format of messages, i.e., the text, is configured.
permission.yml	Specified in each section of the commands, messages, and integrations documentation	Configuration of access permissions. By default, permissions are set so that most functions are available to all players without additional configuration.

3. How to configure message formatting?

FlectonePulse has a versatile text formatting system supporting various color formats, from classic codes to modern gradients.

Input Color	Converted to
&0-&9, &a-&f	<black>, <dark_blue> ... <white>
&l/&m/&n/&o/&k/&r	<b> / <st> / <u> / <i> / <obf> / <reset>
&#rrggbb, #rrggbb, &x&r&r&g&g&b&b, <##rrggbb>	<#rrggbb>
MiniMessage Tags	<color:#rrggbb>, <rainbow>, <click:...>, <font>, etc.

For flexibility, you can use & or § as interchangeable symbols.

welcome-message: "<gradient:#FF0000:#00FF00>&lHello</gradient> <rainbow><player></rainbow>!"

4. Can certain plugin features be disabled?

Yes, FlectonePulse uses a modular system. Any feature (commands, messages, or integrations) can be disabled in the command.yml, message.yml, or integration.yml files, respectively. After making changes, restart the plugin with the /flectonepulse reload command.

5. How does automatic language detection work?

If the language-player option is enabled in config.yml, the plugin automatically detects the player's Minecraft language and displays messages from the localizations/... folder in that language. If the localization is unavailable, the default language from the configuration is used. Details in the localization documentation.

6. What integrations does FlectonePulse support?

The plugin integrates with Discord, Telegram, and Twitch, allowing players to communicate across different platforms. It also supports third-party Minecraft plugins, such as preventing muted players from speaking in PlasmoVoice and SimpleVoice. Integration settings are configured in the integration.yml file. Details in the integrations documentation.

7. How to use the /chatsetting command?

Type the /chatsetting command in the chat to configure chat and related features (e.g., color, style, notifications).

8. Does FlectonePulse support PlaceholderAPI?

Yes, FlectonePulse is fully compatible with PlaceholderAPI and MiniPlaceholders. Use placeholders in messages.

9. How to use the /symbol command?

Type the /symbol command in the chat to search for and use Unicode emojis.

10. Are there chat-based mini-games?

Yes, players can use built-in mini-games such as tic-tac-toe or rock-paper-scissors.

11. How is FlectonePulse different from FlectoneChat?

FlectonePulse is a new project, not an improved version of FlectoneChat. FlectoneChat was an experiment, while FlectonePulse was built with past mistakes in mind, offering more features and customization.

12. How to enable displaying the player's name above their head?

Enable the name-visible setting in the message.yml file:

scoreboard:
  enable: true
  name-visible: true
  color: "<white>"
  prefix: "<vault_prefix><stream_prefix>"
  suffix: "<afk_suffix><vault_suffix>"
  ticker:
    enable: false

After making changes, run the /flectonepulse reload command. Details in the configuration documentation.

13. How to configure the player's name display?

Player name configuration is done in the localizations/... files:

name-:
  constant: ""
  display: "<click:suggest_command:\"/msg <player> \"><hover:show_text:\"<fcolor:2>Write to <player>\"><vault_prefix><stream_prefix><fcolor:2><player></fcolor><afk_suffix><vault_suffix></hover></click>"
  entity: "<fcolor:2><hover:show_text:\"<fcolor:2><lang:'<name>'> <br><fcolor:1>Type <fcolor:2><lang:'<type>'> <br><fcolor:1>ID <fcolor:2><uuid>\"><lang:'<name>'></hover></fcolor:2>"
  unknown: "<fcolor:2><name></fcolor:2>"

After changes, run /flectonepulse reload. Details in the localization documentation.

14. How to configure colors in messages and the interface?

Color configuration is done in the message.yml file using the color module:

color:
  enable: true
  use-recipient-colors: true
  values:
    1: "#ADD8E6"
    2: "#87CEFA"
    3: "#A9A9A9"
    4: "#FFFAFA"

This sets default colors if the player hasn’t chosen their own in /chatsetting or /chatcolor. You can disable color changes in the respective commands. Details in the formatting guide.

TIP

It’s easier to change the 4 colors here than to replace <fcolor:> in all plugin settings.

15. How to configure the TAB (player list)?

To enable/disable TAB modules, configure the message.yml file:

tab:
  enable: true
  header:
    enable: true
  footer:
    enable: true
  playerlistname:
    enable: true

To modify messages, edit the localization file in localizations/...:

tab:
  header:
    lists:
      - - " "
        - "<fcolor:1>👾"
        - " "
      - - " "
        - "<fcolor:1>❤"
        - " "
  footer:
    lists:
      - - " "
        - "<fcolor:1>TPS <tps>, Online <online>"
        - " "
      - - " "
        - "<fcolor:1>Hello <fcolor:2><player></fcolor:2>!"
        - " "
  playerlistname:
    format: "<world_prefix>▋ <reset><vault_prefix><stream_prefix><fcolor:2><player><afk_suffix><vault_suffix>"

IMPORTANT

To sort the TAB by donation groups, enable tab-sort.

After changes, run /flectonepulse reload. Details in the TAB documentation.

16. What to do if errors occur?

1. Check the server console for errors and send them to the Discord community for assistance.
2. Ensure you’re using the latest version of the plugin.
3. Review the documentation or get personalized technical support for boosters on Boosty.

17. How to contact the developers?

Join the Discord community for support and suggestions. Leave a star on GitHub or a review on SpigotMC.

18. When will the new version of FlectonePulse with support for the latest Minecraft version be released?

FlectonePulse likely already supports the latest Minecraft version. Experimental versions are available for download on GitHub or in the Discord testers channel. If a Minecraft version is released and FlectonePulse hasn’t been updated, it’s due to waiting for the release of PacketEvents, the main library used by FlectonePulse for server interaction. Once PacketEvents is released, FlectonePulse will be updated.

CAUTION

Use test versions at your own risk. These versions are often not intended for production use and may be unstable or break previous versions of FlectonePulse.

19. Does FlectonePulse work with proxies, and how to configure it?

FlectonePulse supports proxy servers, including BungeeCord and Velocity. The same plugin file must be installed on both the proxy and the server. Configuration files are not created on the proxy—it acts as a bridge. All settings are configured in the server files. A MySQL database connection must be set up in the config.yml file on the servers. Additionally, enable either the velocity or bungeecord mode. Details in the configuration documentation.

20. Does FlectonePulse support cores that run mods and plugins simultaneously, like Arclight or Mohist, and will it be available for Fabric?

FlectonePulse has not been tested on cores that support both mods and plugins (e.g., Arclight or Mohist), and support is not planned. The main issue is the Libby library used for dependency loading, which does not work on such cores. Theoretically, FlectonePulse could be built with all necessary dependencies for these cores, but there’s no guarantee of proper PacketEvents functionality. Support for Fabric is planned in the future, but only for the latest versions.

🚀 Start using FlectonePulse today!