uHome
uHome - The Ultimate Multi-Home Plugin
Is teleporting to your homes making you suffocate? Having trouble getting in and out of minecarts? Update to v1.5.3 and set loadChunks: true in your uHome config.yml!
Introduction
uHome is a fork of the wonderful MyHome plugin by tkelly and spathizilla, modified to provide multiple homes to players that are simple to use and easy for server operators to control. Developed for use on my server, Ultimate Minecraft, some features have been removed that were previously available in MyHome, namely publicizing of homes and economy support, which were removed as they were not needed on the server. Currently, economy support is implemented in v1.5a and above, and will be available in release versions shortly.
Version Support
uHome 1.5.3 is known to be compatible with all releases of CraftBukkit 1.4.7.
Feature Summary
- Creation of multiple private homes (warps) for each player.
- Bukkit SuperPerms support, including permissions variables.
- Works out of the box without config changes and no permissions plugin necessary
- Home creation limit, with support for different levels through permissions nodes.
- Command cool-downs and warm-ups, also variable according to permissions nodes.
- MySQL and SQLite support.
- Simple default home support - players can use /sethome and /home, without parameters, to warp to a default named home.
- Importing of homes from MyHome.
- Inviting of players to homes.
- Locale Support - customise uHome to talk your language, or fit your server's theme.
- Multi-world support, you decide if players can move between worlds with their homes.
- Auto completion of home names when warping.
- All commands work with online and offline players, case insensitively.
- Use Minecraft's vanilla command blocks with uHome to make teleporters in your world!
Installation & Setup
Simply download and place the uHome.jar into your plugins folder in your Bukkit directory. A configuration file is generated when running the plugin for the first time, which contains many options to adjust the behaviour of the plugin to your needs. Hopefully, the defaults provided should prove a good basis for most users. Easy permissions setup is possible by giving your players 'uhome.own' and your admins 'uhome.admin'. A 'uhome.all' node is provided that will also give the group/player no limits in addition to the player and admin command rights. If you're not a user of permissions, uHome allows all players to do basic actions by default, while giving ops full access.
For information on setting up permissions based (per group) limits, see the section entitled "Other Permissions" below.
For more configuration information, check out the Configuration page.
Need Help?
If you have any queries, you can use the comments section below and I should reply fairly quickly, as I check this page almost daily. If you'd like live support, you can ask me in IRC, either in #bukkit or #uhome under the username 'ks'. If you come across bugs, or have a feature request, create a ticket using the "Tickets" tab at the top of the page.
Live Support: irc.esper.net #uhome (May not be online, sorry!)
Commands & Permissions
Basic Commands: /home - (uhome.own.warp) - Takes you to your "home" home. /home set - (uhome.own.set) - Sets your "home" home to your current position. /home delete - (uhome.own.delete) - Deletes your home "home". /home help - Display help Multihome Commands: /home <name> - (uhome.own.warp) - Takes you to your home with the name <name>. /home list - (uhome.own.list) - Displays the homes you own. /home set <name> - (uhome.own.set) - Sets a home called <name> to your current position. /home delete <name> - (uhome.own.delete) - Deletes your home named <name>. /home limit - (uhome.own.set) - Displays the number of homes you can set. /home warp <name> - (uhome.own.warp) - Takes you to your home with the name <name>, avoiding conflicts with other commands. Invite Commands: /home invite <player> <name> - (uhome.own.invite) - Allows <player> to warp to your home called <name>. /home uninvite <player> <name> - (uhome.own.uninvite) - Removes <player> from <name>'s invited players list. /home invites [page] - (uhome.own.listinvites) - Displays the homes that you have been invited to. /home requests [page] - (uhome.own.listinvites) - Displays the players that you have invited to your homes. /home lock <name> - (uhome.own.unlock) - Locks a home, so that only those invited can warp to it. (Default behaviour.) /home unlock <name> - (uhome.own.unlock) - Unlocks a home, so that anybody who knows the name of the home may warp to it. Admin Commands: /home <player> - (uhome.admin.warp) - Warps to a player's default home (provided you have no homes with similar names). /home list <player> - (uhome.admin.list) - Lists a player's homes. /home delete <player> <name> - (uhome.admin.delete) - Delete's a player's home. /home reload - (uhome.admin.reload) - Reload uHome's configuration - Do not use this for swapping to MySQL /home <player> <name> - (uhome.admin.warp) - Takes you to the home of <player> called <name>. /home set <player> <name> - (uhome.admin.set) - Sets another player's home to your location. /home limit <player> - (uhome.admin.list) - Displays the maximum number of homes <player> can set. /home invites <player> - (uhome.admin.listinvites) - Displays the invites <player> has received. /home requests <player> - (uhome.admin.listinvites) - Displays the invites <player> has sent. /home info <player> <name> - (uhome.admin.info) - Displays information on the given home, including it's co-ordinates. /home debug - **(Console Only)** - Toggles debug logging to investigate permissions errors. Can create a lot of messages. /home <player> <owner> <name> (uhome.admin.send and uhome.admin.warp) - Sends the given player to another player's home. Can be used from the console, and from command blocks!
Other Permissions
Variable Permissions: (uhome.limit.[a-e]) - Gives the player the home limit reflected by the config. E.g. if limitB=10, and the player has the permission "uhome.limit.b", the player can make up to 10 homes. (uhome.cooldown.[a-e]) - Gives the player the cooldown time reflected by the config, as above. (uhome.warmup.[a-e]) - Gives the player the warmup time reflected by the config, as above. Bypassing Timers/Limits Permisions: (uhome.bypass) - Bypass all limits (cooldowns, warmups, bed usage and home limit) (uhome.bypass.cooldown) - Permission to bypass /home cooldowns (uhome.bypass.warmup) - Permission to bypass /home warmup (uhome.bypass.warmup.damage) - Permission to ignore damage when warming-up (uhome.bypass.warmup.movement) - Permission to ignore movement when warming-up (uhome.bypass.bed) - Permission to use /sethome when bed usage is forced. (uhome.crossworld) - Allows a player to move between worlds with homes. Admin Permissions: (uhome.all) - Has access to all commands in uHome (uhome.admin.reload) - Is able to reload uHome config.
Limits Explained
Limits and variable permissions are powerful and actually very simple to use. However, they may seem confusing at first, so for information on how to use them visit the Configuration page.
Importing From Other Plugins
uHome v1.5a and above support importing homes from both CommandBook and MyHome. For information on how to do this, please read the page Importing From Other Plugins. Would you like to see import support from other home plugins? Create a ticket!
Current Usage Stats
Stats provided from v1.5 and above only!
Credits
A huge thankyou to the original authors - tkelly and spathizilla, for their work on the base plugin. :)
Thanks to CubeNation for adding economy implementation via Vault.
Thanks to linkinkov & Schmarotzer for the Russian translation.
Another thanks to those users who consistently send good feedback, bug reports and feature requests. You know who you are!
Source code available on GitHub, feel free to fork, butcher and re-release to your liking. https:github.com/ks07/uHome
Want to see it in action? Visit Ultimate Minecraft
@CTapblu
Hey CTapblu,
The error, as you may have noticed, is: "Access denied for user 'root'@'localhost' ". The most likely cause of this is having bad username/password combination, but it may also be caused by the user not having permissions to access the database (minecraft, in this case). Seeing as you appear to be using root, this shouldn't be the case, so please double check your connection settings, testing with another plugin if necessary.
Hello, i have some problem with setup ur plugin... her's the error:
Here's config details:
@TeamPvP
Hi, Permissions, including version 3, are no longer maintained and do not work with the new system available as part of Bukkit (if you click the link you posted, you will see that the last commit says "project has reached EOL (End of life)".
In order to use uHome (and many other new plugins), you will need a new permissions manager such as bPermissions, PermissionsBukkit or PEX. You can find all of these (and possibly more) using the plugin search.
Good luck with the new system, it may take some work to convert everything over!
Hi, I recieved the permissions plugin from a friend but it is Yeti 1.3 Permissions, if you know what that is. I am still not having any luck setting the node correctly. :|
https://github.com/TheYeti/Permissions
Thats where I presume it's from. One minute, Im checking if I have an outdated permissions plugin :O
@TeamPvP
Hey TeamPvP,
could you link me to the page of the Permissions plugin you are using? Thanks.
Hi there, I am running uHome 1.3 and it appears in my Permissions Plugin "Permissions" when I add the node uhome.limit.a or ANY integer, it doesn't activate anything however if I am an OP it works, :L I don't know how to fix this, would you be willing to help?
@groveham
Thankyou groveham, looks like I missed some changes in the rush to get out a first attempt. 1.3a.2 will be up soon to fix that error (hopefully!) :)
I updated to 1.3a.1 to see if it fixed the error of only saving one home per player and it seems to have been fixed but it still give an error, i will paste it below.
@kso7 Yeah there is a error in the console, ill paste it below.
Also as far as I am aware, it is compatible, it works fine with the permissions plugin I have, apart from the error that I am pasting below. It does mention a sql data error, but I thought it was optional to use a sql database?
@groveham
Hello groveham, which version are you using? If you are using v1.2 from here, then you are most likely facing the same bug mentioned at the top of the page - there should be an error in your server logs, and if you could post that I might be able to help you more.
Also, you're using Permissions 3? Unless there's been an update I'm unaware of, it shouldn't be compatible with this plugin.
Hello, Im having a problem where, its allowing user to save homes, and all the permissions and configs are set up correctly, just that the homes are not being saved and when they log back in, they lose the homes they have just set. I am an op and an admin and i do not seem to be affected. I will paste in my permissions file and my config file to see if there is an error in it. I hope you can help i really like this plugin!
O and im using permissions x3 too.
@RaesWolf
Hey RaesWolf,
WIth the change to the new config layout, comments were lost, and I completely forgot to talk about the settings on here. Your problem is to do with the priorities of permissions limits, and inheritance. "uhome.limit.a" has a higher precedence than "uhome.limit.b", which overrides "uhome.limit.c", and so on. This means that, if you're using a permissions manager which supports inheritance, 99% of the time, "limitA" should be the largest, and "limitB" should be the second largest.
Looking at your config: Elite has "uhome.limit.a", which means uHome gives these players "limitA", or 1 home warp only. Settler has "uhome.limit.b". However, they inherit from Elite - which means they also have "uhome.limit.a". A is considered before B, so uHome ignores the limit for B and again uses limit A, which means Settler's only have 1 home.
Another thing to look out for is your default setting, which is currently set to 0. 0 = unlimited, so if any of your groups/players do not have a "uhome.limit.X" permission, they will automatically have unlimited homes.
How to fix your problems?
Hope that clears things up, I'll do a page on the config settings asap.
This is suppose to be a fork of MyHome but I am having issues actually getting it to work. I had it to where the homes were working and you could invite ppl. NOW for some reason it doesnt recognize players when trying to invite them and the extra homes given keep getting whiped on every reset/reload. Its not saving them. Heres what my permission files look like and what my config file for U home and My Home looks like. Im trying to set it up where Elites and up get to use the /home invite and the Multiple homes part to it and everyone else below them gets basic. Also have it to where Elites get 1 spare home and every rank up gets +1 added to that and so on. So supporters get 2 investors get 3 mods get 4 and admins get 5!
Or is it easier to set the numbers per player? I tried that and then I think thats when it broke?
Permissions Folder
MyHome Code:
UHome Config File:
Quick update: Just uploaded v1.2 release, it will be available to download soon. It fixes MySQL conversion, as well as adding basic invite support and fixing a few bugs.
@SilentStray
Just uploaded a version 1.2 alpha - you're welcome to try it now and help test, the download will be there as soon as the file gets approved. Of course, please make a backup of your old MyHome files, just in case it doesn't work as expected.
Thanks, though I don't know how to go about manually converting the DB. I shall wait for the next version. ^^
@osky2918 You may be using a special port, but I'm fairly certain you would realize if that was the case as you would have had to have changed the port when you installed MySQL.
Can you use other plugins with MySQL (e.g. LogBlock)? If you can, it must be something in your config - if you'd like, pm me your settings file and I'll have a look (blank out the password first though!). If you can't, then there may be something wrong with the MySQL server.
@ks07: I redownload the plugin and use the default setnings , but changed to use mysql . And then I get the error below. How I setup my server : I have my server on my internet server at home , so I was wonder if I had to use my ip insted of localhost ? Sorry for bad english :(
EDIT: Do I in that case use an special port ?
@osky2918 Hi osky, the error shows that the plugin cannot connect to the mysql server - double check your settings, especially the connection address. :)
@wemthorr Hey wemthorr, I may re-implement the invite command - took it out just because I never used it and wanted to simplify things. Would be good to know if others would like this functionality back.
@SilentStray I will add this in the next version (may take a day or so, busy week) - in the meantime, the database format has hardly changed, so if you know how, manually converting it isn't too difficult. :P
Hi , I can´t get mysql to work , do I need something more than just a db and the config file ? I have search on the web for java and mysql but can´t find anything , please help !