⚙️Settings.yml Tutorial

This is the general configuration file for the RealmCore plugin. Below, you will find all the sections explained.

#
#   ╔═══╗─────╔╗───╔═══╗
#   ║╔═╗║─────║║───║╔═╗║
#   ║╚═╝╠══╦══╣║╔╗╔╣║─╚╬══╦═╦══╗         Settings
#   ║╔╗╔╣║═╣╔╗║║║╚╝║║─╔╣╔╗║╔╣║═╣        Version: 0.1.06
#   ║║║╚╣║═╣╔╗║╚╣║║║╚═╝║╚╝║║║║═╣
#   ╚╝╚═╩══╩╝╚╩═╩╩╩╩═══╩══╩╝╚══╝
#

lang: "en"

realm:
  # In this category, you will be able to edit whether the creation of the realm is automatic or manual.
  creator:
    # It is recommended to leave this option as "true".
    automatic: true  # If you leave this option as true, the realm will be created automatically when the player joins the server. If you set it to false, the /realm create command will be enabled so that each player can create their realm manually.
  # In this category, you can edit if you want the realms to be created with a template.
  template:
    enabled: false # If you set this option to true, you enable realm templates, meaning that all realms will be identical to the world you place in the /template folder, which can be found in the /RealmCore folder.
    template: "world-template" # This will be the name that the template world folder must have in order to be detected.
  # In this category, you can edit the main parameters of the realms.
  default:
    # You adjust how much distance you want the realm of each player to have initially.
    border: 200
    view-distance: 4
    structures: false
    type: NORMAL
    environment: NORMAL
  # In this category, you can edit the main parameters of the realm bossbar
  bossbar:
    enabled: true
    update: 20 # in ticks   20 ticks = 1 s
    display: "&#828282ℹ &7&n%realmcore_realm_name%&7&n's&r &7Realm  %realmcore_player_tag%  &8|  &f%realmcore_realm_time% %realmcore_realm_timeicon%"
    color: WHITE
    style: SOLID
    tags:
      owner: "&cᴏᴡɴᴇʀ"
      trusted: "&3ᴛʀᴜꜱᴛᴇᴅ"
      visitor: "&aᴠɪsɪᴛᴏʀ"
      day_icon: "&#f0f021☀"
      night_icon: "&#625bd4☽"
  # This section allows you to modify some of the settings of the realm's own chat.
  chat:
    # When modifying the format, do not touch the "%s" tags as they contain the name, tag, and content.
    format: "&8▶ &8[&7Realm Chat&8]&7 %s &f%s &8»&7 %s"
  # In this category, you can modify the parameters of the /realm kick command.
  kick:
    # In this section, you can edit the name of the world that will be used when a player is kicked; they will be redirected to this world.
    kick-world: "world"

commands:
  setspawn:
    # You adjust in seconds the amount of waiting time the player will have to wait each time they execute the /realm setspawn command.
    cooldown: 60
  reset:
    # You can set in seconds the amount of waiting time the player will have to wait each time they reset their world with /realm reset.
    cooldown: 3600

# This option enables compatibility with Bedrock using Floodgate to adapt the plugin's menus. You can check the
# Floodgate wiki here: https://geysermc.org/wiki/floodgate/setup/?platform=proxy-servers (This is for those who
# have a server connected with a proxy). If you're using a single server, installing the Floodgate and Geyser plugin is enough.
enable_bedrock_support: false

# This option allows you to activate an interactive web panel to view statistics of the realms or modify various settings.
# Before enabling this option, keep in mind that you need to have an open port on your server for the page to function.
web_panel:
  enabled: false
  # In the IP parameter, you need to replace it with the IP address of your server.
  ip: "0.0.0.0"
  # In the port parameter, you need to replace it with the port you have opened on your server.
  port: 8123
  # Here, you adjust the length of the token that will be generated to securely access the page.
  # Try to keep this value between 10 and 20 (the longer it is, the more secure it is, but it will take longer to generate).
  token_length: 12

Realm section

Creator

In this section, you will find the option to enable or disable automatic mode. By default, it is set to true. If you leave it set to true, when a player joins, if they don't have a realm or if they already have one, it will load without needing to execute any command.

However, if you set the option to false, the /realm create command will be enabled, which the player will have to use manually to create or load their realm.

Template

In this section, you can edit to enable or disable having all realms be the same using a template. By default, this is set to false, meaning the world will be generated with the normal generator.

To use our template, which in this case has to be a world folder, we need to copy it to the following path: plugins/RealmCore/template. You can edit the name using the template: "world-template" option. The world you paste in this path must have the same name as the one defined here.

Default

We can edit the border, and this will affect all realms that are created, giving them this border. If it's changed, realms that previously had a different default border will be updated when the server is restarted.

We can edit the view-distance of the same realm, which works independently from the one set in the server settings.

We can define whether we want structures to generate in the realm.

We can define the type and environment. This depends on the atmosphere you want the realm to have, but if you're not very experienced, I recommend not changing it and leaving it set to NORMAL.

Bossbar

First of all, you can edit whether you want to enable the informational bossbar within each realm. It is recommended to leave this option set to true, as it helps to know the player's role in the realm (owner, trusted, visitor...) as well as the realm's time.

We can modify the bossbar update time to refresh its content. By default, it is set to 20. This value is in ticks, which equals 1 second. If you notice that the bossbar is causing performance issues due to its updates, you can increase this value.

In the display section, we can modify all the content that will appear on the bossbar. Here, we can find variables like the player's role who is viewing the bossbar (%realmcore_player_tag%). There’s also the name of the realm we are in (%realmcore_realm_name%) and the current time of the realm (%realmcore_realm_time%), along with a tag to know if it's day or night (%realmcore_realm_timeicon%). In this field, you can add variables from PlaceholderAPI if you want to include more information on the bossbar.

We have the option to change the color of the bossbar using the colors available in Minecraft. By default, it is set to WHITE, but you can use other colors such as: BLUE, YELLOW, RED, and more.

We have the option to change the style of the bossbar. By default, it is set to SOLID, which makes it appear smooth, but you can use NOTCHED_6, NOTCHED_10, NOTCHED_12, and NOTCHED_20 if you want it to be segmented.

Tags

In this section, we can customize the visual appearance of the tags for owner, trusted, and member, as well as the icon's state for day or night.

Chat

We have the chat option, which allows us to change the message format of the /realm chat.

It is important not to modify the "%s" as they will be replaced with the name, tag, and message content.

Commands

In this section, we can see options to modify the cooldown for the /realm reset and /realm setspawn commands, corresponding to each section.

It's important to note that the cooldown value is in seconds.

Bedrock support section

This option enables compatibility with Bedrock using Floodgate to adapt the plugin's menus.

You can check the Floodgate wiki here: https://geysermc.org/wiki/floodgate/setup/?platform=proxy-servers (This is for those who have a server connected with a proxy).

If you're using a single server, installing the Floodgate and Geyser plugin is enough.

Web panel section

By default, this function is disabled. You can enable it by setting enabled to true and modifying the IP and port below. Keep in mind that to use the web panel, you need a free port dedicated to the panel.

In the IP section, you will need to enter the server's IP. If you have a domain connected to that IP, you can enter the domain instead, as it will work the same way.

In the port section, you need to enter the port that you have specifically opened for the web panel. If the port is in use, it will not work.

The token length section is a bit more complex, as it determines the length of the token used to access the page. For example, in the URL http://localhost:8080/a1edw72n, the token length is 8 characters. It's important to be careful when sharing the token, as anyone with access to it could enter the page. A new token is generated each time the server is restarted.