THIS PLUGIN AS OF RIGHT NOW REQUIRES PLACHOLDER API AND GRIEF DEFENDER.
YES, I AM WORKING IN MAKING THOSE DEPENDENCIES OPTIONAL.
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:
GriefDefender: Used for claim awareness and protection.
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
Place a sign at the desired location.
Write [SignPort] (or whatever you have it set to on your server).
Follow the prompts to set the icon, name, and description.
Using the SignPorts GUI
Run /signport gui or /signportmenu to open the menu, see full list of aliases in the config.yml.
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
Edit the config.yml file in the SignPorts plugin folder.
Adjust settings such as cooldown time and maximum SignPorts per player.
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.