Bukkit

Brief Overview

MyHome is a simple to use but highly flexible home teleporation point plugin. It allows server owners to control many aspects of when their users can teleport to their home. This can be by requiring them to wait for a period either as the teleport warms up or they have to wait a period between uses of the /home function. The major functions of MyHome can also be set to charge the users per use through one of the major economy plugins.

MyHome uses Permissions 2, Permissions 3, PermissionsEx, GroupManager, bPermissions plugins or the built in SuperPerms to manage permissions and also has per user and per group timers and costs to enable different settings for different user groups. Support for per user/group settings is enabled in all plugins except for SuperPerms. Vault is also supported for other permissions plugins.

MyHome also supports many economy plugins via Vault.

For a quick permissions set-up, give your users myhome.home.* and your admins myhome.*

Installation

Simply put MyHome.jar in your plugins folder. When you start up your server, a configuration file will be generated and placed in a folder called "MyHome". You can edit this configuration file to adjust the settings for MyHome to your liking.

Configuration Options for MyHome

If you wish to have economy support in MyHome to charge players to use the commands, you will also need Vault.

Commands & Permissions:

Basic Commands:

• /home - (myhome.home.basic.home) - Takes you to your home
• /home set - (myhome.home.basic.set) - Sets your home to your current position
• /home delete - (myhome.home.basic.delete) - Deletes your home
• /home point - Point your compass towards your home.
• /home help - Display help

Social Commands:

• /home <name> - (myhome.home.soc.others) - Visit <name>'s home
• /home list - (myhome.home.soc.list) - Displays whose homes you can visit
• /home ilist - (myhome.home.soc.list) - Displays who can visit your home
• /home invite <name> - (myhome.home.soc.invite) - Invites <name> to your house
• /home uninvite <name> - (myhome.home.soc.uninvite) - Uninvites <name> to your house
• /home public - (myhome.home.soc.public) - Makes your house public
• /home private - (myhome.home.soc.private) - Makes your house private

Admin Commands:

• /home listall - (myhome.admin.home.list) - Allow admins to list all homes
• /home clear [playername] - (myhome.admin.home.delete) - Allow an admin to delete playername's home.
• /home convert - (myhome.admin.convert) - Converts the homes from very old homes.txt into the db
• /home reload - (myhome.admin.reload) - Reload MyHome's configuration - Do not use this for swapping to MySQL
• /home rename oldname newname - (myhome.admin.home.rename) - Rename owner of a home warp

Permissions

In addition to specific command permissions there are also the following:

Alias Permissions:

• (myhome.user) - Grants user permissions
• (myhome.admin) - Grants admin permissions

Economy Permissions:

• (myhome.econ.free.*) - Allow /sethome and /home usage for free
• (myhome.econ.free.sethome) - Allow /sethome usage for free
• (myhome.econ.free.home) - Allow /home usage for free

Bypassing Timers/Limits Permisions:

• (myhome.bypass.*) - Bypass all limits (cooldowns, warmups and bed usage etc)
• (myhome.bypass.cooldown) - Permission to bypass /home cooldowns
• (myhome.bypass.warmup) - Permission to bypass /home warmup
• (myhome.bypass.sethomecool) - Permission to bypass /sethome cooldown
• (myhome.bypass.bedsethome) - Permission to use /sethome when bed usage is forced.
• (myhome.bypass.dmgaborting) - Do not abort a /home warmup when receiving or dealing damage

Admin Permissions:

• (myhome.admin.*) - Has access to all admin commands in MyHome
• (myhome.admin.home.any) - Admin can /home to anyone's home.
• (myhome.admin.home.rename) - Admin can change ownership of a home

Per User and Per Group Settings

These depend on your permissions plugin supporting this functionality. They are not functional in PermissionsBukkit and MyHome will return the global settings instead. See the documentation for your chosen permissions plugin for how to use these!

• (myhome.timer.cooldown) - The cooldown timer to use after a player uses /home (in seconds)
• (myhome.timer.warmup) - The warmup timer to use before a player is sent /home (in seconds)
• (myhome.timer.sethome) - The cooldown timer to use between allowing /sethome (in seconds)
• (myhome.costs.home) - The cost to use /home
• (myhome.costs.sethome) - The cost to use /sethome

For Permissions 3, the per group/per user timers and costs are defined as:

        myhome:
          timer:
            cooldown: x
            warmup: x
            sethome: x
          costs:
            home: x
            sethome: x

For GroupManager and PermissionsEx, the per group/per user timers and costs are defined as:

        myhome.timer.cooldown: x
        myhome.timer.warmup: x
        myhome.timer.sethome: x
        myhome.costs.home: x
        myhome.costs.sethome: x
        myhome.distance.home: x

PermissionsEx may require the x value to be presented as 'x' instead of just x