You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,32 +3,33 @@
3
3
Vineflower is a modern, general purpose JVM language decompiler focused on providing the best quality, speed, and usability.
4
4
5
5
Vineflower's features include:
6
-
- Java 20+ support, including records, sealed classes, switch expressions, and more
6
+
- Java 21+ support, including records, sealed classes, switch expressions, pattern matching, and more
7
7
- Clean code generation and output, with automatic output formatting
8
8
- Multithreaded decompilation
9
9
10
10
Examples of Vineflower's output, compared to other decompilers, can be found on [the wiki.](https://github.com/Vineflower/vineflower/wiki)
11
11
12
12
## Use
13
-
Want to use Vineflower? There are a few ways! For Minecraft modding, [Loom Vineflower](https://github.com/Juuxel/loom-vineflower) allows you to generate sources with Vineflower.
14
-
The [Vineflower Intellij IDEA plugin](https://plugins.jetbrains.com/plugin/18032-quiltflower) replaces Fernflower in IDEA with Vineflower, and allows you to modify its settings.
13
+
Want to use Vineflower? There are a few ways! The [Vineflower Intellij IDEA plugin](https://plugins.jetbrains.com/plugin/18032-quiltflower) replaces Fernflower in IDEA with Vineflower, and allows you to modify its settings.
15
14
16
15
If you want to run Vineflower from the commandline, head over to the [Releases tab](https://github.com/Vineflower/vineflower/releases) and grab the latest release.
17
16
You can then run Vineflower with `java -jar vineflower.jar <arguments> <source> <destination>`.
18
17
`<arguments>` is the list of [commandline arguments](https://github.com/Vineflower/vineflower/wiki) that you want to pass to the decompiler.
19
-
`<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.
18
+
`<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.
20
19
21
-
22
-
To use Vineflower as a library, you can find distributions on maven central. Vineflower 1.9+ requires Java 11 or higher to run.
20
+
To use Vineflower as a library, you can find distributions on maven central. Vineflower 1.9+ requires Java 11 or higher to run, and Vineflower 1.11+ requires Java 17 or higher to run.
Vineflower 1.10+ provides two artifacts, the regular jar and the slim jar. The regular jar contains the decompiler and a handful of plugins, such as a Kotlin decompiler and variable renamer.
28
+
The slim jar contains only the decompiler. If unsure, simply use the regular jar as before.
29
+
29
30
Instructions on how to interface with Vineflower can be found on [the wiki.](https://github.com/Vineflower/vineflower/wiki)
30
31
31
-
Make sure to report any issues to the [Issues tab!](https://github.com/Vineflower/vineflower/issues)
32
+
Please report any issues to the [Issues tab!](https://github.com/Vineflower/vineflower/issues)
32
33
33
34
### Building
34
35
Vineflower can be built simply with `./gradlew build`.
@@ -40,9 +41,14 @@ For support or questions, please join one of the listed [social platforms](https
40
41
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.
41
42
Vineflower's codebase is rather old and some concepts may be difficult to navigate. For help, please check out [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md).
42
43
44
+
### Pull Requests
45
+
When submitting pull requests, please target the latest `develop/1.xx.y` branch.
46
+
43
47
### Special Thanks
44
-
Vineflower is a fork of both Jetbrains' Fernflower and MinecraftForge's ForgeFlower, and a direct continuation of work on Quiltflower.
48
+
Vineflower is a fork of Jetbrains' Fernflower, MinecraftForge's ForgeFlower, FabricMC's fork of Fernflower, and a direct continuation of work on Quiltflower.
45
49
50
+
* Stiver- For creating Fernflower
46
51
* Jetbrains- For maintaining Fernflower
47
52
* Forge Team- For maintaining ForgeFlower
53
+
* Fabric Team- For maintaining Fabric's fork of Fernflower
0 commit comments