pWarps - Modern Warp Plugin
Producer: pidemann
Target version: Bukkit / Spigot / Paper 1.21.4

============================================================

WHAT DOES THE PLUGIN DO?

pWarps is a simple, fast, and easy-to-use warp plugin prepared for Minecraft servers.
It allows players or authorized personnel to create warp points at specific locations, teleport to these points, view the warp list, and delete warps when necessary.

The plugin can be used on survival, faction, boxpvp, skyblock, towny, smp, and lobby-style servers.
For example:

• /setwarp spawn to create a spawn point.
• /warp spawn for players to go to the spawn point.
• /warps to open the warp list available to the player.
• /delwarp spawn for authorized personnel to delete a warp.

The plugin has returned to a single-language system. Messages are edited in the messages.yml file, and the default message language is English.

============================================================

KEY FEATURES

• Modern and colorful message system
• Editable messages via messages.yml
• Configurable delay, cooldown, limit, and effect system via config.yml
• Secure warp recording in warps.yml
• /pwarp main command
• Practical commands: /warp, /warps, /setwarp, /delwarp
• Paged warp listing
• Teleport cancellation if the player moves
• Teleport delay
• Teleport cooldown system
• Sound and particle effect support
• Fully compatible with LuckPerms authorization system
• PlaceholderAPI support
• Lightweight, simple structure that does not use a database

============================================================

FILE STRUCTURE

When the plugin is first started, it creates the following files:

plugins/pwarps/config.yml
plugins/pwarps/messages.yml
plugins/pwarps/warps.yml

config.yml:
General settings for the plugin are kept here. Teleport delay, cooldown, cancellation on movement, warp limit per player, list page size, sound, and particle effects can be adjusted from here.

messages.yml:
All messages are kept here. You can leave the messages in English or edit them according to your language. Color codes and hex colors are supported.

warps.yml:
Created warps are recorded here. The owner, world, coordinates, yaw/pitch value, and creation time of each warp are saved.
It is possible to edit this file manually, but it is safer to edit it while the server is offline.

============================================================

COMMANDS

/pwarp
Shows the main help menu.

/pwarp help
Shows the help menu.

/pwarp list
Shows the warp list.

/pwarp go
Teleports to the specified warp.

/pwarp set
Creates a warp at the current location.

/pwarp delete
Deletes the specified warp.

/pwarp info
Shows information about the warp.

/pwarp permissions
Shows the permission list of the plugin.

/pwarp placeholders
Shows the PlaceholderAPI placeholder list.

/pwarp reload
Reloads config.yml, messages.yml, and warps.yml files.

/warp
Teleports to the specified warp.

/warps [page]
Shows the warp list.

/setwarp
Creates a new warp at the current location.

/delwarp
Deletes the specified warp.

============================================================

LUCKPERMS AND PERMISSION SYSTEM

pWarps is directly compatible with LuckPerms. No separate LuckPerms API is required.
The plugin uses the Bukkit permission system, so all permissions can be easily granted via LuckPerms.

Basic permissions:

pwarps.use
Basic usage permission for the plugin.

pwarps.list
Allows the player to view the warp list.

pwarps.warp
Allows the player to teleport to warps.

pwarps.set
Allows the player to create a warp.

pwarps.delete.own
Allows the player to delete their own warp.

pwarps.delete.any
Allows the player to delete any warp.

pwarps.info
Allows usage of the warp info command.

pwarps.admin.reload
Allows usage of the /pwarp reload command.

pwarps.admin
Includes all administrative permissions.

Special warp viewing and usage permissions:

pwarps.view.
Allows the player to see a specific warp in the list.
Example: pwarps.view.spawn

pwarps.teleport.
Allows the player to teleport to a specific warp.
Example: pwarps.teleport.spawn

General special permissions:

pwarps.view.*
Grants permission to view all warps in the list.

pwarps.teleport.*
Grants permission to teleport to all warps.

Limit permissions:

pwarps.limit.
Sets the maximum number of warps a player can create.
Example: pwarps.limit.10

pwarps.limit.unlimited
Grants the player unlimited warp creation rights.

Bypass permissions:

pwarps.bypass.cooldown
Bypasses the teleport cooldown period.

pwarps.bypass.delay
Bypasses the teleport delay.

pwarps.bypass.limit
Bypasses the warp creation limit.

LuckPerms examples:

/lp group default permission set pwarps.warp true
/lp group default permission set pwarps.list true
/lp group vip permission set pwarps.limit.10 true
/lp group admin permission set pwarps.admin true

============================================================

PLACEHOLDERAPI SUPPORT

If PlaceholderAPI is present on the server, pWarps automatically registers its own placeholders.
These placeholders can be used in scoreboards, tablists, holograms, menus, and similar systems.

Placeholders:

%pwarps_total%
Shows the total number of warps on the server.

%pwarps_list%
Lists warp names according to the separator in config.yml.

%pwarps_owned%
Shows the number of warps owned by the player.

%pwarps_limit%
Shows the player's warp limit.

%pwarps_visible%
Shows the number of warps the player can see.

%pwarps_first%
Shows the first warp name alphabetically.

%pwarps_exists_spawn%
Returns information on whether a warp named "spawn" exists.
A different warp name can be written instead of spawn.

%pwarps_owner_spawn%
Shows the owner of the warp named "spawn".

%pwarps_world_spawn%
Shows the world where the warp named "spawn" is located.

%pwarps_coords_spawn%
Shows the coordinates of the warp named "spawn".

============================================================

PERFORMANCE AND LIGHTWEIGHTNESS

pWarps is designed to run lightly.

• Does not use a database.
• Keeps warps in a simple YAML file.
• Does not use heavy loops that run continuously.
• Teleport operations only run when the command is used.
• Listing operations are only performed when /warps or related commands are used.
• PlaceholderAPI data is read from simple memory data.
• Does not contain complex processes that will strain server ticks.

Therefore, it can be easily used on small, medium, and large servers.
Even on servers with many warps, it does not send unlimited lines to the player at once because the list is paged.

============================================================

SETTINGS

Highlighted settings in config.yml:

settings.teleport-delay-seconds
Determines how many seconds to wait before teleporting.

settings.teleport-cooldown-seconds
Determines how many seconds the player must wait to teleport again.

settings.cancel-teleport-on-move
Determines whether the teleport will be canceled if the player moves.

settings.max-warps-per-player
Determines the default warp limit per player.

settings.list-page-size
Determines the number of warps per page in the /warps list.

effects.enabled
Determines whether effects after teleport are enabled.

effects.sound
Determines the sound to play after teleport.

effects.particle
Determines the particle effect to display after teleport.

permissions.per-warp-view
Activates warp-based viewing permissions.

permissions.per-warp-teleport
Activates warp-based teleport permissions.

============================================================

INSTALLATION

1. Place the pwarps-1.0.0.jar file into the plugins folder.
2. Restart the server completely.
3. Edit the config.yml and messages.yml files once the plugins/pwarps folder is created.
4. Grant permissions via LuckPerms.
5. Refresh settings with the /pwarp reload command.

Suggestion:
Do not leave old pwarps jar files in the plugins folder. If there is more than one jar file of the same plugin, the server might load the wrong file.

============================================================

SHORT SUMMARY

pWarps is a simple, modern, performance-friendly warp plugin with LuckPerms and PlaceholderAPI support.
It offers an easily configurable experience for server owners and a fast and understandable warp experience for players.

For errors and bugs, contact Discord: PideMann