config.yml

config.yml configuration guide

The config.yml is the file where you can configurate all messages and settings the plugin has to offer.

Serverlist

The Serverlist is an important point. Its the first thing you see when adding a Server trough the Menu. With the following setting you can customize this display to your needs.

MOTD

Set up to two lines of messages you want to display in the Serverlist. This Message as well supports color codes.

  motd:
    line1: "&6Welcome to our Server!"
    line2: "&7A Minecraft Server"

Max Players

With this setting you can ajust the maximum amount of players that can join your server. This will as well be displayed in the Serverlist.

  max_players: 20

Fake Players

This feature allows you to modify the number of online players display. You can choose between two options.

Static count: Here you can set a number that will always be displayed, no matter how many players really are online.

Range: Here you can set a minimum and a maximum number. The Plugin will then take a random number between those two numbers and will display this one. The number will update depending on the dynamic_refresh setting.

  fake_players:
    enabled: false
    mode: "range" # "range" or "static"
    
    static_count: 15
    
    range:
      min: 150
      max: 185
    
    dynamic_refresh:
      enabled: true
      interval_ticks: 20

Messages

This section of the config is important to you if you wan't to change any messages used in the config. All messages you see InGame are listed here in the config and you can change them howevery you wan't to.

messages:
  prefix: "&6[SimpleEssentials] "
  no_permission: "&cYou don't have permission to use this command!"
  player_not_found: "&cPlayer not found!"
  
// and much more.....

Autobroadcast

With the Autobroadcast feature you can broadcast messages from the Server to all online players. You can set as many messages as you wan't. Every new line equals a new message (in the example there are two messages). If you wan't to break a line use "\n".

Interval: This setting let's you set how often a message is getting send (in ticks).

Mode: Here you can determin if the messages should be send in the listed way or if the plugin should make a random order.

Sound: Here you can define a sound that is played when the message is send. As well you can configurate the options of the sound.

  autobroadcast:
    enabled: false
    interval: 9000  # In ticks (20 ticks = 1 second). 9000 ticks = 15 minutes
    mode: "sequential"  # "sequential" or "random"
    sound: "BLOCK_NOTE_BLOCK_PLING"  # Sound to play when broadcasting (empty to disable)
    sound_volume: 1.0  # Sound volume (0.0 to 1.0)
    sound_pitch: 1.0   # Sound pitch (0.5 to 2.0)
    messages:
      - "&6=== Server Announcement ===\n&7Welcome to our server! &e{online}&7/&e{max_players}&7 players online.\n&7Need help? Use &e/help&7 for commands."
      - "&6=== Server Rules ===\n&aRemember to read our rules at &f/rules&a!\n&7Current time: &e{hour}:{minute}&7 on &e{day}/{month}/{year}"

Homes

The Homes feature is very simple. You can set / delete and teleport to your homes. in the config you can set the default limit how many homes players can set.

  homes:
    default_limit: 5

Debug-Settings

This setting allows you to activate the debug mode. This mode enables a lot of debug messages build into the plugin. Those will be given out in the console. If you run into any errors you can use this feature to find out what the problem is.

settings:
  debug: false

Spawn

The spawn feature is very simple. You can set a spawn manually in the config or use the /setspawn command InGame. The spawn will then be stored in the config.

Enforce Spawn on join: When this is set to true, players will be teleported to spawn everytime they join the server.

Broadcast setspawn: Will broadcast a message to everyone on the Server when the spawn was, including coordinates and world name.

Send Message on Teleport: If enabled player will always get send a message when they use the /spawn command. (message key: spawn.teleported)

spawn:
  enforce-spawn-on-join: false
  broadcast_setspawn: false
  send_message_on_teleport: true
  location:
    world: "world"
    x: 0.0
    y: 64.0
    z: 0.0
    yaw: 0.0
    pitch: 0.0

Enderchest

This is a custom Enderchest Feature (not the Vanilla Enderchest). In this config section you can create custom Enderchests a player then can open via /ec <id>.

Max IDs: Sets the maximum amount of custom enderchests that are beeing loaded.

Default Slots: Sets the default GUI size for custom Enderchests.

Slots per ID: Here you can set a custom GUI size for specified GUIs based on their ID.

enderchest:
  max_ids: 5
  default_slots: 27
  slots_per_id:
    "1": 27
    "2": 27
    "3": 36
    "4": 45
    "5": 54

Moderation

These are some small settings for the Moderation System. You can toggle on or off if you wan't that punishments from staff members are beeing broadcasted to all online players. (Default will be false)

moderation:
  broadcast_kicks: false
  broadcast_bans: false
  broadcast_unbans: false
  broadcast_unmutes: false