chipmunkmc/Scissors
1
0
Fork 0
mirror of https://github.com/AtlasMediaGroup/Scissors.git synced 2024-11-14 19:34:54 -05:00
Code Issues 10 Projects Releases Packages 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
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
```
paperweight {
serverProject.set(project(":ForkTest-Server"))
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"))
}
}
}
```
The files of most interest are
- build.gradle.kts
- settings.gradle.kts
- gradle.properties
## Tasks
```
Paperweight tasks
-----------------
applyApiPatches
applyPatches
applyServerPatches
cleanCache - Delete the project setup cache and task outputs.
patchPaperApi
patchPaperServer
rebuildPaperApi
rebuildPaperServer
generateDevelopmentBundle
paperclipJar - Build a runnable paperclip jar
rebuildApiPatches
rebuildPatches
rebuildServerPatches
reobfJar - Re-obfuscate the built jar to obf mappings
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
```