https://github.com/papermc/paperweight-examples
https://github.com/papermc/paperweight-examples
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/papermc/paperweight-examples
- Owner: PaperMC
- Created: 2021-06-12T12:21:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-07T04:46:01.000Z (about 2 years ago)
- Last Synced: 2024-04-14T05:37:39.783Z (almost 2 years ago)
- Size: 321 KB
- Stars: 54
- Watchers: 18
- Forks: 48
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ForkTest - A Paper fork, using paperweight
This is an example project, showcasing how to setup a fork of Paper (or any other fork using paperweight), using paperweight.
The files of most interest are
- build.gradle.kts
- settings.gradle.kts
- gradle.properties
When updating upstream, be sure to keep the dependencies noted in `build.gradle.kts` in sync with upstream.
It's also a good idea to use the same version of the Gradle wrapper as upstream.
## Tasks
```
Paperweight tasks
-----------------
applyApiPatches
applyPatches
applyServerPatches
cleanCache - Delete the project setup cache and task outputs.
createMojmapBundlerJar - Build a runnable bundler jar
createMojmapPaperclipJar - Build a runnable paperclip jar
createReobfBundlerJar - Build a runnable bundler jar
createReobfPaperclipJar - Build a runnable paperclip jar
generateDevelopmentBundle
rebuildApiPatches
rebuildPatches
rebuildServerPatches
reobfJar - Re-obfuscate the built jar to obf mappings
runDev - Spin up a non-relocated Mojang-mapped test server
runReobf - Spin up a test server from the reobfJar output jar
runShadow - Spin up a test server from the shadowJar archiveFile
```
## Branches
Each branch of this project represents an example:
- [`main` is the standard example](https://github.com/PaperMC/paperweight-examples/tree/main)
- [`submodules` shows how paperweight can be applied on a fork using the more traditional git submodule system](https://github.com/PaperMC/paperweight-examples/tree/submodules)