Skip to content

Home

Jump to bottom
thesquidghost edited this page Jul 9, 2024 · 4 revisions

SignPorts Plugin Wiki

Table of Contents

  1. Introduction
  2. Features
  3. Unique Aspects
  4. Commands
  5. Permissions
  6. Configuration
  7. API and Hooks
  8. User Manual
  9. Admin Guide
  10. Troubleshooting

Introduction

SignPorts is a unique player warp plugin for Bukkit/Spigot servers that allows players to create and manage their own teleportation points using in-game signs. Unlike traditional warp plugins, SignPorts integrates seamlessly with the game world, providing an immersive and intuitive experience for players.

Why SignPorts?

SignPorts was developed to address several limitations and inconveniences found in traditional teleportation and warp plugins. Here's why SignPorts stands out:

Beyond Simple Sign Teleportation

Many existing plugins use signs as direct teleportation points, where interacting with the sign immediately teleports the player to another location. While this can be convenient, it has several drawbacks:

  1. Accidental Teleportation: Players might unintentionally teleport by misclicking on a sign.
  2. Limited Information: Signs provide very limited space for describing the destination.
  3. Lack of Flexibility: These systems often don't allow for easy management or customization of teleport points.

More Than Just Sign-to-Sign Travel

Some plugins restrict teleportation to only between signs. SignPorts breaks this limitation by allowing players to set up diverse destinations:

  • Shop Entrances: Players can create easy access points to their shops.
  • Claim Spawns: Set up a central arrival point for player claims or territories.
  • Points of Interest: Highlight and provide access to important locations in the world.

Organized and Exclusive Menu System

Unlike traditional warp systems that clutter server-wide warp lists, SignPorts offers:

  1. Dedicated Menu: All SignPorts are accessible through an exclusive, organized menu.
  2. Clean Interface: Avoid the clutter of long /warp list commands or mixing with server-wide warps.
  3. Visual Representation: Each SignPort can have a custom icon in the menu, making it easy to identify at a glance.

Player Empowerment

SignPorts gives more control to the players:

  1. Custom Descriptions: Players can provide detailed descriptions of their SignPorts.
  2. Personalized Icons: Choose any item as an icon to represent the SignPort in the menu.
  3. Easy Management: Players can create, edit, and remove their own SignPorts without admin intervention.

Server Performance and Management

From a server management perspective, SignPorts offers several advantages:

  1. Reduced Clutter: Keeps player-created teleport points separate from essential server warps.
  2. Performance Friendly: The menu-based system is more efficient than processing numerous sign interactions.
  3. Abuse Prevention: Built-in cooldown system and admin controls to prevent misuse.

Immersive Experience

SignPorts maintains the immersive Minecraft experience:

  1. Physical Presence: Signs serve as visible markers in the world, maintaining the game's physicality.
  2. Lore-Friendly: Can be integrated into server lore as "magical portals" or "teleportation networks".
  3. Customizable: Server owners can tailor the plugin's language and features to fit their server's theme.

In summary, SignPorts was created to offer a more flexible, organized, and player-friendly approach to teleportation. It combines the best aspects of sign-based and menu-based teleportation systems, providing a unique solution that enhances player experience while maintaining server order and performance.

Features

  • Player-created teleportation points using signs
  • GUI-based menu for easy navigation and management
  • Customizable icons for each SignPort
  • Cooldown system to prevent abuse
  • Safe teleportation checks
  • Admin controls and oversight
  • Integration with GriefDefender for claim-aware functionality
  • PlaceholderAPI support for dynamic text

Unique Aspects

SignPorts stands out from other player warp plugins in several ways:

  1. Sign-Based System: Instead of abstract warp points, players create physical signs in the world, adding a tangible element to teleportation.

  2. GUI Integration: The plugin provides a user-friendly GUI for managing and using SignPorts, making it accessible for all players.

  3. Customization: Players can set custom names, descriptions, and icons for their SignPorts, allowing for personalization and easy recognition.

  4. Claim Awareness: Integration with GriefDefender ensures that SignPorts respect land claims and server rules.

  5. Safety Checks: The plugin performs thorough safety checks before teleportation, preventing accidents and exploits.

  6. Immersion: By using physical signs and custom icons, SignPorts maintains the immersive feel of the Minecraft world while adding convenient teleportation.

These unique aspects make SignPorts an excellent choice for servers looking to add player-controlled teleportation without breaking immersion or compromising server integrity.

Commands

  • /signport create <name> - Create a new SignPort
  • /signport list - List all available SignPorts
  • /signport remove <name> - Remove a SignPort
  • /signport teleport <name> - Teleport to a SignPort
  • /signport gui - Open the SignPorts GUI
  • /signport setname <new name> - Change the name of your SignPort
  • /signport setdesc <new description> - Change the description of your SignPort
  • /signport setitem - Change the icon of your SignPort (uses item in hand)
  • /signport reload - Reload the plugin configuration (admin only)
  • /signportmenu - Open the SignPorts menu

Permissions

  • signports.create - Allows creation of SignPorts
  • signports.use - Allows use of SignPorts
  • signports.remove - Allows removal of own SignPorts
  • signports.edit - Allows editing of own SignPorts
  • signports.gui - Allows access to the SignPorts GUI
  • signports.admin - Grants access to admin functions (remove any SignPort, reload config)

Configuration

The config.yml file allows server owners to customize various aspects of the plugin:

# Cooldown time in seconds for SignPort teleportation
teleport-cooldown: 30

# Maximum number of SignPorts a player can create
max-signports-per-player: 1

# Name of the SignPorts menu
menu-name: "SignPorts Menu"

# Other configuration options...

API and Hooks

SignPorts integrates with the following plugins:

  1. GriefDefender: Used for claim awareness and protection.
  2. PlaceholderAPI: Allows the use of placeholders in SignPort names and descriptions.

For developers, SignPorts provides an API for interaction with other plugins:

// Example API usage
SignPorts signPortsPlugin = (SignPorts) Bukkit.getPluginManager().getPlugin("SignPorts");
SignPortAPI api = signPortsPlugin.getAPI();

// Get a SignPort
SignPortSetup signPort = api.getSignPortByName("ExamplePort");

// Teleport a player to a SignPort
api.teleportPlayerToSignPort(player, signPort);

User Manual

Creating a SignPort

  1. Place a sign at the desired location.
  2. Write [SignPort] (or whatever you have it set to on your server).
  3. Follow the prompts to set the icon, name, and description.

Using the SignPorts GUI

  1. Run /signport gui or /signportmenu to open the menu, see full list of aliases in the config.yml.
  2. Click on a SignPort icon to teleport to that location.

Editing Your SignPort

  • To change the name: /signport setname <new name>
  • To change the description: /signport setdesc <new description>
  • To change the icon: Hold the desired item and run /signport setitem

Removing a SignPort

Run /signport remove <name> to remove your SignPort. or; Break the sign.

Admin Guide

Managing SignPorts

  • Admins can remove any SignPort using /signport remove <name>
  • Use /signport reload to reload the plugin configuration

Configuring the Plugin

  1. Edit the config.yml file in the SignPorts plugin folder.
  2. Adjust settings such as cooldown time and maximum SignPorts per player.
  3. Save the file and run /signport reload in-game.

Troubleshooting

  • If a player can't create a SignPort, check their permissions and the max-signports-per-player setting.
  • If a player still can't create a SignPort, tell them to check the chatbox for any errors (they most likely are trying to place it on a block that they haven't claimed.)
  • For teleportation issues, ensure the destination is safe and the player's cooldown has expired.
  • If the GUI isn't working, verify that the server has a compatible version of the required dependencies.

This wiki provides a comprehensive overview of the SignPorts plugin, highlighting its unique features, functionality, and usage instructions. It should serve as an excellent resource for both users and administrators of your plugin.

Clone this wiki locally