Skip to content

Commit 10fdade

Browse files
committed
update docs
1 parent 8ab81c2 commit 10fdade

2 files changed

Lines changed: 11 additions & 101 deletions

File tree

README.md

Lines changed: 6 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,10 @@
1-
Paper [![Paper Build Status](https://img.shields.io/github/actions/workflow/status/PaperMC/Paper/build.yml?branch=main)](https://github.com/PaperMC/Paper/actions)
2-
[![Discord](https://img.shields.io/discord/289587909051416579.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/papermc)
3-
[![GitHub Sponsors](https://img.shields.io/github/sponsors/papermc?label=GitHub%20Sponsors)](https://github.com/sponsors/PaperMC)
4-
[![Open Collective](https://img.shields.io/opencollective/all/papermc?label=OpenCollective%20Sponsors)](https://opencollective.com/papermc)
5-
===========
1+
# CivPaper
62

7-
The most widely used, high-performance Minecraft server that aims to fix gameplay and mechanics inconsistencies.
3+
CivPaper is a fork of 1.21.4 Paper with optimisations intended for survival-like servers with many entities and players, distributed widely.
84

5+
It is a high priority that gameplay is not affected in any way, and this is intended as a kind of "staging ground" for merging into mainline Paper.
96

10-
**Support and Project Discussion:**
11-
- [Our forums](https://forums.papermc.io/) or [Discord](https://discord.gg/papermc)
7+
Currently, we have two patches:
128

13-
How To (Server Admins)
14-
------
15-
Paperclip is a jar file that you can download and run just like a normal jar file.
16-
17-
Download Paper from our [downloads page](https://papermc.io/downloads/paper).
18-
19-
Run the Paperclip jar directly from your server. Just like old times
20-
21-
* Documentation on using Paper: [docs.papermc.io](https://docs.papermc.io)
22-
* For a sneak peek at upcoming features, [see here](https://github.com/PaperMC/Paper/projects)
23-
24-
How To (Plugin Developers)
25-
------
26-
* See our API [here](paper-api)
27-
* See upcoming, pending, and recently added API [here](https://github.com/orgs/PaperMC/projects/2/views/4)
28-
* Paper API javadocs here: [papermc.io/javadocs](https://papermc.io/javadocs/)
29-
#### Repository (for paper-api)
30-
##### Maven
31-
32-
```xml
33-
<repository>
34-
<id>papermc</id>
35-
<url>https://repo.papermc.io/repository/maven-public/</url>
36-
</repository>
37-
```
38-
39-
```xml
40-
<dependency>
41-
<groupId>io.papermc.paper</groupId>
42-
<artifactId>paper-api</artifactId>
43-
<version>1.21.4-R0.1-SNAPSHOT</version>
44-
<scope>provided</scope>
45-
</dependency>
46-
```
47-
##### Gradle
48-
```kotlin
49-
repositories {
50-
maven {
51-
url = uri("https://repo.papermc.io/repository/maven-public/")
52-
}
53-
}
54-
55-
dependencies {
56-
compileOnly("io.papermc.paper:paper-api:1.21.4-R0.1-SNAPSHOT")
57-
}
58-
59-
java {
60-
toolchain.languageVersion.set(JavaLanguageVersion.of(21))
61-
}
62-
```
63-
64-
How To (Compiling Jar From Source)
65-
------
66-
To compile Paper, you need JDK 21 and an internet connection.
67-
68-
Clone this repo, run `./gradlew applyPatches`, then `./gradlew createMojmapBundlerJar` from your terminal. You can find the compiled jar in the `paper-server/build/libs` directory.
69-
70-
To get a full list of tasks, run `./gradlew tasks`.
71-
72-
How To (Pull Request)
73-
------
74-
See [Contributing](CONTRIBUTING.md)
75-
76-
Old Versions (1.21.3 and below)
77-
------
78-
For branches of versions 1.8-1.21.3, please see our [archive repository](https://github.com/PaperMC/Paper-archive).
79-
80-
Support Us
81-
------
82-
First of all, thank you for considering helping out, we really appreciate that!
83-
84-
PaperMC has various recurring expenses, mostly related to infrastructure. Paper uses [Open Collective](https://opencollective.com/) via the [Open Source Collective fiscal host](https://opencollective.com/opensource) to manage expenses. Open Collective allows us to be extremely transparent, so you can always see how your donations are used. You can read more about financially supporting PaperMC [on our website](https://papermc.io/sponsors).
85-
86-
You can find our collective [here](https://opencollective.com/papermc), or you can donate via GitHub Sponsors [here](https://github.com/sponsors/PaperMC), which will also go towards the collective.
87-
88-
Special Thanks To:
89-
-------------
90-
91-
[![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)](https://www.yourkit.com/)
92-
93-
[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) and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.
94-
95-
[<img src="https://user-images.githubusercontent.com/21148213/121807008-8ffc6700-cc52-11eb-96a7-2f6f260f8fda.png" alt="" width="150">](https://www.jetbrains.com)
96-
97-
[JetBrains](https://www.jetbrains.com/), creators of the IntelliJ IDEA, supports Paper with one of their [Open Source Licenses](https://www.jetbrains.com/opensource/). IntelliJ IDEA is the recommended IDE for working with Paper, and most of the Paper team uses it.
98-
99-
All our sponsors!
100-
[![Sponsor Image](https://raw.githubusercontent.com/PaperMC/papermc.io/data/sponsors.png)](https://papermc.io/sponsors)
9+
- Optimises TemptGoal for animals so that they don't look at the items for every player every tick
10+
- Optimises mob despawning to use a spatial data structure to find how far away a player is so that a mob can despawn

paper-server/build.gradle.kts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -189,14 +189,14 @@ tasks.jar {
189189
val gitBranch = git.exec(providers, "rev-parse", "--abbrev-ref", "HEAD").get().trim()
190190
attributes(
191191
"Main-Class" to "org.bukkit.craftbukkit.Main",
192-
"Implementation-Title" to "Paper",
192+
"Implementation-Title" to "CivPaper",
193193
"Implementation-Version" to implementationVersion,
194194
"Implementation-Vendor" to date,
195-
"Specification-Title" to "Paper",
195+
"Specification-Title" to "CivPaper",
196196
"Specification-Version" to project.version,
197-
"Specification-Vendor" to "Paper Team",
198-
"Brand-Id" to "papermc:paper",
199-
"Brand-Name" to "Paper",
197+
"Specification-Vendor" to "CivMC Team",
198+
"Brand-Id" to "papermc:civpaper",
199+
"Brand-Name" to "CivPaper",
200200
"Build-Number" to (build ?: ""),
201201
"Build-Time" to buildTime.toString(),
202202
"Git-Branch" to gitBranch,

0 commit comments

Comments
 (0)