Purpur/README.md at e1729ee539d19c83ede88eed18e74ad96180ba5a

mirror of https://github.com/PurpurMC/Purpur.git synced 2025-02-11 12:50:28 +08:00

Ben Kerllenevich e1729ee539 README.md Coloring

This makes the 'Purpur API maven dependency' and 'Purpur API gradle dependency' have coloring. This really isnt
an important change, but compared to Papers README they look devoid of all life and they were sucking away my
remaining will to live :P

2020-12-01 08:28:35 -06:00

11 KiB

Raw Blame History

Purpur

Purpur is a fork of Paper and Tuinity with the goal of providing new and interesting configuration options, which allow for creating a unique gameplay experience not seen anywhere else

Contact

Join us on Discord

Downloads

Downloads can be obtained from Pl3x's Jenkins CI Server.

1.16.4 builds 809+
1.16.3 builds 751-808
1.16.2 builds 711-750
1.16.1 builds 608-710
1.15.2 builds 398-606
1.15.1 builds 348-397
1.15 builds 339-346
1.14.x builds 337 and below

License

Everything is licensed under the MIT license, and is free to be used in your own fork.

See starlis/empirecraft and electronicboy/byof for the license of material used/modified by this project.

bStats

API

Purpur API maven dependency:

<dependency>
    <groupId>net.pl3x.purpur</groupId>
    <artifactId>purpur-api</artifactId>
    <version>1.16.4-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

<repository>
    <id>purpur</id>
    <url>https://repo.pl3x.net/</url>
</repository>

Purpur API gradle dependency:

maven {
    name 'purpur'
    url 'https://repo.pl3x.net/'
}

compileOnly 'net.pl3x.purpur:purpur-api:1.16.4-R0.1-SNAPSHOT'

Yes, this also includes all API provided by Paper, Spigot, and Bukkit.

Building and setting up

Initial setup

Run the following commands in the root directory:

git submodule update --init
./purpur up
./purpur 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 ./purpur rb, and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file.

See CONTRIBUTING.md for more detailed information.

Compiling

Use the command ./purpur build to build the api and server. Compiled jars will be placed under Purpur-API/target and Purpur-Server/target.

To get a purpurclip jar, run ./purpur jar.

11 KiB Raw Blame History