🚧Dev3lMaintenance

Here you will find instructions on how to configure the Dev3lMaintenance plugin!

Dev3lMaintenance Plugin Documentation

Important Note! This is the first premium plugin developed by me, I appreciate all the reviews and improvements you tell me!

You need to have a copy of the previously purchased license for this plugin to continue with this guide! Or you can purchase it HERE !

Can I see screenshots of its operation?

Yes, of course, here you have several screenshots of the plugin:

  • Various MOTD functions (Left-Message, Support HexColors, Icon Default)

  • Ping-Message

  • Example of Webhooks:

  • FakePlayersOnline and FakeMaxPlayers

  • Example of commands

  • MOTD Maintenance, Maintenance-Icon and Ping-Message

  • Disconnect Console Message

  • Ban Command

  • Tempban

How to configure this plugin?

The plugin is relatively simple to configure and is fully editable. You can choose whether you want to store the data using MySQL.

File Players.yml

This file is more focused on the Server Staff team, to be able to have all the information about each player in a more organized and visual way. In this file you can find different parts for each player.

Players.yml

  • [USER UUID]: will be replaced by the player's Uuid.

  • [USER IP]: will be replaced by the player's IP.

  • [USER PORT]: will be replaced by the player's port.

  • First_join: ill indicate if the player entered for the first time (true) or if he entered several times (false)

File Whitelist.yml

In this file you will find the stored players who will be able to access the server when it is under maintenance.

# ---------------------------------------
# This file is part of DevelMaintenance
# Copyright (C) 2024 The_Dev3l
# --------------------------------------

# The players who are on the whitelist will appear here, 
# who will have permission to access the server if it is under maintenance.

whitelisted_players:
  - Player1
  - Player2
  - Player3
  - The_Dev3l

File Blacklist.yml

In this file you will find all the information about a ban carried out on the server. The information of each player will be saved in such a way that each one is associated with the player, example:

  • [USER]: will be replaced by the player's name.

  • Reason: will inform what was the reason for the player's ban, otherwise, if there is not one, the reason will be shown.

  • BannedBy: will inform by who the player was banned.

  • BanDate: will inform you what date and time the player was banned.

  • Silent: varies depending on whether the player was banned in silent mode (true) or was not banned in silent mode (false)

  • History: the history of the banned player will be saved, when the player is unbanned the history will change its place next to the history that already existed for that player or otherwise a new history will continue to be added to the player in the new section.

File Blacklistip.yml

In this file you will find all the information about the bans carried out by Ip. The information of each player will be saved in such a way that each one is associated with the player, example:

Blacklistip.yml

  • [USER]: will be replaced by the player's name.

  • [USER IP]: will be replaced by the player's IP.

  • BannedBy: will inform by who the player was banned.

  • BanDate: will inform you what date and time the player was banned.

File Webhooks.yml

This file is designed to be able to edit messages, colors and even add emojis from your own server! These messages will be displayed on your Discord server thanks to the implementation of Webhooks in this plugin.

# ---------------------------------------
# This file is part of DevelMaintenance
# Copyright (C) 2024 The_Dev3l
# --------------------------------------

# Webhook sent when maintenance starts.
embed_maintenance:
  title: "🚧 Maintenance Started 🚧"
  color: '#F18A09'
  content: |-
    🎉 **%playerName%** has started maintenance.
    
    📅 **Status:** %maintenance_status%.
    📝 **Reason:** %maintenance_reason%.
    
    ⚠️ *Please be patient while we work to improve the server.*

# Webhook sent when maintenance ends.
embed_end_maintenance:
  title: "✅ Maintenance Completed ✅"
  color: '#31F109'
  content: |-
    🎉 **%playerName%** has completed maintenance.
    
    ✅ **Status:** %maintenance_status%.
    
    *Thank you for your patience and understanding!*

# Webhook sent when maintenance is scheduled.
embed_schedule:
  title: "🛠️ Scheduled Maintenance 🛠️"
  color: '#1D81F9'
  content: |-
    📅 **%playerName%** has scheduled maintenance.
    
    ⏳ **Scheduled Duration:** %maintenance_schedule%
    🔧 **Current Status:** %maintenance_status%
    
    *Prepare for a disconnection during maintenance.*

# Webhook sent when scheduled maintenance starts.
embed_scheduled_maintenance:
  title: "🛠️ Maintenance In Progress 🛠️"
  color: '#FF4500'
  content: |-
    🕒 Maintenance has begun.
    
    🚀 You’ll be notified here when maintenance is complete!
    
    **We’ll ensure everything is back up and running soon!** 🔄

# Webhook sent when scheduled maintenance ends.
embed_end_scheduled_maintenance:
  title: "✅ Scheduled Maintenance Canceled ✅"
  color: '#FF2F2F'
  content: |-
    🕒 Scheduled Maintenance has finished.
    
    ✅ **Status:** %maintenance_status%.
    
    *Thank you for your patience and understanding!*

How can I create a webhook?

Well, it's very easy! HERE you have a small guide made by Discord that explains how to create a Webhook. In the config.ymlfile, you must copy its URL and copy it where it says url: "https://discord.com/api/webhooks/your-webhook-url"

webhook:
  enabled: true
  # Replace the link between " " with the URL of the webhook you created on your Discord server.
  # You can find this link in your Discord server: Server Settings -> Integrations -> Webhooks -> New Webhook.
  url: "https://discord.com/api/webhooks/your-webhook-url"
  # When this feature is enabled, messages related to scheduled server maintenance will also be sent.
  # To enable this, webhook usage must be enabled.
  schedule_maintenance_notify: true

Folder icons

In this folder you will find some icons that the plugin already includes, here you can add all the icons you want. Below you will see a small example of the icons that come by default in the plugin when it is started for the first time.

Folder icons

  • Ban-icon.png: This icon must be renamed "ban-icon.png", it will only be shown when the same player is banned by the server's IP

  • Maintenance-icon.png: This icon should be renamed "maintenance-icon.png", it will only be shown when the server is under maintenance.

  • Server-Icon.png: This icon must be renamed "server-icon.png", this will be displayed by default when the server is not under maintenance or the player himself is banned.

Does it have the random-icons function?

Yes, of course. The plugin currently has a new functionality to be able to randomly display the icons that you want. If you have this function enabled and you do not have any icon configured correctly, "server-icon.png" will be used by default. Here are some small explanatory steps on how to enable this new function.

  • Place the icons you want to display in the plugin's icons folder.

  • Go to the plugin's config.yml file until you reach this area:

# Enable or disable the random use of the main server icon.
  use-random-icons: true
# Replace names below with desired server icon names, omitting the .png extension (e.g., "random-icon1").
  allowed-random-icons:
    - "random-icon1"
    - "random-icon2"
    - "random-icon3"

  • You must have the function "use-random-icons" activated.

  • Where it says "allowed-random-icons" you must enter the name of the icon that you have already entered previously in the icons folder, it must have exactly the same name. Example: "random-icon1". You should not put .png in this section.

If any error occurs such as format, name or size, the corresponding error will be displayed in the server console!

What format and size should the icons be in?

All icons must be in a ".png" format and must have a size of 64x64, otherwise they will not work if they do not meet these two requirements. You can use THIS web page to resize its size and format. (Credits to © convert-my-image.com).

What are the main permissions and commands of the plugin?

Here you can find a list of commands and permissions about the plugin.

Maintenance commands:

  • /maintenance on <reason> - To start maintenance

Example: /maintenance on update, when using this command the reason update will be replaced by "Server update", the same thing happens with these too:

maintenance_reasons:
  update: "Server update"
  urgent: "Urgent maintenance"
  bugfix: "Bug fix"

  • /maintenance off - To finish maintenance.

  • /maintenance schedule - To schedule maintenance.

  • /maintenance cancel- To cancel a schedule maintenance.

  • /maintenance reload - Reload plugin configuration files.

  • /maintenance version - Shows the plugin version.

  • /maintenance help - Show the help list.

Whitelist commands:

  • /whitelist add <player> - To add a player to the whitelist.

  • /whitelist remove <player> - To remove a player from the whitelist.

  • /whitelist list - To show all players in the whitelist. By clicking on the X next to the player's name he will be removed from the whitelist automatically.

  • /whitelist reload - Reload whitelist configuration.

  • /whitelist online - To show current players informing which players are added to the whitelist and which are not.

  • /whitelist help - Show the help list.

Maintenance permissions:

  • maintenance.*: All maintenance permissions.

  • maintenance.use: To be able to use maintenance commands.

  • maintenance.on: To start maintenance .

  • maintenance.off: To finish maintenance.

  • maintenance.reload: Reload plugin configuration files

  • maintenance.schedule: To schedule maintenance.

  • maintenance.cancel: To cancel a schedule maintenance.

  • maintenance.bypass: To be able to access the server when it is under maintenance.

  • maintenance.version: Shows the plugin version.

  • maintenance.help: Show the help list.

Whitelist permissions:

  • whitelist.*: All whitelist permissions.

  • whitelist.add: To add a player to the whitelist.

  • whitelist.remove: To remove a player from the whitelist.

  • whitelist.list: To show all players in the whitelist..

  • whitelist.online: To show current players.

  • whitelist.help: Show the help list.

Blacklist permissions:

  • blacklist.*: All blacklist permissions.

  • blacklist.use: To be able to use ban command.

  • blacklistip.use: To be able to use banip command.

  • unblacklist.use: To be able to use unban command.

  • unblacklistip.use: To be able to use unbanip command.

  • tempban.use: To be able to use tempban command.

  • untempban.use: To be able to use untempban command.

  • kick.use: To be able to use kick command.

  • blacklist.history: To be able to use blhstory command.

Others permissions:

  • dvdirecto.use: Use the /direct command.

  • dvannounce.use: Use the /broadcast command.

  • dbr.restart: Activate schedule Proxy restart.

What other functions does the plugin have?

Currently the plugin has multiple commands widely used on BungeeCord servers, these are found in the config.yml file, here you can see some of the ones it has:

Announce Command

As the name of the command indicates, thanks to this command you can send a messageon all servers, which supports HexColors.

This function is located in the "config.yml", in this section:

# Configuration of various internal plugin commands.
commands:  
  # When this feature is enabled, the announcement command (/broadcast) will be activated.
  announce:
    enabled: true
    prefix: '&8[&6✦ &e&lBROADCAST &6✦&8] &b»&7 ' # Prefix for announcements.
    usage-message: "&cUse: /announce <message>" # Message when player uses the command incorrectly.
    success-message: "&aAnnouncement sent successfully across all servers!" # Message when the command is successfully sent.

Try this feature right now with: 

/broadcast <message>

Streaming Command

As the name of the command indicates, thanks to this command you can send a message to all servers notifying that a player is broadcasting live on your server. This has a cooldown to prevent the command from being sent multiple times and allows only one link to be sent and not a message, for example.

This function is located in the "config.yml", in this section:

# Configuration of various internal plugin commands. 
commands:  
  # When this feature is enabled, the live stream command (/direct) will be activated.
  directo:
    enabled: true
    prefix: '&8[&6✦ &c&lDEV3L&b&lDIRECT &6✦&8] &b»&7 ' # Prefix for live streams.
    only-player-message: "This command can only be executed by a player." # Message when command is not used by a player.
    cooldown: 60  # Time in seconds a player must wait before reusing the command.
    invalid-link: "&cInvalid link"  # Message when the link is invalid.
    cooldown-message: "&cYou must wait %cooldown% second(s)"  # Message when player is on cooldown.
    usage-message: "Correct usage: /directo (link)"  # Message when player uses the command incorrectly.
    message: # Message sent to all players.
      - "&f&l+--------------------------------+"
      - "&f  Player&r&f &b%player%&r&f &fis live!"
      - "&f  Link: &e&n%link%"
      - "&f&l+--------------------------------+"

Try this feature right now with: 

/directo (link)
/stream (link)

Proxy Restart Command

As the name of the command indicates, thanks to this command you can start scheduled restart of your BungeeCord server. Players will be expelled before restarting the Proxy server to avoid causing problems, it has messages that will be sent to all servers warning of the scheduled restart and also has an action bar to be displayed on all servers.

This function is located in the "config.yml", in this section:

# Configuration of scheduled server restarts for the Proxy server (e.g., BungeeCord)
restart_bungee:
  enabled: true
  prefix: '&8[&6✦ &c&lDEV3L&f&lRESTART &6✦&8] &b»&7 ' # Prefix for restarts.
  usage-message: "&cCorrect usage: /dbr restart <time> (example: 1d 2h 30m 15s)"  # Message when player uses the command incorrectly.
  format-invalid: "&cInvalid time format. Use d (days), h (hours), m (minutes), or s (seconds)." # Message when the time format is invalid.
  confirmation-message: "&aServer will restart in &e%time% &aseconds." # Message sent when command is successful.
  restart-warning: "&cWarning! &cServer will restart in &f%time% &cseconds." # Message sent to all players.
  restart-message:  # Disconnection message for players connected when the Proxy server restarts.
    - "&f&l+-----------------------------+"
    - "&cServer is restarting."
    - "&cPlease wait until it finishes."
    - "&f&l+-----------------------------+"

  # When this feature is enabled, an action bar will be displayed across all servers, notifying of the scheduled restart.
  actionbar-enabled: true
  actionbar-message: "&cRestart in &f%time% &cseconds."

Try this feature right now with: 

/dbr restart <time> (example: 1d 2h 30m 15s)

How does the plugin's welcome system work?

The plugin's welcome system is very easy to use and does everything you want. When a new player enters, a welcome message will be displayed on all servers, along with a counter that keeps track of how many new players have entered the server for the first time.

This function is located in the "config.yml", in this section:

# Configuration of join and quit messages for players.
config:

  # When enabled, a global message will be sent on all servers when a player joins
  # the Network for the first time, along with a counter that increments with each new player.
  enable-first-join-message: true 
  first-join-message: "&7[&a+&7] &bPlayer &d%player_name% &bis player number &7(&6#%player_count%&7) &bto join the server!"

It also has a welcome and exit message for a player, these messages will only be sent on the servers you want, otherwise they will not be shown.

This function is located in the "config.yml", in this section:

# Configuration of join and quit messages for players.
config:
  # When enabled, a player's join message will be displayed.
  enable-join-message: true 
  join-message: "&7[&a+&7] &bPlayer &d%player_name% &bhas joined the server!"
  
  # When enabled, a player's quit message will be displayed.
  enable-quit-message: true 
  quit-message: "&7[&c-&7] &bPlayer &d%player_name% &bhas left the server!"
  
  # Servers where these messages will be displayed only. Example: "lobby" or "survival".
  # You can add as many as you want!
  allowed-servers:
    - "lobby"
    - "survival"

It also contains a MOTD message that will be shown in the chat for the same player who entered previously, this message will only be sent on the servers you want, otherwise it will not be shown.

This function is located in the "config.yml", in this section:

# Configuration of the MOTD message shown to the player when joining a server.
motd-chat:
  # When enabled, the message will be shown.
  enable-motd-message: true 
  motd-message:
    - "&b================================"
    - "&f     Welcome &b%player_name%"
    - ""
    - "&e      www.serverexample.com"
    - "&b================================"

  # Servers where this message will be displayed only. Example: "lobby" or "survival".
  # You can add as many as you want!
  allowed-motd-servers:
    - "lobby"
    - "survival"

What other functions does the plugin bring?

The plugin also has other very useful functions, such as:

Fake and Online Players

This function can modify both the current players that are playing and the maximum players.

Online Players

You can modify the current players in two different ways:

  • Random: A random number of players will be shown between the minimum and maximum amount entered.

This function is located in the "config.yml", in this section:

# Server MOTD configuration when not in active maintenance mode.
motd:
  # Fake current player count displayed in the MOTD.
  modify_players: 
    # Show a fake current player count in the MOTD.
    enabled: true
    # Options: "random", "percentage"
    mode: "random" 
    random:
      # Minimum random player count.
      min: 50 
      # Maximum random player count.
      max: 100

  • Percentage: The players who are online will be multiplied by the number entered. Example: if you have 0 players online, 0 times any number will show 0, otherwise it will show another figure.

This function is located in the "config.yml", in this section:

# Server MOTD configuration when not in active maintenance mode.
motd:
  # Fake current player count displayed in the MOTD.
  modify_players: 
    # Show a fake current player count in the MOTD.
    enabled: true
    # Options: "random", "percentage"
    mode: "percentage" 
    percentage:
      # Multiply current player count by this value.
      multiplier: 1.5

Fake Max Players

You can modify the maximum number of players on the server, this number only changes visually, it is not expanding the number of players.

This function is located in the "config.yml", in this section:

# Server MOTD configuration when not in active maintenance mode.
motd:
  # Show a fake maximum player number in the MOTD.
  enable_fake_max_players: true
  # Maximum number of players displayed in the MOTD.
  fake_max_players: 500

Kick Redirect

When a player is kicked or the server they were on has been restarted, they will not be kicked, but rather will be taken to a Limbo or default server, preventing the player from having to re-enter. The Limbo server and the message that will be sent to the player informing them that they have been redirected are completely configurable.

This function is located in the "config.yml", in this section:

# When enabled, if a player is kicked, a server shuts down, or a server crashes,
# players on that server will be automatically redirected to the specified lobby or main server.
kick-redirect:
  enabled: true        
  server: "lobby"      
  message: 
    - "&b======================================"
    - "&a&lYou have been redirected to the main server!"
    - ""
    - "&eDon't worry, everything is fine :)"
    - "&7You were redirected from another server"
    - "&7because it was restarted or went offline."
    - "&b======================================"

Disconnect-Console-Messages

As its name suggests, when a player is disconnected from a specific server, they will be notified in the console. This function is most used by the server Staff team.

This function is located in the "config.yml", in this section:

# Messages displayed in the console when a player disconnects from a server. Useful for logging events.
disconnect-console-messages:
  enabled: true 
  from-server: "&6Player &e%player% &6disconnected from server &e%server%&6."
  no-server: "&6Player &e%player% &6disconnected, but was not assigned to any server."

Log-Client-Protocol

By activating this function, when a player enters or pings the server it will be notified on the console informing the IP of the player and the protocol of his client that he is using, I implemented a function where it says next to it, informing which version of Minecraft he is using exactly. This function is widely used by the server Staff team.

This function is located in the "config.yml", in this section:

# Configuration for displaying the client’s protocol version in the console. 
# Example: Client pinging from "User IP" with protocol: 764 (MC 1.20.2)
log-client-protocol: true

How does the plugin's blacklist system work?

The plugin's blacklist system is very simple to use, very easy to configure and very intuitive. When banning a player or unbanning a player, a message will be sent to all servers notifying that the player has been banned or unbanned. If you do not want the message to be shown, you can ban the player silently.

It also has a unique function, when a player is banned by IP, the MOTD for that player will change indicating that the player is banned, also the server protocol message, these functions can be found in:

# Enable or disable the blacklist system (ban/kick/unban/tempban)
blacklist:
  enabled: true
  # Prefix for bans.
  prefix: '&8[&6✦ &c&lDEV3L&f&lBANS &6✦&8] &b»&7 ' 
  # Enable or disable the MOTD system.
  motd: true
  # MOTD messages for banned players.
  banned_motd1: "&c⚠ &6You have been banned from the server."
  banned_motd2: "&7You may contact an administrator."
  # Protocol (version) display when banned.
  banned_protocol_text: "&cBanned"

The system has multiple commands such as:

  • /ban <player> <reason>[-s] - To ban a player. Use [-s] to silently ban a player without displaying any public message.

  • /unban <player> - To unban a player who is banned.

  • /banip <player> - To ban a player by IP.

  • /unbanip <player> - To unban a player banned by Ip.

  • /tempban <name/IP> (example: 2d, 5h, 30m, 20s) - To ban a player temporarily, both by IP and username.

  • /untempban <name/IP> - To unban a temporarily banned player.

  • /kick <player> - To ban a player from the server.

  • /blhistory <player> - To show a player's ban history.

These functions are located in the "config.yml", in this section:

# Enable or disable the blacklist system (ban/kick/unban/tempban)
blacklist:
  enabled: true
  # Prefix for bans.
  prefix: '&8[&6✦ &c&lDEV3L&f&lBANS &6✦&8] &b»&7 ' 
  # Enable or disable the MOTD system.
  motd: true
  # MOTD messages for banned players.
  banned_motd1: "&c⚠ &6You have been banned from the server."
  banned_motd2: "&7You may contact an administrator."
  # Protocol (version) display when banned.
  banned_protocol_text: "&cBanned"
  # Default reason message for banned players.
  default-reason: "Misconduct."
  # Message if the command is disabled.
  not-online: "&cPlayer %player% is not online."
  # Message if the player was previously banned.
  already-banned: "&cPlayer %player% is already banned."

  history:
    not-found: "No ban history found for player %player%"
    history-message: "Ban history for %player% :"

  ban:
    ban-usage-message: "&cUse: /ban <player> <reason> [-s]"
    not-online: "&aPlayer %player% is not online but has been banned."
    silent-ban-message: "&cPlayer %player% has been silently banned."
    bypass-message: "&cYou cannot ban %player% as they have bypass permission."
    # Message sent across all servers when a user is banned.
    ban-message:
      - "&b╔═══════════════════════════════╗"
      - "&b║       &c⚠  Player Banned  ⚠     &b║"
      - "&b╠═══════════════════════════════╣"
      - "&b║ &fPlayer: &b%player%             &b║"
      - "&b║ &fReason: &b%reason%             &b║"
      - "&b║ &fBanned by: &b%moderator%       &b║"
      - "&b╚═══════════════════════════════╝"
    # Message shown to the banned user on the server.
    kick-message:
      - "&c&lYOU HAVE BEEN BANNED FROM THE SERVER"
      - " "
      - "&7Name &8:"
      - "&f%player_name%"
      - " "
      - "&7Reason &8:"
      - "&f%ban_reason%"
      - " "
      - "&7By moderator &8:"
      - "&f%ban_moderator%"
      - " "
      - "&c&lIf you think this is a mistake, contact support."

  unban:
    empty-list: "The list of banned players is empty."
    unban-usage: "&cUse: /unban <player>"
    silent-unban: "&aPlayer %player% has been unbanned silently."
    player-not-found: "&cPlayer %player% is not on the ban list."
    # Message sent across all servers when a user is unbanned.
    unban-message:
      - "&b╔═══════════════════════════════╗"
      - "&b║    &a✅  Player Unbanned ✅     &b║"
      - "&b╠═══════════════════════════════╣"
      - "&b║ &fPlayer: &b%player%             &b║"
      - "&b║ &fUnbanned by: &b%moderator%     &b║"
      - "&b╚═══════════════════════════════╝"

  kick:
    usage-message: "&cIncorrect usage. Use: /kick <player> [reason]"
    success-message: "&aYou have successfully kicked %player%"
    not-online: "&cPlayer %player% is not currently on the server."
    # Message displayed to the kicked user.
    kick-message: 
      - "&c&lYOU HAVE BEEN KICKED FROM THE SERVER"
      - " "
      - "&7Name &8:"
      - "&f%player_name%"
      - " "
      - "&7Reason &8:"
      - "&f%kick_reason%"
      - " "
      - "&c&lIf you think this is a mistake, contact support."

  temp_ban:
    format-invalid: "&cInvalid time format. Use d (days), h (hours), m (minutes), or s (seconds)."
    usage-message: "&cUse: /tempban <name/IP> <time> (example: 2d, 5h, 30m, 20s)"
    ban_success: "&aPlayer %player% has been temporarily banned for %time%."
    unban_success: "&aPlayer %player% has been automatically unbanned."
    unban_fail: '&cPlayer %player% is not on the temporary ban list.'
    unban_usage_message: '&cIncorrect usage. You must specify the player/IP. Example: /untempban <player/IP>.'
    # Message displayed to the temporarily banned user on the server.
    ban_message: 
      - "&c&lYOU HAVE BEEN TEMPORARILY BANNED"
      - " "
      - "&7Your name &8:"
      - "&f%player_name%"
      - " "
      - "&7Your IP &8:"
      - "&f%ip_address%"
      - " "
      - "&7By moderator &8:"
      - "&f%ban_moderator%"
      - " "
      - "&7Time left for ban &8:"
      - "&f%time_left%"
      - " "
      - "&c&lIf you think this is a mistake, contact support."

  banip:
    usage-message: "&cUse: /banip <player>"
    not-online: "&cPlayer %player% is not online."
    already-banned: "&cThe IP of %player% is already banned."
    success-message: "&aThe IP of %player% has been successfully banned."
    # Message displayed to the user banned by IP from the server.
    banip-message: 
      - "&c&lYOU HAVE BEEN BANNED BY IP FROM THE SERVER"
      - " "
      - "&7Your name &8:"
      - "&f%player_name%"
      - " "
      - "&7Your IP &8:"
      - "&f%ip_address%"
      - " "
      - "&7By moderator &8:"
      - "&f%ban_moderator%"
      - " "
      - "&c&lIf you think this is a mistake, contact support."

  unbanip:
    usage-message: "&cUse: /unbanip <player>"
    not-banned: "&cPlayer %player% is not banned."
    success-message: "&aThe IP of %player% has been successfully unbanned."

How to connect this plugin to a Database?

Currently this plugin has a MySQL database for the maintenance system, to activate this function, simply go to the "config.yml" file and enter the necessary information for it to work, this section is located in:

# MYSQL Database Configuration.
database:
  # Set to 'false' to disable MySQL usage.
  use-database: false
  mysql:
    host: "localhost"
    port: 3306
    database: "maintenance_logs"
    username: "your_username"
    password: "your_password"

Dev3lAPI

The Dev3lAPI provides a streamlined way for developers to interact with the Dev3lMaintenance plugin, offering methods to manage whitelist/blacklist features, retrieve player information, control plugin settings, and check maintenance status. Below is the detailed usage guide.

Initialization

Required Import Statement:

import com.dev3l.api.Dev3lAPI;

Methods

Whitelist Management

isPlayerWhitelisted(String playerName)

  • Description: Checks if a player is in the whitelist.

  • Parameters:

    • String playerName: The name of the player.

  • Returns: true if the player is whitelisted; otherwise false.

boolean isWhitelisted = Dev3lAPI.isPlayerWhitelisted("PlayerName");

addPlayerToWhitelist(String playerName)

  • Description: Adds a player to the whitelist and saves the whitelist.

  • Parameters:

    • String playerName: The name of the player to add.

Dev3lAPI.addPlayerToWhitelist("PlayerName");

removePlayerFromWhitelist(String playerName)

  • Description: Removes a player from the whitelist and saves the whitelist.

  • Parameters:

    • String playerName: The name of the player to remove.

Dev3lAPI.removePlayerFromWhitelist("PlayerName");

Player Management

getPlayerByName(String name)

  • Description: Retrieves a ProxiedPlayer object by the player's name.

  • Parameters:

    • String name: The name of the player.

  • Returns: A ProxiedPlayer object, or null if the player is not online.

ProxiedPlayer player = Dev3lAPI.getPlayerByName("PlayerName");

Ban Management

isPlayerBanned(String playerName)

  • Description: Checks if a player is banned.

  • Parameters:

    • String playerName: The name of the player.

  • Returns: true if the player is banned; otherwise false.

boolean isBanned = Dev3lAPI.isPlayerBanned("PlayerName");

getBannedPlayers()

  • Description: Retrieves a list of all banned players.

  • Returns: A List<String> containing the names of all banned players.

List<String> bannedPlayers = Dev3lAPI.getBannedPlayers();

isIpBanned(String ip)

  • Description: Checks if an IP address is banned.

  • Parameters:

    • String ip: The IP address to check.

  • Returns: true if the IP is banned; otherwise false.

boolean isIpBanned = Dev3lAPI.isIpBanned("127.0.0.1");

getBannedIps()

  • Description: Retrieves a list of all banned IP addresses.

  • Returns: A List<String> containing the banned IPs.

List<String> bannedIps = Dev3lAPI.getBannedIps();

Maintenance Mode

isMaintenanceEnabled()

  • Description: Checks if maintenance mode is enabled.

  • Returns: true if maintenance mode is active; otherwise false.

boolean maintenanceEnabled = Dev3lAPI.isMaintenanceEnabled();

Webhook Settings

areWebhooksEnabled()

  • Description: Checks if webhooks are enabled in the plugin configuration.

  • Returns: true if webhooks are enabled; otherwise false.

boolean webhooksEnabled = Dev3lAPI.areWebhooksEnabled();

Icon Management

getCurrentIcon()

  • Description: Retrieves the name of the currently selected server icon.

  • Returns: The name of the current icon as a String.

String currentIcon = Dev3lAPI.getCurrentIcon();

setCurrentIcon(String iconName)

  • Description: Sets the current server icon in the plugin configuration and saves the configuration.

  • Parameters:

    • String iconName: The name of the icon to set.

Dev3lAPI.setCurrentIcon("NewIconName");

Example Usage

// Import the Api
import com.dev3l.api.Dev3lAPI;

// Check if a player is whitelisted
boolean isWhitelisted = Dev3lAPI.isPlayerWhitelisted("PlayerName");

// Add a player to the whitelist
Dev3lAPI.addPlayerToWhitelist("The_Dev3l");

// Remove a player from the whitelist
Dev3lAPI.removePlayerFromWhitelist("The_Dev3l");

// Check if maintenance mode is enabled
boolean maintenance = Dev3lAPI.isMaintenanceEnabled();

// Get the current server icon
String currentIcon = Dev3lAPI.getCurrentIcon();

This API provides straightforward methods for interacting with the plugin's core features.

PreviousWho am I?

Last updated