Introduction
- Name : UltraHomes
- Version : v1.3
- Author : Sharkz
- Download : songoda.com
First of all, Thank you very much for downloading my pluginand for being my loyal customer. You are awesome!
This documentation is to help you regarding each step of customization. Please go through the documentation carefully to understand how to use UltraHomes properly.
Getting Started ↑
In this section you will have a brief description of the plugin and installation instructions.
What is UltraHomes ?
Ultra Homes is a plugin allowing you players to put homes wherever they want and access them at any time. But also many options that will allow you to tune the plugin as close as possible to your expectations. A lightweight, efficient and optimized plugin.
Installation
The plugin is installed like any other plugin, by placing the "UltraHomes.jar" file
in the "plugins" folder of your minecraft server.
Despite this, for it to work correctly, it must be configured a bit.
You do not know how ?
It's normal, that's why this site exists.
You just have to browse the different
categories of the wiki to learn how to use the plugin.
Languages ↑
Your language does not appear on this page ?
Submit your translation by sending me a message on spigotmc.org.
- English - Sharkz
- French - Sharkz
- Italian - Djbomber32
- German - xItsMyTimex
- Norwegian - Nordlyset Tropelivet
- Hungarian - Victor75007
- Chinese - VincentVVV
- Spanish Argentina - NicoPie
How to use UltraHomes ? ↑
General
In this section you will learn how to use and configure the plugin.Language selection
You can change the language used by the plugin by changing the
"language" parameter.
However, you cannot put any value, it is necessary that the value of the parameter
"language" is equal to language_COUNTRY
and that the file "language_COUNTRY.lang" is in your file "UltraHomes/lang"
# +-------------------------------------------------------------------------+ #
# | | #
# | LANGUAGE SETTINGS | #
# | | #
# | Controls which language UltraHome will use. | #
# | | #
# +-------------------------------------------------------------------------+ #
# Define the current language used by the plugin
# You can use pre-installed translations like fr_FR or en_US
#
# You can also try to reach out your language on the following page :
# https://uh.roch-blondiaux.com/
#
# If you want to create your own translations, go to the lang folder
# copy en_US.lang, rename it to "language_COUNTRY.lang" & translate it !
language: "en_US"
Updates check
The two possible values for this parameter are : true and false.
True means that the plugin will keep you informed of updates while
false will disable this feature
# +-------------------------------------------------------------------------+ #
# | | #
# | MISCELLANEOUS SETTINGS | #
# | | #
# | Define if the plugin the plugin will notify you of each update. | #
# | | #
# +-------------------------------------------------------------------------+ #
check-for-update: true
Storage
Controls which storage method UltraHomes will use to store data.Storage method
The "storage method" defines where the plugin will store the plugin.
Two options are available to you:
→ mysql Storage in a remote database
→ sqlite Storage in a database contained in a file
Click here to see a comparison of the two methods.
(If you want the players' data to be synchronized between several servers you
will have to use mysql.)
# +-------------------------------------------------------------------------+ #
# | | #
# | STORAGE SETTINGS | #
# | | #
# | Controls which storage method UltraHome will use to store data. | #
# | | #
# +-------------------------------------------------------------------------+ #
# How the plugin should store data
#
# - Possible options:
#
# | Remote databases - require connection information to be configured below
# |=> MySQL
# |=> MariaDB (over MySQL)
# | Flatfile/local database - don't require any extra configuration
# |=> SQLite
#
storage-method: sqlite
Host
This setting just defines the address of the database.
Won't be useful if you are using sqlite host: "127.0.0.1"
Port
This parameter just defines the port of the database server.
For mysql the default port is 3306 and for mysql it is not necessary to
specify one.
port: "3306"
Database
This setting defines the name of the database.
Of course, the database must already be created.
# The name of the database to store UltraHomes data in.
# - This must be created already.
database: "uec"
Credentials
These two parameters define the login credentials to the database.
username: "uec"
password: ""
Inventory
In this section you will learn how to customize the home gui.Title
This setting define the title of the homes gui
# Inventory title
# Support minecraft chat color code
# Must not exceed 32 characters
title: "&aYour home"
Commands
In this section you will learn how to customize & use the plugin's commands.Home command
This command allows your players to open their homes gui or to teleport to their homes.
You can configure the command itself by modifying the "command" parameter,
you will need to restart your server for the change to take effect.
The description will be displayed in the plugin's help menu.
# Main home command
# Usage :
# - /home | Open homes' graphic interface
# - /home [name] | Teleport to home with name [name]
home-command:
# Define the command key
# Here the command would be /home [name]
command: "home"
# Description displayed in the help menu
description: "Go to your homes."
Sethome command
This command allows your players set a home.
You can configure the command itself by modifying the "command" parameter,
you will need to restart your server for the change to take effect.
The description will be displayed in the plugin's help menu.
# Define a new home
# Usage :
# - /sethome [name] | Define or update home with name [name]
sethome-command:
# Define the command key
# Here the command would be /sethome [name]
command: "sethome"
# Description displayed in the help menu
description: "Create new home."
Delhome command
This command allows your players to delete a home.
You can configure the command itself by modifying the "command" parameter,
you will need to restart your server for the change to take effect.
The description will be displayed in the plugin's help menu.
# Home delete command
# Usage :
# - /delhome [name] | Delete home with name [name]
delhome-command:
# Define the command key
# Here the command would be /delhome [name]
command: "delhome"
# Description displayed in the help menu
description: "Delete your existing homes."
Permissions
In this section you will learn how to use the plugin's permissions.Players permissions
- ultrahomes.1 | default permission
- ultrahomes.x | Allow player to get x homes.
Admin permissions
- ultrahomes.*
- ultrahomes.reload | Reload the plugin configuration.
Teleportation
In this section you will learn how to custom the teleportation settings.Warmup
This settings define how many seconds the player has to remain still until they are teleported.
warmup: 5 # How many seconds the player has to remain still until they are teleported.
# (after running /home)
Cancel on move
This settings define if the teleportation will be cancelled if the player move before the delay expires.
# Teleportation should be canceled if the player moves before the delay expires?
cancel-on-move: true
Teleportating notifications
This settings define how you want to notify the remaining time before teleportation.
# Title displayed while waiting for teleportation
# Leave blank to disable
# Supported placeholder :
# - %time%
title:
# Title's first line
title: "&c&l%time%"
# Title's second line
sub-title: "&7Teleporting..."
# Action bar sent while waiting for teleportation
# Leave blank to disable
action-bar: "&e&lDon't move !"
# Chat message sent while waiting for teleportation
# Leave blank to disable
chat-message: ""
Teleportating success
This settings define how you want to notify players when teleportation has been successful.
# Title displayed when teleportation has been successful
teleportation-success:
# Title displayed when teleportation has been successful
# Leave blank to disable
title:
# Title's first line
title: "&a&lTeleported!"
# Title's second line
sub-title: "&bHome sweet &9home"
# ActionBar sent when teleportation has been successful
# Leave blank to disable
action-bar: ""
# Chat message sent when teleportation has been successful
# Leave blank to disable
chat-message: ""
Version History↑
Once again, thank you so much for purchasing this plugin. As I said at the beginning, I'd be glad to help you if you have any questions relating to my work. No guarantees, but I'll do my best to assist. If you have a more general question relating to the plugin, you might consider visiting my discord and asking your question in the "general" channel or create a ticket in "tickets" category.
Changelog
Will come asap :)
Terms of services ↑
By downloading my product, you agree to the followings :
- You are not allowed to resell this resource.
- You are not allowed to decompile this resource.
- You are not allowed to chargeback what so ever.
- You are not allowed to publish this resource on any platform.
- You are not allowed to share this resource to anyone.
- Contact me via discord or spigotmc.org for any issues.