c8f6e05472
* Work * Include mappings hash in manifest * Use manifest instead of marker file * Create the manifest if it doesn't exist * Make RemapJar no-op when the namespaces match * move files * decorate userdev jar manifests * fix relocated shadow jar manifest * feat(core/patcher): Replace use of shadow plugin We now reobf using the relocated mappings. The constant pool still needs to be relocated for references to CB classes by name in for example Commodore or class preloading. * chore(core/patcher): Remove no longer needed relocation logic from GenerateDevBundle * chore(core/patcher): Do not extract manifest when including mappings We don't need this after removing shadow usage * Bump version to 1.6.0-SNAPSHOT |
||
|---|---|---|
| .github/workflows | ||
| buildSrc | ||
| gradle | ||
| license | ||
| paperweight-core | ||
| paperweight-lib | ||
| paperweight-patcher | ||
| paperweight-userdev | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| build.gradle.kts | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| readme.md | ||
| settings.gradle.kts | ||
paperweight
paperweight consists of three Gradle plugins:
paperweight-core: Used to build Paperpaperweight-patcher: Used to create forks of Paper or otherpaperweight-patcher-based forkspaperweight-userdev: Used to develop internals plugins using Mojang mappings
How to use this for testing:
- Install
paperweightto Maven Local:
./gradlew publishToMavenLocal
- Add
mavenLocal()for plugin resolution in your test project (see the Gradle docs for more details) - Adjust the
paperweightversion in your test project- Local versions of
paperweightwill use have the-SNAPSHOTsuffix in the version fromgradle.propertiesreplaced by-LOCAL-SNAPSHOT
- Local versions of
Most output
paperweightcreates goes into<project-root>/.gradle/caches/paperweight
Debugging
Create a remote JVM debug run configuration in IntelliJ which connects to port 5005, then run Gradle in debug mode:
./gradlew --no-daemon -Dorg.gradle.debug=true <task>
Gradle will not start until the debugger is connected so you don't need to worry about missing a breakpoint.
Style Guide
This projects follows the opinionated ktlint linter and formatter. It uses the
ktlint-gradle plugin to automatically check and format the code in
this repo.
Run the format task to automatically reformat the project using ktlint - which should handle most cases - to
maintain a consistent code style. Adjust any errors ktlint can't fix itself before committing.
./gradlew format
IDE Setup
It's recommended to run the ktlintApplyToIdea and addKtlintFormatGitPreCommitHook tasks to configure your IDE
with ktlint style settings and to automatically format this project's code before committing:
./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook
This project uses many new Gradle features to make sure we're ready for Gradle 7.0 and beyond, and we don't find ourselves stuck in a bad position where it's too hard for us to update. That being said, Gradle always marks new APIs as unstable for a bit until the next major version, so you should probably disable the "Unstable API Usages" inspection in IntelliJ as well. The easiest way to do this is just find any place where an "unstable API" is used (tons in
Paperweight.kt) and disable the inspection from there.