NBStudio

Installation

Simple setup instructions, system environment requirements, and multi-threading compatibility details for SignWarp.

Installation Guide

Setting up SignWarp on your Minecraft server is extremely simple. The plugin is highly optimized and runs completely standalone but supports optional economy hooks.


Server Requirements

Before installing the plugin, verify that your server environment meets these baseline conditions:

  • Platform Compatibility :
    • Paper or Purpur (highly recommended for performance).
    • Spigot (fully supported).
    • Folia (Multi-threaded) : 100% Native Support! SignWarp is fully certified for multi-threaded servers using regionalized async schedulers for warp teleports without causing server main-thread ticks.
  • Minecraft Version : Supports 1.20 up to 1.21.x (and newer).
  • Java Version :
    • Java 17 or higher is required.
    • Note: Java 21 is required if you are running Minecraft 1.20.5 or higher.
  • Dependencies :
    • None! Runs natively out-of-the-box.
    • [Optional] Vault : Required only if you want to charge in-game economy money for player teleportations. You must also have an active economy plugin (like EssentialsX, CMI, etc.) loaded alongside Vault.

Steps to Install

Follow these steps to deploy the plugin:

  1. Download the latest compiled .jar file from one of our official pages:
  2. Upload the downloaded .jar file into your server's plugins/ directory.
  3. Restart your Minecraft server to load the plugin and generate the default configurations:
    • This generates the plugins/SignWarp/ folder containing config.yml and the local SQLite warps.db database.

Best Practices

Local Testing We strongly recommend setting up a local development server to test your cooldown periods, particle types, and Vault teleportation fees before deploying them to your active production server.

Avoid Server Reloads (/reload) Do not use Spigot's native /reload or /rl command on production. Reloading the server can lead to severe memory leaks, corrupt database linkages inside SQLite, and break Vault hooks.

  • Safe Method: To update configurations or messages in real-time, execute /signwarp reload (permission: signwarp.reload). This safely reloads configuration files in real-time without impacting active server ticks.

On this page