Mirrors/Purpur
1
0
Fork 1
mirror of https://github.com/PurpurMC/Purpur.git synced 2026-02-17 08:27:43 +01:00
Code Issues Packages Projects Releases Wiki Activity

[ci skip] Update README.md (#1642)

Browse Source 
Co-authored-by: granny <granny@purpurmc.org>
This commit is contained in:
z5tm
2025-02-06 14:07:02 -06:00
committed by GitHub
parent fdc28eed6b
commit d8aadde1f8
1 changed files with 4 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -94,28 +94,23 @@ First, <u>clone</u> this repository. Do not download it.
Then run the following command in the root directory: Then run the following command in the root directory:
``` ```
./gradlew applyPatches ./gradlew applyAllPatches
``` ```
The project is now ready for use in your IDE. The project is now ready for use in your IDE.
#### Creating a patch #### Creating a patch
Patches are effectively just commits in either `Purpur-API` or `Purpur-Server`.
To create one, just add a commit to either repo and run `./gradlew rebuildPatches`, and a
patch will be placed in the patches folder. Modifying commits will also modify its
corresponding patch file.
See [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.
See [CONTRIBUTING.md](CONTRIBUTING.md).
#### Compiling #### Compiling
Use the command `./gradlew build` to build the API and server. Compiled JARs Use the command `./gradlew build` to build the API and server. Compiled JARs
will be placed under `Purpur-API/build/libs` and `Purpur-Server/build/libs`. will be placed under `purpur-api/build/libs` and `purpur-server/build/libs`.
**These JARs are not used to start a server.** **These JARs are not used to start a server.**
To compile a server-ready purpurclip jar, run `./gradlew createMojmapBundlerJar`. To compile a server-ready purpurclip jar, run `./gradlew createMojmapBundlerJar`.
To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`. The compiled purpurclip jar will be in `build/libs/` not `Purpur-Server/build/libs`. To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`. The compiled purpurclip jar will be in `purpur-server/build/libs`.
Special Thanks To: Special Thanks To:
------------- -------------