mirror of
https://github.com/PaperMC/Folia.git
synced 2024-11-25 12:35:23 +01:00
Update README
This commit is contained in:
parent
5288d83ece
commit
d56348b64b
35
README.md
35
README.md
@ -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
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user