> For the complete documentation index, see [llms.txt](https://coppercore-smp.gitbook.io/coppercore-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://coppercore-smp.gitbook.io/coppercore-wiki/plugin-guides/economy-and-trading/player-warps.md).

# ✦ ── Player Warps

PlayerWarps allows players to create public teleport locations around the server, making it easy to share shops, builds, attractions, farms, services and other useful places with the community.

You can browse other players' warps, teleport directly to them, create your own, and customise how your warps appear to other players.

{% hint style="info" %}
**Tip:** Player warps are especially useful for advertising player shops or creating an easy way for others to visit something you've built.
{% endhint %}

***

### Browsing Player Warps

You can browse available player warps through the PlayerWarps menu:

`/pw`

You can also view them as a list:

`/pw list`

To see warps close to your current location:

`/pw near`

PlayerWarps also allows you to browse warps belonging to a particular player using the list command.

***

### Teleporting to a Player Warp

If you already know the name of the warp you want to visit, use:

`/pw <warp>`

For example:

`/pw Shop`

This will teleport you directly to that player's warp.

***

### Creating a Player Warp

Stand at the exact location where you want players to arrive, then use:

`/pw set <name>`

For example:

`/pw set Shop`

The warp will be created at your current location.

{% hint style="warning" %}
**Important:** Make sure you're standing exactly where you want visitors to appear before creating the warp.
{% endhint %}

***

### Customising Your Warp

Once you've created a warp, you can customise it to make it easier for players to recognise and understand.

***

#### Description

Add a description with:

`/pw desc set <warp> <description>`

For example:

`/pw desc set Shop Building blocks, tools and decorations!`

To remove the description:

`/pw desc remove <warp>`

Descriptions are useful for explaining what players can expect to find when they visit.

***

#### Category

Player warps can be placed into categories, making them easier to find while browsing.

Use:

`/pw category set <warp> <category>`

You can also remove, list or clear categories using the `/pw category` commands.

{% hint style="info" %}
**Tip:** Choose the category that best represents the main purpose of your warp so players can find it more easily.
{% endhint %}

***

#### Warp Settings

You can access the settings menu for one of your warps with:

`/pw settings <warp>`

This gives you an easier way to manage available settings for that warp.

***

#### Moving an Existing Warp

You don't need to delete and recreate a warp just because you want to change where players arrive.

Stand at the new location and use:

`/pw reset <warp>`

The warp will be moved to your current location while remaining the same warp.

***

#### Renaming a Warp

To change the name of one of your existing warps:

`/pw rename <warp> <new name>`

For example:

`/pw rename OldShop NewShop`

This allows you to change its name without having to completely remove and recreate it.

***

#### Locking a Warp

If you temporarily don't want players using one of your warps, you can lock it:

`/pw lock <warp> true`

To unlock it again:

`/pw lock <warp> false`

This lets you temporarily close a warp without permanently deleting it.

***

#### Removing a Warp

If you no longer need one of your warps, use:

`/pw remove <warp>`

For example:

`/pw remove Shop`

{% hint style="warning" %}
**Important:** Removing a warp deletes it. Only remove a warp when you're sure you no longer need it.
{% endhint %}

***

#### Viewing Warp Information

To view information about a warp:

`/pw info <warp>`

This can be used to check information associated with a particular player warp.

***

#### Favourite Warps

If you find a warp you visit regularly, you can add it to your favourites:

`/pw favourite <warp>`

This makes it easier to keep track of useful or interesting warps you've discovered.

***

### Command Reference

| Command                              | Purpose                               |
| ------------------------------------ | ------------------------------------- |
| `/pw open`                           | Open the PlayerWarps menu             |
| `/pw <warp>`                         | Teleport to a player warp             |
| `/pw set <name>`                     | Create a player warp at your location |
| `/pw remove <warp>`                  | Delete one of your warps              |
| `/pw list`                           | List available player warps           |
| `/pw near`                           | View nearby player warps              |
| `/pw desc set <warp> <description>`  | Set a warp description                |
| `/pw desc remove <warp>`             | Remove a warp description             |
| `/pw category set <warp> <category>` | Set a warp's category                 |
| `/pw settings <warp>`                | Open a warp's settings                |
| `/pw reset <warp>`                   | Move a warp to your current location  |
| `/pw rename <warp> <name>`           | Rename a warp                         |
| `/pw lock <warp> <true/false>`       | Lock or unlock a warp                 |
| `/pw info <warp>`                    | View information about a warp         |
| `/pw favourite <warp>`               | Add a warp to your favourites         |
| `/pw help`                           | View PlayerWarps help                 |

***

### Quick Start

If you just want to get your first warp running:

1. Go to the location you want players to teleport to.
2. Use `/pw set <name>`.
3. Add a description with `/pw desc set <warp> <description>`.
4. Choose an appropriate category.
5. Use `/pw settings <warp>` if you want to customise it further.
6. Your warp is ready for other players to visit!

{% hint style="info" %}
**Final reminder:** Player warps are designed to help connect the server together. Give your warps useful names and descriptions so other players can tell what they're for before visiting.
{% endhint %}
