Welcome to the very best and last homes plugin you'll ever need!

EpicHomes

This homes plugin is a very highly optimised and recourse efficient plugin that makes use of the very lates features that the most modern API's offer!

EpicHomes features include a FULL integrated GUI to teleport and manage homes. The plugin also features FULLY optimised Asynchronous teleporting!

This homes plugin also features complete and full native support to make use of PaperMC's new Folia project! That means that as soon as Folia is ready, you'll have a homes plugin to use right away without waiting!

EpicHomes also has full PlaceholderAPI support, that allows you to very easily access the internal storage of the plugin to display into others, such as HolographicDisplays.

As another massive bonus, EpicHomes also features the ability for any server owner/admin to import homes data from other common and popular homes plugins such as StormerHomes & EssentialsX.

Another big bonus of EpicHomes is direct api support for the very popular PlugManX plugin management system.

Want to try out the very latest dev builds? [Click here] Use the above dev build at your own risk! Please follow any and ALL instructions provided with EACH dev build released!

Dependancies: None!

Soft Dependancies:

• PlaceholderAPI
• PlugManX

Config.yml

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#                                        ----[EpicHomes]----                                        #
#                                     ----[By Loving11ish]----                                      #
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#                                   ----[Plugin Config File]----                                    #
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#EpicHomes config for v1.0.6

#Changing anything below MAY require a server restart to take effect!

#Homes config options.
homes:
  #Set the default maximum amount of homes a player can have. [Default value: 3]
  ##ANY OP PLAYER BYPASS ALL LIMITS!##
  #To bypass all limits grant permission `epichomes.maxhomes.*`
  default-max-homes: 3
  #To allow the use of a tiered permission system for home sizes instead of the global amount, use the system below.
  permission-based-homes-max-amount:
    #Enable the tiered system use. [Default value: false]
    enabled: false
    permission-group-list:
      group-1: 4    #Perm: 'epichomes.maxhomes.group1' [This perm is given by default]
      group-2: 8    #Perm: 'epichomes.maxhomes.group2'
      group-3: 12   #Perm: 'epichomes.maxhomes.group3'
      group-4: 16   #Perm: 'epichomes.maxhomes.group4'
      group-5: 20   #Perm: 'epichomes.maxhomes.group5'
      group-6: 24   #Perm: 'epichomes.maxhomes.group6'
  #Set below names that are not allowed to be used in home names. [They ARE case & syntax sensitive]
  disallowed-home-names:
    - "Gamers"
    - "Rise"
    - "Up"

  teleportation:
    delay-before-teleport:
      #Do you want to have a delay before teleporting the player to their home? [Default value: true]
      enabled: true
      #How long do you want the countdown delay to be? (In seconds) [Default value: 5]
      time: 5
      #Do you want the server to constantly check if the player moves when they have requested a home teleport?
      ##WARNING - THIS ENABLES ADDITIONAL MOVEMENT EVENT CHECKS THAT MAY CAUSE INCREASED LOAD ON YOUR SERVER##
      ##IF YOU EXPERIENCE PERFORMANCE ISSUES TRY SETTING BELOW TO 'FALSE'##
      #[Default value: true]
      cancel-teleport-on-move: true

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

#This section is for any general plugin config options.
general:
  command-cool-down:
    #Do you want to have a cool-down for ALL the plugins commands? [Default value: false]
    #THIS ALSO APPLIES TO THE GUI OPENING COMMANDS!#
    enabled: false
    #How long (In seconds) do you want the cool-down to be between command usages? [Default value: 60]
    cool-down-time: 60

  developer-debug-mode:
    #Do you want to see a lot of debug messages in console when most actions are performed? [Default value: false]
    enabled: false

  home-data-importer:
    #Do you want to import and convert the home data from another supported plugin? [Default value: false]
    enabled: false
      #Do you want to import home and player data from another homes' plugin?
      #To import, set below to one of the supported options listed then restart the server.
      ##ENSURE THAT BOTH EPICHOMES AND YOUR OLD HOMES PLUGIN ARE BOTH ENABLED BEFORE PROCEEDING!##
      #Next, run the command `/importhomes` either in game or from the console. (Permission: 'epichomes.command.import')
      #If no errors are reported the import process should be completed then you are safe to remove or disable the previous homes' plugin.
      #current-supported-plugins:
      #- StormerHomes
      #- StormerHomesReloaded
      #- EssentialsX
    import-from: EssentialsX

  show-auto-save-task-message:
    #Do you want to see notifications in console when the auto-save task runs? [Default value: true]
    enabled: true

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

gui-system:
  use-global-gui:
    #Do you want to use the gui system to allow players to view and select their homes? [Default value: true]
    enabled: true
#----------------------------------------------------------------------------#
  home-list-gui:
    #What title do you want the GUI to have? [Default value: &d&nYour Homes:]
    title: "&d&nYour Homes:"

    icons:
      #What material do you want the home item to be represented by? [Default value: RED_BED]
      #Use Bukkit material names only! (https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)
      home-material: RED_BED
      #What name do you want the home item to be? [Default value: &6%HOME%]
      display-name: "&6%HOME%"
      #Below is the lore for the home item. If you don't want to show the player the home location values, simply
      #remove the lines below that contain the values inside the '%%' symbols.
      lore:
        - "&3<============>"
        - "&6Home Word: &a%LOCATION-WORLD%"
        - "&6Home X: &a%LOCATION-X%"
        - "&6Home Y: &a%LOCATION-Y%"
        - "&6Home Z: &a%LOCATION-Z%"
        - "&3<============>"
        - "&e&oLeft click me to travel here"
        - "&7------------"
        - "&c&oRight click me to delete this home"
        - "&3<============>"
#----------------------------------------------------------------------------#
  delete-list-gui:
    #What title do you want the GUI to have? [Default value: &d&nYour Homes:]
    title: "&d&nSelect Home To Delete"

    icons:
      #What material do you want the home item to be represented by? [Default value: RED_BED]
      #Use Bukkit material names only! (https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)
      home-material: RED_BED
      #What name do you want the home item to be? [Default value: &6%HOME%]
      display-name: "&6%HOME%"
      #Below is the lore for the home item. If you don't want to show the player the home location values, simply
      #remove the lines below that contain the values inside the '%%' symbols.
      lore:
        - "&3<============>"
        - "&6Home Word: &a%LOCATION-WORLD%"
        - "&6Home X: &a%LOCATION-X%"
        - "&6Home Y: &a%LOCATION-Y%"
        - "&6Home Z: &a%LOCATION-Z%"
        - "&3<============>"
        - "&e&oLeft click me to delete this home"
        - "&3<============>"

  #----------------------------------------------------------------------------#
  delete-single-home-gui:
    #What title do you want the GUI to have? [Default value: &d&nDelete %HOME%]
    title: "&d&nDelete %HOME%"

    icons:
      home-info:
        #What material do you want the home item to be represented by? [Default value: RED_BED]
        #Use Bukkit material names only! (https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)
        home-material: RED_BED
        #What name do you want the home item to be? [Default value: &6%HOME%]
        display-name: "&6%HOME%"
        #Below is the lore for the home item. If you don't want to show the player the home location values, simply
        #remove the lines below that contain the values inside the '%%' symbols.
        lore:
          - "&3<============>"
          - "&6Home Word: &a%LOCATION-WORLD%"
          - "&6Home X: &a%LOCATION-X%"
          - "&6Home Y: &a%LOCATION-Y%"
          - "&6Home Z: &a%LOCATION-Z%"
          - "&3<============>"

      confirm-delete:
        #What material do you want the confirmation delete item to be represented by? [Default value: TNT]
        #Use Bukkit material names only! (https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)
        material: TNT
        #What name do you want the confirmation delete item to be? [Default value: &cConfirm]
        display-name: "&cConfirm"
        #Below is the lore for the confirmation delete item.
        lore:
          - "&3<============>"
          - "&c&lThis action CANNOT be undone!"
          - "&3<============>"
          - "&e&oLeft click me to delete this home"
          - "&3<============>"

      cancel-delete:
        #What material do you want the cancel delete item to be represented by? [Default value: BARRIER]
        #Use Bukkit material names only! (https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html)
        material: BARRIER
        #What name do you want the cancel delete item to be? [Default value: &aCancel]
        display-name: "&aCancel"
        #Below is the lore for the cancel delete item.
        lore:
          - "&3<============>"
          - "&a&lCancel and close this GUI"
          - "&3<============>"
          - "&e&oLeft click me to cancel"
          - "&3<============>"
#----------------------------------------------------------------------------#
  #Menu controls options
  menu-controls:
    #The name of the previous page icon
    previous-page-icon-name: "&2Previous Page"
    #The name of the next page icon
    next-page-icon-name: "&2Next Page"
    #The name of the close/go back icon
    close-go-back-icon-name: "&4Close/Go Back"

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#

#EpicHomes update system
plugin-update-notifications:
  #Do you want to enable in game plugin update notifications? (Permission:'epichomes.update'). [Default value: true]
  enabled: true

Messages.yml

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#                                        ----[EpicHomes]----                                        #
#                                     ----[By Loving11ish]----                                      #
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#                                  ----[Plugin Messages File]----                                   #
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
#EpicHomes messages config for v1.0.6

#Changing anything below MAY require a server restart to take effect!

#Plugin global prefix
global-prefix: "&f[&6Epic&bHomes&f]&r"

#Home teleportation
timed-teleporting-begin-tp: "%PREFIX% &aTeleporting to home &e%HOME%&a...\n%PREFIX% &aPlease stay still!"
timed-teleporting-complete: "%PREFIX% &aSuccessfully arrived at &e%HOME%&a."
timed-teleport-failed-player-moved: "%PREFIX% &cYou moved before you were teleported to your home! The teleport was cancelled."
non-timed-teleporting-complete: "%PREFIX% &aSuccessfully arrived at &e%HOME%&a."

#Home set
home-set-successfully: "%PREFIX% &aSuccessfully set home &e%HOME% &aat your current location."
home-set-failed-home-exists: "%PREFIX% &e%HOME% &calready exists!"
home-set-failed-max-homes-reached: "%PREFIX% &cSorry, you have reached the max allowed homes."
home-set-failed-max-tiered-reached: "%PREFIX% &cSorry, you have reached the total homes your tier can set!\n%PREFIX% &cYou can set a total of &e%LIMIT% &chomes."
home-set-failed-invalid-name: "%PREFIX% &cSorry, your home cannot contain colours or the following characters: &d."
home-set-failed-name-not-allowed: "%PREFIX% &cSorry, that home name is not allowed. Please choose another!"

#Home delete
home-delete-successful: "%PREFIX% &aSuccessfully deleted &e%HOME%&a."
homeadmin-delete-successful: "%PREFIX% &aSuccessfully deleted &e%TARGET%'s %HOME%&a."
home-delete-failed: "%PREFIX% &cFailed to delete &e%HOME%&c!\n%PREFIX% &cCheck console for errors!"
homeadmin-delete-failed: "%PREFIX% &cFailed to delete &e%TARGET%'s %HOME%&c!\n%PREFIX% &cCheck console for errors!"

#Home list
list:
  header: "&3<======> %PREFIX% &3<======>\n"
  sub-header: "&aYour homes: \n"
  home: " &7>> &e%HOME%\n"
  sub-footer: " \n"
  footer: "&3<======> %PREFIX% &3<======>\n"

#Admin home list
homeadmin-list:
  header: "&3<======> %PREFIX% &3<======>\n"
  sub-header: "&a%TARGET%'s homes: \n"
  home: " &7>> &e%HOME%\n"
  sub-footer: " \n"
  footer: "&3<======> %PREFIX% &3<======>\n"

#General messages
no-permission: "%PREFIX% &cSorry, you don't have permission to do that."
incorrect-command-usage: "%PREFIX% &cSorry, that is a player only command."
homeadmin-unable-to-find-player: "%PREFIX% &cUnable to find an offline player by the name of &e%TARGET%&c!"
homeadmin-unable-to-find-user: "%PREFIX% &cUnable to find a user for &e%TARGET%&c!"
home-name-does-not-exist: "%PREFIX% &cSorry, you do not appear to have a home called &e%HOME%&c!"
command-cool-down-time-left: "%PREFIX% &cSorry, you still have &e%TIMELEFT% &cseconds until you can use that command again."
usermap-file-save-failure: "%PREFIX% &cInvalid home world name entry found for player &e%PLAYER%&c! &aSkipping current entry!"
plugin-reload-broadcast-start: "%PREFIX% &aThe plugin is being reloaded, please do not use any Homes commands until completed!"
auto-save-started: "%PREFIX% &aAuto save task has started."
auto-save-complete: "%PREFIX% &aSaved usermap data to disk!"
auto-save-failed: "%PREFIX% &4Failed to save usermap.yml to disk!"
plugin-reload-start: "%PREFIX% &aStarting reload process..."
plugin-reload-complete: "%PREFIX% &aPlugin reload process complete!"
plugin-reload-failed: "%PREFIX% &cPlugin reload process failed!\n%PREFIX% &cCheck console for any errors!"
move-event-cancel-failed: "%PREFIX% &4Unable to cancel teleport on move!\n%PREFIX% &4See below for reason!"
timed-teleport-failed-plugin-reloaded: "%PREFIX% &cA server operator reloaded the plugin so your teleport was canceled.\n%PREFIX% &cPlease try again."
home-data-import-successful: "%PREFIX% &aAll available home and player data successfully imported from &e%PLUGIN%&a!"
home-data-import-failed: "%PREFIX% &4Failed to import home or player data from &e%PLUGIN%&a!\n%PREFIX% &4Please check console for errors!"
home-data-import-failed-already-run: "%PREFIX% &cData has already been successfully imported!"
home-data-import-disabled: "%PREFIX% &cThe importer system is disabled in the config.yml!\n%PREFIX% &cPlease contact a system admin if you believe this is in error!"

#Home List GUI
GUI-first-page: "&7You are on the first page."
GUI-last-page: "&7You are on the last page."

#Home command usage
incorrect-home-command-usage:
  line-1: "%PREFIX% &ahome Usage:"
  line-2: "%PREFIX% &7- &6/home <name>"
  line-3: "%PREFIX% &7- &6/home set <name>"
  line-4: "%PREFIX% &7- &6/home delete <name>"
  line-5: "%PREFIX% &7- &6/home list"

#Sethome command usage
incorrect-sethome-command-usage:
  line-1: "%PREFIX% &asethome Usage:"
  line-2: "%PREFIX% &7- &6/sethome <name>"

#Delhome command usage
incorrect-delhome-command-usage:
  line-1: "%PREFIX% &adelhome Usage:"
  line-2: "%PREFIX% &7- &6/delhome <name>"

incorrect-homeadmin-command-usage:
  line-1: "%PREFIX% &ahomeadmin Usage:"
  line-2: "%PREFIX% &7- &6/homeadmin delete <player> <home-name>"
  line-3: "%PREFIX% &7- &6/homeadmin visit <player> <home-name>"
  line-4: "%PREFIX% &7- &6/homeadmin list <player>"
  line-5: "%PREFIX% &7- &6/homeadmin reload"

#Update Notification
update-check-failure: "%PREFIX%: &4Unable to check for updates! - &c"
update-available:
  1: "&4*-------------------------------------------*"
  2: "%PREFIX%: &cA new version is available!"
  3: "&4*-------------------------------------------*"
no-update-available:
  1: "&a*-------------------------------------------*"
  2: "%PREFIX%: &aPlugin is up to date!"
  3: "&a*-------------------------------------------*"

If you have any issues or suggestions please join our Discord.