mirror of
https://github.com/Xiao-MoMi/Custom-Crops.git
synced 2025-12-23 17:09:21 +00:00
84 lines
2.9 KiB
Markdown
84 lines
2.9 KiB
Markdown
# Custom-Crops
|
|
|
|
[](https://jitpack.io/#Xiao-MoMi/Custom-Crops)
|
|
<a href="https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customcrops" alt="GitBook">
|
|
<img src="https://img.shields.io/badge/docs-gitbook-brightgreen" alt="Gitbook"/>
|
|
</a>
|
|
[](https://github.com/Xiao-MoMi/Custom-Crops/)
|
|
|
|
|
|
|
|
|
|
|
|
CustomCrops is a Paper plugin crafted to deliver an exceptional planting experience for Minecraft servers, with a strong emphasis on customization and performance. It employs Zstd compression for data serialization, ensuring high efficiency comparable to Minecraft's own serialization techniques. The plugin optimizes server performance by running its tick system across multiple threads, reverting to the main thread only when required. Additionally, CustomCrops offers a comprehensive API that enables developers to create custom block mechanism with specific interaction and tick behaviors, such as a fish trap block that periodically provides players with fish.
|
|
|
|
## How to Build
|
|
|
|
#### Command Line
|
|
Install JDK 17 & 21. \
|
|
Start terminal and change directory to the project folder.\
|
|
Execute ".\gradlew build" and get the artifact under /target folder
|
|
|
|
#### IDE
|
|
Import the project and execute gradle build action. \
|
|
Get the artifact under /target folder
|
|
|
|
## How to Contribute
|
|
|
|
#### Translations
|
|
Clone this project and create a new language file in the /common/src/main/resources/translations directory. \
|
|
Once your changes are ready, open a pull request for review. We appreciate your works!
|
|
|
|
## Support the Developer
|
|
|
|
Polymart: https://polymart.org/resource/customcrops.2625 \
|
|
Afdian: https://afdian.com/@xiaomomi
|
|
|
|
## CustomCrops API
|
|
|
|
### Maven
|
|
|
|
```html
|
|
<repositories>
|
|
<repository>
|
|
<id>jitpack</id>
|
|
<url>https://jitpack.io/</url>
|
|
</repository>
|
|
</repositories>
|
|
```
|
|
```html
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>com.github.Xiao-MoMi</groupId>
|
|
<artifactId>Custom-Crops</artifactId>
|
|
<version>{LATEST}</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
### Gradle (Groovy)
|
|
|
|
```groovy
|
|
repositories {
|
|
maven { url 'https://jitpack.io' }
|
|
}
|
|
```
|
|
```groovy
|
|
dependencies {
|
|
compileOnly 'com.github.Xiao-MoMi:Custom-Crops:{LATEST}'
|
|
}
|
|
```
|
|
### Gradle (Kotlin)
|
|
|
|
```kotlin
|
|
repositories {
|
|
maven("https://jitpack.io/")
|
|
}
|
|
```
|
|
```kotlin
|
|
dependencies {
|
|
compileOnly("com.github.Xiao-MoMi:Custom-Crops:{LATEST}")
|
|
}
|
|
```
|
|
#### Fun Facts
|
|
I misspelled mechanism as mechanic. I should have realized this earlier XD |