️ SignGuiAPI
The high-performance, developer-first solution for Sign Input on Paper & Folia.
![[IMG]](//proxy.spigotmc.org/ff6487b818c3b8692d4e0c1cad88b1f8780705dc/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56657273696f6e2d312e32312b2d677265656e2e737667)
![[IMG]](//proxy.spigotmc.org/f12f8c7d44888112fd8f439aa35c2ce2e727f8c7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506c6174666f726d2d5061706572253230253743253230466f6c69612d626c75652e737667)
![[IMG]](//proxy.spigotmc.org/5c07ae748f000834dc6feb6d7a28f2b07908adf7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446570656e64656e63792d50726f746f636f6c4c69622d6f72616e67652e737667)
---
The high-performance, developer-first solution for Sign Input on Paper & Folia.
---
✨ Why Developers Love It
- Folia Ready: Fully compatible with region-based multithreading.
- Packet-Based: Powered by ProtocolLib for clean, flicker-free GUI handling.
- Auto-Cleanup: No memory leaks; listeners and data are purged on disconnect.
- Full Customization: Supports all sign types (Cherry, Bamboo, Crimson, etc.).
- ️ Fluent API: Builder patterns make your code clean and readable.
---
Installation
Option 1: JitPack (Dependency)
Add this to your pom.xml to start building:
Code (XML):
<repository>
<id>jitpack.io </id>
<url>https://jitpack.io </url>
</repository>
<dependency>
<groupId>com.github.SpirtySprite </groupId>
<artifactId>SignGUI-API-Folia </artifactId>
<version>v1.0.0 </version>
<scope>provided </scope>
</dependency>
If you want zero extra dependencies for your users, shade and relocate the API:
Code (XML):
<plugin>
<groupId>org.apache.maven.plugins </groupId>
<artifactId>maven-shade-plugin </artifactId>
<version>3.5.3 </version>
<configuration>
<relocations>
<relocation>
<pattern>me.kirug.signgui </pattern>
<shadedPattern>your.package.signgui </shadedPattern>
</relocation>
</relocations>
</configuration>
</plugin>
Usage Guide
1. Initialize
Place this in your main plugin's onEnable():
Code (Java):
@Override
public void onEnable ( ) {
// Hooks into ProtocolLib
SignGUI. init ( this ) ;
}
Create a professional Spruce-themed input in seconds:
Code (Java):
SignGUI. builder ( )
. type (Material. SPRUCE_SIGN )
. setLines ( "", "↑ Type Code ↑", "------------", "Staff Only" )
. setHandler ( (player, lines ) -> {
String input = lines [ 0 ] ;
player. sendMessage ( "§aProcessing code: " + input ) ;
} )
. build ( )
. open (player ) ;
Code (Java):
SignGUI. builder ( )
. setLine ( 0, "Enter Name:" )
. setHandler ( 0, (player, result ) -> {
player. sendMessage ( "§eHello, " + result + "!" ) ;
} )
. build ( )
. open (player ) ;
️ Requirements
- ProtocolLib: 5.1.0 or higher must be installed on the server.
- Java Version: Java 21 or higher.
- Server: Paper or Folia 1.21+.
Found a bug or need a feature?
Visit the GitHub Issues Page
Visit the GitHub Issues Page
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft version listed: 1.21
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
SignGUI-API-Folia is a free Minecraft Java mod. Compatible with Minecraft 1.21. Downloaded 15 times (via Spigot). Download it and open it directly in the game.