Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 2.66 KB

README.md

File metadata and controls

78 lines (63 loc) · 2.66 KB

Custom-Fishing 🎣

CodeFactor Grade Gitbook Scc Count Badge Code Size bStats Servers bStats Players GitHub

📌 About CustomFishing

CustomFishing is a Paper plugin designed to provide a variety of fishing minigames and a powerful condition and action system. It introduces a unique weight system, offering unparalleled customization while maintaining optimal performance.

🔥 Key Features:

  • Extensive customization options for fishing mechanics.
  • Ability to register custom mechanisms, actions, conditions, games, and configuration parsers.
  • Supports innovative fishing experiences, such as lava fishing or void fishing.
  • Provides a robust API for developers to extend functionality easily.

🔧 How to Build

💻 Command Line

  1. Install JDK 17 & 21.
  2. Open a terminal and navigate to the project directory.
  3. Run:
    ./gradlew build
  4. The artifact will be available in the /target folder.

🛠️ Using an IDE

  1. Import the project into your preferred IDE.
  2. Execute the Gradle build action.
  3. Find the artifact in the /target folder.

🤝 How to Contribute

🌍 Translations

  1. Clone this repository.
  2. Create a new language file in:
    /core/src/main/resources/translations
    
  3. Once done, submit a pull request for review. We appreciate your contributions!

💖 Support the Developer

If you enjoy using CustomFishing, consider supporting the developer!


📚 CustomFishing API

📌 Repository

repositories {
    maven("https://repo.momirealms.net/releases/")
}

📌 Dependency

dependencies {
    compileOnly("net.momirealms:custom-fishing:2.3.4")
}

🎉 Fun Fact

I misspelled "mechanism" as "mechanic"—I should have caught that earlier! 😆