Upstream/Folia
1
0
Fork 0
mirror of https://github.com/PaperMC/Folia.git synced 2024-11-25 12:35:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Jason Penilla 2021-08-24 21:21:42 -07:00
parent 5288d83ece
commit d56348b64b
No known key found for this signature in database
GPG Key ID: 0E75A301420E48F8
1 changed files with 13 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,38 +1,29 @@
# ForkTest - A Paper fork, using paperweight # ForkTest - A Paper fork, using paperweight
This is an example project, showcasing how to setup a fork of paper (or well, any project), using paperweight. This is an example project, showcasing how to setup a fork of Paper (or any other fork using paperweight), using paperweight.
The interesting part of this is in the build gradle The files of most interest are
``` - build.gradle.kts
paperweight { - settings.gradle.kts
serverProject.set(project(":ForkTest-Server")) - gradle.properties
usePaperUpstream(providers.gradleProperty("paperRef")) { // specified in gradle.properties
withPaperPatcher {
apiPatchDir.set(layout.projectDirectory.dir("patches/api"))
apiOutputDir.set(layout.projectDirectory.dir("ForkTest-API"))
serverPatchDir.set(layout.projectDirectory.dir("patches/server"))
serverOutputDir.set(layout.projectDirectory.dir("ForkTest-Server"))
}
}
}
```
## Tasks ## Tasks
``` ```
Paperweight tasks Paperweight tasks
----------------- -----------------
applyApiPatches
applyPatches applyPatches
applyServerPatches
cleanCache - Delete the project setup cache and task outputs. cleanCache - Delete the project setup cache and task outputs.
patchPaperApi generateDevelopmentBundle
patchPaperServer paperclipJar - Build a runnable paperclip jar
rebuildPaperApi rebuildApiPatches
rebuildPaperServer
rebuildPatches rebuildPatches
rebuildServerPatches
reobfJar - Re-obfuscate the built jar to obf mappings
runDev - Spin up a non-shaded non-remapped test server runDev - Spin up a non-shaded non-remapped test server
runReobf - Spin up a test server from the reobfJar output jar
runShadow - Spin up a test server from the shadowJar archiveFile runShadow - Spin up a test server from the shadowJar archiveFile
``` ```