> For the complete documentation index, see [llms.txt](https://papertweaks.machinemaker.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://papertweaks.machinemaker.me/v0.1.x/sethome.md).

# Sethome

Allows you to set a home, and relocate back to it. There is a configurable limit to how many uses each player gets of the sethome command as well as a cooldown on using the /home command. There is an admin only command that can reset a player's limit.

## Commands

/sethome - `Sets the users home at that location`\
/home - `Teleports the user to their saved home location`\
/sha reset  - `Resets the player's sethome limit` (vanillatweaks.sethome.admin)

## Configuration

```yaml
# Whether or not to allow /home teleportation across dimensions
allow-across-dimension: true

# Cooldown in seconds on using the /home command
home-command-cooldown-seconds: 0

# Default number of times each player can use the /sethome command
default-sethome-limit: 5
```