diff --git a/README.md b/README.md index 0c16ba4..9589eef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# Scissors -Scissors is a fork of Paper that aims to fix exploits possible in Creative Mode. Many of these exploits are ones that Paper's own team has either refused to fix or would have. +# 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 + +## 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) + - [`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)