Getting Started

🚀 Getting Started

Follow these steps to start patching your plugins for Folia.

📥 Prerequisites

• Java 17 or higher: Required to run the application and the patched plugins.
• Maven (optional): Only if you are building from source.

⚙️ Installation

1. Go to the Releases page.
2. Download the version that suits your needs:
   • Folia-Phantom-GUI.jar: Recommended for desktop users.
   • Folia-Phantom-CLI.jar: For headless servers or automation.
   • Folia-Phantom-Plugin.jar: To run as a server-side plugin.

🛠️ Basic Usage (GUI)

1. Launch the application by double-clicking the JAR or running:

   java -jar Folia-Phantom-GUI.jar

2. Add Plugins: Drag and drop your .jar files into the left sidebar.
3. Configure: Select an output directory if you want them saved outside the default location.
4. Execute: Click the big blue EXECUTE PATCH button.
5. Finalize: Once finished, click Open Results to find your Folia-compatible plugins.

💻 CommandLine Usage (CLI)

java -jar Folia-Phantom-CLI.jar <input_jar_or_dir> [output_dir]

🔌 Plugin Usage

1. Place Folia-Phantom-Plugin.jar in your Folia server's plugins folder.
2. Start the server.
3. Use /foliaphantom patch <plugin_name> to patch individual plugins or check the config.yml for automated patching rules.

---

🏠 Back to Home