https://github.com/kezz/haricot

Beancraft's Paper fork, with new APIs and other enhancements
https://github.com/kezz/haricot

bukkit craftbukkit java minecraft paper-fork

Last synced: 16 days ago
JSON representation

Beancraft's Paper fork, with new APIs and other enhancements

• Host: GitHub
• URL: https://github.com/kezz/haricot
• Owner: kezz
• License: mit
• Archived: true
• Created: 2021-02-11T11:01:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-19T11:26:35.000Z (almost 4 years ago)
• Last Synced: 2024-09-27T12:01:54.498Z (4 months ago)
• Topics: bukkit, craftbukkit, java, minecraft, paper-fork
• Language: Shell
• Homepage: https://beancraft.ml
• Size: 27.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
Haricot

==

Custom Paper fork used by [Beancraft](https://beancraft.ml). The fork is based 

on the framework used in

[Phoenix616's Origami](https://github.com/Minebench/Origami/). For a full list 

of changes, read the [changelog](CHANGELOG.md).

There is no support guaranteed with this fork. However, if you do run into any 

issues, drop Kezz#4616 a message on Discord and they will be happy to help.

## License

The PATCHES-LICENSE file describes the license for api & server patches

by Kezz found in `./patches/api` and `./patches/server`. Other patches

are either licensed under MIT or another one specified in the patch file itself.

Everything else is licensed under the MIT license. 

See https://github.com/Minebench/Origami, 

https://github.com/Spottedleaf/Tuinity, https://github.com/pl3xgaming/Purpur,

https://github.com/starlis/empirecraft and https://github.com/electronicboy/byof

for the license of material used/modified by this project.

## Plugin developers

In order to use Haricot as a dependency just add the dependency below to 

your pom. There is no repository as development should be done on a locally 

installed copy of the API.

Origami-API maven dependency:

```xml

    ml.beancraft

    haricot-api

    1.16.5-R0.1-SNAPSHOT

    provided

 

 ```

## Building and setting up

Run the following commands in the root directory:

```

git submodule init

git submodule update

./haricot up

./haricot patch

```

This should initialize the repo such that you can now start modifying and 

creating patches. The folder `Haricot-API` is the api repo and the 

`Haricot-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 `Haricot-API` or 

`Haricot-Server`. To create one, just add a commit to either repo and run

`./haricot rb`, and a patch will be placed in the `patches` folder. Modifying 

commits will also modify the corresponding patch file.

#### Building

Use the command `./haricot build` to build the api and server. Compiled jars

will be placed under `Haricot-API/target` and `Haricot-Server/target`.

#### Updating Paper upstream

Switch into the directory of the Paper submodule and pull changes in from the 

repository, then run `./haricot up` and `./haricot rb`.