Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.88 KB

README.md

File metadata and controls

48 lines (35 loc) · 2.88 KB
Raw

Vineflower

Vineflower is a modern, general purpose JVM language decompiler focused on providing the best quality, speed, and usability.

Vineflower's features include:

  • Java 20+ support, including records, sealed classes, switch expressions, and more
  • Clean code generation and output, with automatic output formatting
  • Multithreaded decompilation

Examples of Vineflower's output, compared to other decompilers, can be found on the wiki.

Use

Want to use Vineflower? There are a few ways! For Minecraft modding, Loom Vineflower allows you to generate sources with Vineflower. The Vineflower Intellij IDEA plugin replaces Fernflower in IDEA with Vineflower, and allows you to modify its settings.

If you want to run Vineflower from the commandline, head over to the Releases tab and grab the latest release. You can then run Vineflower with java -jar vineflower.jar <arguments> <source> <destination>. <arguments> is the list of commandline arguments that you want to pass to the decompiler. <source> can be a jar, zip, folder, or class file, and <destination> can be a folder, zip, jar, or excluded, to print to the console.

To use Vineflower as a library, you can find distributions on maven central. Vineflower 1.9+ requires Java 11 or higher to run. Vineflower can be imported with gradle with:

dependencies {
    implementation 'org.vineflower:vineflower:<version>'
}

Instructions on how to interface with Vineflower can be found on the wiki.

Make sure to report any issues to the Issues tab!

Building

Vineflower can be built simply with ./gradlew build.

Support

For support or questions, please join one of the listed social platforms, or on the discussion tab.

Contributing

Contributions are always welcome! We are always looking for help with bugfixes, new features, and enhancements. If you'd like to work on a feature or bugfix, feel free to simply open a PR! If you want to communicate about a change before making it, you can get in touch with the methods listed above. Vineflower's codebase is rather old and some concepts may be difficult to navigate. For help, please check out CONTRIBUTING.md and ARCHITECTURE.md.

Special Thanks

Vineflower is a fork of both Jetbrains' Fernflower and MinecraftForge's ForgeFlower, and a direct continuation of work on Quiltflower.

  • Jetbrains- For maintaining Fernflower
  • Forge Team- For maintaining ForgeFlower
  • CFR- For its large suite of very useful tests