Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juuxel/loom-vineflower
A Gradle plugin that adds Vineflower as a Loom decompiler.
https://github.com/juuxel/loom-vineflower
architectury decompiler fabricmc gradle gradle-plugin minecraft quiltmc vineflower
Last synced: 2 months ago
JSON representation
A Gradle plugin that adds Vineflower as a Loom decompiler.
- Host: GitHub
- URL: https://github.com/juuxel/loom-vineflower
- Owner: Juuxel
- License: mit
- Created: 2021-06-13T13:38:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T22:19:04.000Z (over 1 year ago)
- Last Synced: 2024-10-14T06:04:15.736Z (2 months ago)
- Topics: architectury, decompiler, fabricmc, gradle, gradle-plugin, minecraft, quiltmc, vineflower
- Language: Java
- Homepage: https://plugins.gradle.org/plugin/io.github.juuxel.loom-vineflower
- Size: 487 KB
- Stars: 64
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vineflower for Loom
[][pluginportal]
[pluginportal]: https://plugins.gradle.org/plugin/io.github.juuxel.loom-vineflower
A Loom addon that adds [Vineflower](https://github.com/Vineflower/vineflower) as a decompiler
for Fabric Loom and its forks (Architectury etc.).
- [Version compatibility](#version-compatibility)
- [Getting started](#getting-started)
- [Fabric projects](#fabric-projects)
- [Architectury projects](#architectury-projects)
- [Configuration](#configuration)
- [Decompiler version](#decompiler-version)
- [Decompiler sources](#decompiler-sources)
- [Decompilation preferences](#decompilation-preferences)
## Version compatibility
| Loom variant | Plugin ID | Supported versions |
|---------------------|-------------------------|-----------------------------------------------------|
| Fabric Loom | `fabric-loom` | 0.8, 0.9, 0.11, 0.12, 1.0, 1.1, 1.2 |
| Architectury Loom | `dev.architectury.loom` | 0.7.2, 0.7.4, 0.10.0¹, 0.11.0, 0.12.0, 1.0, 1.1, 1.2 |
| Quilt Loom | `org.quiltmc.loom` | 0.12, 1.0, 1.1, 1.2 |
| `gg.essential.loom` | `gg.essential.loom` | *None*² |
| Babric Loom | `babric-loom` | 0.12² |
| Ornithe Loom | `ornithe-loom` | 1.0² |
¹ From build 0.10.0.206 onwards
² Completely untested
Older versions might be compatible, but using them is unsupported. Bugs caused by outdated Loom versions will not be fixed.
For the latest Fabric Loom 0.10 versions (0.10.28+),
use [loom-quiltflower-mini](https://github.com/Juuxel/loom-quiltflower-mini) instead.
## Getting started
> Note: versions before 1.7.1 required adding Cotton's maven repository,
> but LVF 1.7.1+ is available on the Gradle Plugin Portal
> like most other plugins. Versions before 1.11.0 are available under the plugin ID
> `io.github.juuxel.loom-quiltflower`.
### Fabric projects
1. Add Vineflower for Loom to your plugins:
```diff
plugins {
id 'fabric-loom' version '1.2-SNAPSHOT'
+ id 'io.github.juuxel.loom-vineflower' version '1.11.0'
id 'maven-publish'
}
```
2. Instead of `genSources`, you can now use `genSourcesWithVineflower`.
### Architectury projects
1. Add Vineflower for Loom to your `plugins` block:
```diff
plugins {
id "architectury-plugin" version "3.4-SNAPSHOT"
id "dev.architectury.loom" version "1.2-SNAPSHOT" apply false
+ id 'io.github.juuxel.loom-vineflower' version '1.11.0' apply false
}
```
2. Apply Vineflower for Loom to subprojects:
```diff
subprojects {
apply plugin: "dev.architectury.loom"
+ apply plugin: "io.github.juuxel.loom-vineflower"
```
> Note: this can also be done in the subprojects' `plugins` blocks.
3. Instead of `genSources`, you can now use `genSourcesWithVineflower`.
## Configuration
### Decompiler version
You can configure the used version of Vineflower with the `vineflower` extension (called `quiltflower` before 1.11.0
and `loomQuiltflower` before 1.2.0):
```groovy
vineflower {
// This is the default; 1.4.0 and above should work
toolVersion.set("1.9.1")
// If you're using Groovy DSL, you can also specify the version like this:
toolVersion = '1.9.1'
}
```
### Decompiler brand
> Added in LVF 1.11.0.
This plugin supports using Vineflower versions under two names or "brands": Vineflower and Quiltflower.
By default, the brand is determined automatically from the version with versions ≤1.9.0 being Quiltflower.
The brand affects the default Maven repository for downloading Vineflower, as well as
its dependency coordinates.
The brand can also be manually set using the `vineflower.brand` property,
but this should only be done if it cannot be detected automatically:
```kotlin
vineflower {
// Force the Vineflower brand.
brand.set(DecompilerBrand.VINEFLOWER)
// Force the Quiltflower brand.
brand.set(DecompilerBrand.QUILTFLOWER)
}
```
### Decompiler sources
> Added in LVF 1.2.0.
In addition to specifying a version, you can also use a completely different *decompiler source*.
They are configured with the `vineflower.toolSource` property, or with the following methods.
```kotlin
vineflower {
// Downloads the wanted VF version from the official source for the decompiler version.
// This is the default behaviour.
fromOfficialRepository()
// Downloads the wanted VF version from the project repositories.
fromProjectRepositories()
// Downloads the latest official snapshot of Vineflower.
fromLatestSnapshot()
// Resolves VF using a Gradle dependency.
// The parameter can be any dependency notation supported by Gradle.
fromDependency("a:b:1.2.3")
// Downloads or copies the wanted VF version from a URL.
fromUrl("https://address.to/the/vineflower.jar")
// Uses a local VF file
fromFile("my-vineflower.jar")
}
```
### Decompilation preferences
> Added in LVF 1.2.0.
You can also change the preferences used to decompile the game.
For changing the properties, you can either use their 3-letter names or, with some properties, a preset method.
Preset methods as of 1.4.0:
| Method | ID | Description | Default |
|--------|----|-------------|----------|
| `inlineSimpleLambdas` | `isl` | Collapse single-line lambdas | 1 |
| `useJadVarnaming` | `jvn` | Use JAD-style local variable naming from ForgeFlower | 0 |
| `patternMatching` | `pam` | Pattern matching support[^1] | 1 |
| `experimentalTryLoopFix` | `tlf` | Fix for interactions between `try` and loops[^1] | 1 |
[^1]: Used to be experimental, but considered stable as of Vineflower 1.9
#### Groovy DSL
```groovy
vineflower {
preferences {
// fake options: don't try at home
abc = 1
ghi = 'thing'
inlineSimpleLambdas 0
}
}
```
#### Kotlin DSL
```kotlin
vineflower {
preferences(
// fake options: don't try at home
"abc" to 1,
"ghi" to "thing",
)
preferences.inlineSimpleLambdas(0)
}
```
#### gradle.properties
> Added in LVF 1.3.0.
Preferences can also be declared in gradle.properties files using their 3-letter names, prefixed
with `vineflower.preference.` or (deprecated) `loom-quiltflower.preference.`.
```properties
# Fake option here too :^)
vineflower.preference.abc = 1
```
You can use the global gradle.properties file in the Gradle user home directory to set your
wanted properties, like the indentation string, for each project that uses LVF.
#### Decompiler options
> Added in LVF 1.6.0. Only works on Fabric Loom 0.11+!
You can also configure the options with Loom's new
decompiler options API:
*Groovy DSL*
```groovy
loom {
decompilers {
vineflower {
options += [
// optionName: "value"
abc: "a"
]
}
}
}
```
*Kotlin DSL*
```kotlin
loom {
decompilers {
named("vineflower") {
options.put("", "")
}
}
}
```