mc-homes

Start here

Welcome to mc-homes, a modern homes plugin.

Getting Started

To start using mc-homes, follow these steps:

1. Install mc-commons:

   Download the latest version of mc-commons.

2. Install the plugin:

   Download the latest version of the plugin from our resource page.

3. Configure the plugin:

   Once installed, configure plugins/mc-homes/config.yml with your desired settings.

   Additionally, server admins can control the max amount of homes a user can have. This is done with the voxelations.homes.max.<amount> permission. For example, to allow a user to have a maximum of 5 homes, the permission would be voxelations.homes.max.5.

Commands

The following commands are available for players:

Command	Permission	Description
/sethome <home>	voxelations.homes.use	Sets a home at the player’s location.
/delhome <home>	voxelations.homes.use	Deletes the specified home.
/home <home>	voxelations.homes.use	Teleports the player to the specified home.
/homes	voxelations.homes.use	Lists all the player’s homes.

The following commands are available for server admins:

Command	Permission	Description
/homeadmin <player> homes	voxelations.homes.admin	Lists all the homes of the specified user.
/homeadmin <player> home <home>	voxelations.homes.admin	Teleports to a user’s home.
/homeadmin <player> sethome <home>	voxelations.homes.admin	Sets a home for the specified user. Note: this will bypass their natural limit.
/homeadmin <player> delhome <home>	voxelations.homes.admin	Deletes the specified home for the specified user.

config.yml

menu:
    title: Homes
    rows: 6
    type: CHEST
    items: {}
    paged:
        first-slot: 0
        elements-per-page: 45
        previous-page:
            slots:
            - 48
            item:
                type: ARROW
                display-name: Previous Page
        next-page:
            slots:
            - 50
            item:
                type: ARROW
                display-name: Next Page
        template:
            type: GRASS_BLOCK
            display-name: <gold><home>
            lore:
            - '<gold>World: <world>'
            - '<gold>Coords: <x> <y> <z>'
            - ''
            - <white>Click to teleport.
messages:
    teleported-home:
        message: <green>[!] Teleported home.
    set-home:
        message: <green>[!] Home set to current location.
    max-homes:
        message: <red>[!] You cannot create more homes.
    duplicate-home:
        message: <red>[!] Home already exists.
    delete-home:
        message: <gold>[!] Home deleted.
    invalid-home:
        message: <red>[!] Invalid home.