Skip to content

Latest commit

 

History

History
64 lines (51 loc) · 2.04 KB

README.md

File metadata and controls

64 lines (51 loc) · 2.04 KB
Raw

LumiPaper

While our network is no longer running and this fork no longer maintained, the patches still work perfectly fine. Feel free to yoink patches, as long as the original header+author are kept.

License

The PATCHES-LICENSE.txt file describes the license for api, mojangapi, and server patches, found in ./patches/api, ./patches/mojangapi, and ./patches/server.

Keep patch author tags, even if porting single patches. Use co-authored if necessary.

Plugin developers

In order to use Paper as a dependency you must following the steps laid out in Building and setting up and build paper. Each time you want to update your dependency you must re-build paper.

LumiPaper-API maven dependency:

<dependency>
    <groupId>net.luminu.paper</groupId>
    <artifactId>paper-api</artifactId>
    <version>1.16.1-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
 </dependency>

LumiPaper-Server maven dependency:

<dependency>
   <groupId>net.luminu.paper</groupId>
   <artifactId>paper</artifactId>
   <version>1.16.1-R0.1-SNAPSHOT</version>
   <scope>provided</scope>
</dependency>

There is no repository required since the artifacts should be locally installed via building paper.

Building and setting up

Run the following commands in the root directory:

git submodule init
git submodule update
./lumi up
./lumi patch

This should initialize the repo such that you can now start modifying and creating patches. The folder LumiPaper-API is the api repo and the LumiPaper-Server folder is the server repo and will contain the source files you will modify.

Creating a patch

Patches are effectively just commits in either LumiPaper-API or LumiPaper-Server. To create one, just add a commit to either repo and run ./lumi rb, and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file.

Building

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