mirror of
https://github.com/Xiao-MoMi/Custom-Fishing.git
synced 2025-12-31 12:56:43 +00:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
# Custom-Fishing
|
|
|
|
|
|
[](https://jitpack.io/#Xiao-MoMi/Custom-Fishing)
|
|
<a href="https://mo-mi.gitbook.io/xiaomomi-plugins/plugin-wiki/customfishing" alt="GitBook">
|
|
<img src="https://img.shields.io/badge/docs-gitbook-brightgreen" alt="Gitbook"/>
|
|
</a>
|
|
[](https://github.com/Xiao-MoMi/Custom-Fishing/)
|
|
|
|
|
|
|
|
|
|
|
|
CustomFishing is a Paper plugin designed to offer an extensive range of minigames and a robust condition and action system for fishing. Introducing a novel weight system concept, CustomFishing provides unparalleled customization opportunities while ensuring optimal performance. The plugin goes beyond standard features by allowing you to register custom mechanics, actions, conditions, games, and even parsers for configuration file formats. This flexibility makes it a powerful API for developers, enabling the creation of innovative fishing experiences, such as lava fishing or void fishing, tailored to your specific needs.
|
|
## 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
|
|
|
|
## Support the developer
|
|
|
|
Polymart: https://polymart.org/resource/customfishing.2723 \
|
|
Afdian: https://afdian.net/@xiaomomi
|
|
|
|
## CustomFishing 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-Fishing</artifactId>
|
|
<version>{VERSION}</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
### Gradle (Groovy)
|
|
|
|
```groovy
|
|
repositories {
|
|
maven { url 'https://jitpack.io' }
|
|
}
|
|
```
|
|
```groovy
|
|
dependencies {
|
|
compileOnly 'com.github.Xiao-MoMi:Custom-Fishing:{VERSION}'
|
|
}
|
|
```
|
|
### Gradle (Kotlin)
|
|
|
|
```kotlin
|
|
repositories {
|
|
maven("https://jitpack.io/")
|
|
}
|
|
```
|
|
```kotlin
|
|
dependencies {
|
|
compileOnly("com.github.Xiao-MoMi:Custom-Fishing:{VERSION}")
|
|
}
|
|
``` |