Documentation
Documentation
Commands
| COMMAND | DESCRIPTION |
|---|---|
| /pockethouse teleport <player> | Teleports you to the house of <player>. |
| /pockethouse teleport-back | Teleports you back to your previous location. |
| /pockethouse delete <player> | Deletes the house of a <player>>. |
Permissions
| PERMISSION | DEFAULT | DESCRIPTION |
|---|---|---|
| pockethouse.command.teleport | Operators | Allows you to use /pockethouse teleport <player>. |
| pockethouse.command.teleport-back | Operators | Allows you to use /pockethouse teleport-back. |
| pockethouse.command.delete | Operators | Allows you to use /pockethouse delete <player>. |
| pockethouse.item.craft | Everyone | Allows you to craft the item (see below). |
| pockethouse.item.use | Everyone | Allows you to use the item. |
Configuration
The main configuration is located in the file "config.yml". If you want to edit the plugin's messages, do to the file "messages.yml". Your server must be stopped before editing any of these files.
| KEY | POSSIBLE VALUES | DESCRIPTION | ||
|---|---|---|---|---|
| enable-updated | true or false | Enables the Skyupdater. | ||
| house | ||||
| spawn | The relative spawn location (relative to the origin of the schematic). | |||
| x | A number | X of the spawn location. | ||
| y | A number | Y of the spawn location. | ||
| z | A number | Z of the spawn location. | ||
| world | ||||
| name | A string | The world where the houses are saved. | ||
| origin | The houses will be placed from this origin (with a specified gap between them). | |||
| x | A number | X of the origin. | ||
| y | A number | Y of the origin. | ||
| z | A number | Z of the origin. | ||
| gap | Gap between houses. Adjust this according to your server's view distance and to the schematic size. | |||
| x | A number | X gap. | ||
| y | A number | Y gap. | ||
| z | A number | Z gap. | ||
| item | ||||
| enable | true or false | If you want to enable the item (right click to teleport to your house). | ||
| name | A string | The item's name (case sensitive). | ||
| type | A Material | The type of the item. | ||
| craft | A list | How the item can be crafted. Max line length is 3 characters and max line number is 3 (gives a 3x3 array which represents a crafting table). | ||
| craft-map | A map | Each letter corresponds to an item (the letter is used to create a craft). | ||
| damage-listener | ||||
| enable | true or false | If you want to enable the damage listener. | ||
| delay | A number | If enabled, this is the minimum delay between a damage and a teleport (in seconds). | ||
| tp-back | ||||
| enable | true or false | Enable the fixed tp back location. | ||
| world | A string | The world where you should be teleported back. | ||
| x | A number | X of the teleport back location. | ||
| y | A number | Y of the teleport back location. | ||
| z | A number | Z of the teleport back location. |
If you want to edit the schematic
Please check this link before editing the schematic.
API
PocketHouse has a simple and documented API. You can check it here.
Comments