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] Fix typos in project files (#586)

Browse Source
This commit is contained in:
fredster33
2021-08-11 17:31:31 -07:00
committed by GitHub
parent d1d6bc2e9e
commit 22c86b0990
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@@ -12,12 +12,12 @@ Assuming you already have forked the repository:
3. Type `./gradlew applyPatches` to apply the latest Purpur patches 3. Type `./gradlew applyPatches` to apply the latest Purpur patches
4. cd into `Purpur-Server` for server changes, and `Purpur-API` for API changes 4. cd into `Purpur-Server` for server changes, and `Purpur-API` for API changes
These directories aren't git repositories in the traditional sense: These directories aren't Git repositories in the traditional sense:
- Every single commit in Purpur-Server/API is a patch. - Every single commit in Purpur-Server/API is a patch.
- 'origin/master' points to a directory similar to Purpur-Server/API but for Paper - 'origin/master' points to a directory similar to Purpur-Server/API but for Paper
- Typing `git status` should show that we are 10 or 11 commits ahead of master, meaning we have 10 or 11 patches that Paper doesn't - Typing `git status` should show that we are 10 or 11 commits ahead of master, meaning we have 10 or 11 patches that Paper doesn't
- If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update purpur - If it says something like `212 commits ahead, 207 commits behind`, then type `git fetch` to update Purpur
## Adding Patches ## Adding Patches
Adding patches to Purpur is very simple: Adding patches to Purpur is very simple:
@@ -30,7 +30,7 @@ Adding patches to Purpur is very simple:
6. Run `./gradlew rebuildPatches` in the main directory to convert your commit into a new patch 6. Run `./gradlew rebuildPatches` in the main directory to convert your commit into a new patch
7. PR your patches back to this repository 7. PR your patches back to this repository
Your commit will be converted into a patch that you can then PR into Purpur Your commit will be converted into a patch that you can then PR into Purpur.
## Help! I can't find the file I'm looking for! ## Help! I can't find the file I'm looking for!
By default, Purpur (and upstream) only import files that we make changes to. By default, Purpur (and upstream) only import files that we make changes to.
@@ -113,8 +113,8 @@ Location spawnLocation = ((CraftWorld)entity.getWorld()).getSpawnLocation();
entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation.getY(), spawnLocation.getZ())); entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation.getY(), spawnLocation.getZ()));
// Purpur end // Purpur end
``` ```
- We generally follow usual java style, or what is programmed into most IDEs and formatters by default - We generally follow usual Java style, or what is programmed into most IDEs and formatters by default
- This is also known as oracle style - This is also known as Oracle style
- It is fine to go over 80 lines as long as it doesn't hurt readability - It is fine to go over 80 lines as long as it doesn't hurt readability
- There are exceptions, especially in Spigot-related files - There are exceptions, especially in Spigot-related files
- When in doubt, use the same style as the surrounding code - When in doubt, use the same style as the surrounding code
@@ -140,7 +140,7 @@ Subject: [PATCH] revert serverside behavior of keepalives
This patch intends to bump up the time that a client has to reply to the This patch intends to bump up the time that a client has to reply to the
server back to 30 seconds as per pre 1.12.2, which allowed clients server back to 30 seconds as per pre 1.12.2, which allowed clients
more than enough time to reply potentially allowing them to be less more than enough time to reply potentially allowing them to be less
tempermental due to lag spikes on the network thread, e.g. that caused temperamental due to lag spikes on the network thread, e.g. that caused
by plugins that are interacting with netty. by plugins that are interacting with netty.
We also add a system property to allow people to tweak how long the server We also add a system property to allow people to tweak how long the server
@@ -163,7 +163,7 @@ An obfuscation helper to get an obfuscated field may be as simple as something l
```java ```java
public final int getStuckArrows() { return this.bY(); } // Purpur - OBFHELPER public final int getStuckArrows() { return this.bY(); } // Purpur - OBFHELPER
``` ```
Or it may be as complex as forwarding an entire method so that it can be overriden later: Or it may be as complex as forwarding an entire method so that it can be overridden later:
```java ```java
public boolean be() { public boolean be() {
// Purpur start - OBFHELPER // Purpur start - OBFHELPER

6
README.md
View File

@@ -118,18 +118,18 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.
#### 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`.
To get a purpurclip jar, run `./gradlew paperclip`. To get a purpurclip jar, run `./gradlew paperclip`.
To install the `purpur-api` and `purpur` dependencies to your local maven repo, run `./gradlew publishToMavenLocal` To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`
Special Thanks To: Special Thanks To:
------------- -------------
![YourKit-Logo](https://www.yourkit.com/images/yklogo.png) ![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)
[YourKit](https://www.yourkit.com/), makers of the outstanding java profiler, [YourKit](https://www.yourkit.com/), makers of the outstanding Java profiler,
support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler) support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler)
and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for allowing us to use their and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for allowing us to use their
software so we can make Purpur the best it can be. software so we can make Purpur the best it can be.