72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
<img src="https://user-images.githubusercontent.com/83630775/196994084-2c53ac23-f4be-4b90-b6fc-1b0ba65ea1b8.png" alt="KeYi's logo" align="right" width="400">
|
|
<div align="left">
|
|
<h4>Also available in: <a href="https://github.com/KeYiMC/KeYi/blob/master/README_ZH.md">中文</a></h4>
|
|
<h1>KeYi</h1>
|
|
<h3>⚡ The next generation Minecraft server software aims to the balance of performance and stability.</h3>
|
|
<h5>This project is still under heavy development, use it at your own risk!</h5>
|
|
<i><h5>KeYi, is the Chinese word "可以", means some thing is very OK!</h5></i>
|
|
|
|
[](https://discord.gg/Sm2NsY5dpV)
|
|
[](https://jq.qq.com/?_wv=1027&k=i2MG7npf)
|
|
</div>
|
|
|
|
# Why another fork?
|
|
|
|
The answer is quite simple.
|
|
|
|
The existing forks doesn't meet up what our requires, so we made up a small team and created this fork.
|
|
|
|
# Roadmap
|
|
|
|
As you can see, this fork is designed to be stable, but also gain some performance improvements.
|
|
|
|
The improvements of the API is also being valued, so we will try our best to work on it.
|
|
|
|
# API
|
|
|
|
### Maven
|
|
|
|
#### Adding repository
|
|
|
|
```xml
|
|
<repository>
|
|
<id>keyi</id>
|
|
<url>https://maven.pkg.github.com/KeYiMC/KeYi</url>
|
|
</repository>
|
|
```
|
|
|
|
#### Adding dependency
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>cc.keyimc.keyi</groupId>
|
|
<artifactId>keyi-api</artifactId>
|
|
<version>1.19.2-R0.1-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
|
|
### Gradle
|
|
|
|
#### Adding repository
|
|
|
|
```groovy
|
|
repositories {
|
|
maven("https://maven.pkg.github.com/KeYiMC/KeYi")
|
|
}
|
|
```
|
|
|
|
#### Adding dependency
|
|
|
|
```groovy
|
|
dependencies {
|
|
compileOnly("cc.keyimc.keyi:keyi-api:1.19.2-R0.1-SNAPSHOT")
|
|
}
|
|
```
|
|
|
|
# Contributing
|
|
|
|
Unfortunately, the rules of our community haven't been finished yet.
|
|
|
|
So at this time, if you want to contribute, you need to talk with us on Discord or Tencent QQ.
|