Scissors/README.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2021-06-12 18:08:10 +00:00
# ForkTest - A Paper fork, using paperweight
2021-08-25 04:21:42 +00:00
This is an example project, showcasing how to setup a fork of Paper (or any other fork using paperweight), using paperweight.
2021-06-12 18:08:10 +00:00
2021-08-25 04:21:42 +00:00
The files of most interest are
- build.gradle.kts
- settings.gradle.kts
- gradle.properties
2021-06-12 18:08:10 +00:00
## Tasks
```
Paperweight tasks
-----------------
2021-08-25 04:21:42 +00:00
applyApiPatches
2021-06-12 18:08:10 +00:00
applyPatches
2021-08-25 04:21:42 +00:00
applyServerPatches
2021-06-12 18:08:10 +00:00
cleanCache - Delete the project setup cache and task outputs.
2021-08-25 04:21:42 +00:00
generateDevelopmentBundle
paperclipJar - Build a runnable paperclip jar
rebuildApiPatches
2021-06-12 18:08:10 +00:00
rebuildPatches
2021-08-25 04:21:42 +00:00
rebuildServerPatches
reobfJar - Re-obfuscate the built jar to obf mappings
2021-06-12 18:08:10 +00:00
runDev - Spin up a non-shaded non-remapped test server
2021-08-25 04:21:42 +00:00
runReobf - Spin up a test server from the reobfJar output jar
2021-06-12 18:08:10 +00:00
runShadow - Spin up a test server from the shadowJar archiveFile
```
2021-06-16 07:11:04 +00:00
## 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)
- [`mojangapi` shows how a fork could patch arbitrary non-git directories (such as `Paper-MojangAPI`)](https://github.com/PaperMC/paperweight-examples/tree/mojangapi)
- [`submodules-mojang` shows the same as `mojangapi`, but on the git submodules setup from `submodules`](https://github.com/PaperMC/paperweight-examples/tree/submodules-mojangapi)