Skip to content

Getting Started

SummerMC Developer edited this page May 28, 2026 · 2 revisions

πŸš€ Getting Started

πŸ“₯ Prerequisites

  • Java 17+ (runtime & patched plugins)
  • Maven 3.8+ (optional, for building from source)

βš™οΈ Installation

Download from Releases:

Artifact Description
Folia-Phantom-CLI-2.0.0.jar Command-line tool
folia-phantom-gui-2.0.0.jar JavaFX desktop GUI
folia-phantom-plugin-2.0.0.jar Server-side plugin

πŸ’» CLI Usage

# Patch a single JAR
java -jar Folia-Phantom-CLI-2.0.0.jar path/to/plugin.jar

# Patch all JARs in a directory
java -jar Folia-Phantom-CLI-2.0.0.jar path/to/jars/

# Interactive mode (no arguments)
java -jar Folia-Phantom-CLI-2.0.0.jar

Output: ./patched-plugins/patched-<filename>.jar

πŸ–₯️ GUI Usage

  1. java -jar folia-phantom-gui-2.0.0.jar
  2. Drag & drop JARs into the sidebar
  3. Configure output directory (optional)
  4. Click EXECUTE PATCH
  5. Click Open Results to access patched plugins

πŸ”Œ Plugin Usage

  1. Place folia-phantom-plugin-2.0.0.jar in Folia's plugins/ folder
  2. Create a queue folder: plugins/folia-patch-queue/
  3. Drop JARs into the queue folder β€” auto-patch happens every 5 seconds
  4. Commands:
    • /foliapatch <plugin> β€” patch a specific plugin
    • /foliapatch list β€” list patchable plugins
    • /foliapatch status β€” show statistics
    • /foliapatch reload β€” reload config

πŸ”¨ Build from Source

git clone https://github.com/MARVserver/pasta.git
cd pasta/folia-phantom
mvn clean package

🏠 Home

Clone this wiki locally