folia-phantom

FoliaPhantom

English | 英語

FoliaPhantom is a lightweight "ghost wrapper" that enables existing Bukkit / Spigot / Paper plugins to run on Folia (a threaded-region enabled fork of Paper) with minimal effort.

🧩 Features

• Automatically adapts external plugins for the Folia environment
• Automatically adds folia-supported: true to plugin.yml
• Replaces BukkitScheduler with a Folia-compatible proxy
• Supports both asynchronous and region-locked scheduling
• Automatically patches and regenerates plugin JARs
• Supports wrapping multiple plugins in parallel

⚙️ Installation Steps

1. Place FoliaPhantom.jar into your server's plugins directory

2. Start the server once — config.yml will be generated automatically

3. Open and configure plugins/FoliaPhantom/config.yml to list target plugins:

   wrapped-plugins:
     - name: ExamplePlugin
       original-jar-path: plugins/ExamplePlugin.jar
       patched-jar-path: plugins/Folia/ExamplePlugin-patched.jar
       folia-enabled: true
   

4. Restart the server (or run /reload) — the plugin(s) will be automatically wrapped and enabled

⚠️ Limitations & Notes

• Plugins that depend on NMS (net.minecraft.server) code are not fully supported ➜ Especially those using classes like WorldServer, MinecraftServer, or EntityPlayer may not function correctly.
• Uses Unsafe and reflection to hook into BukkitScheduler. May not work in JVMs with restricted security policies.
• This is not a guaranteed fix for all Folia-incompatible plugins — test and verify compatibility individually.

📂 config.yml Options

📜 License

MIT License

✉️ Contact

Please report bugs or share suggestions via GitHub Issues or on our Discord server.

✨ Decompilation Permission

🛠 Let’s build it together.