9
0
mirror of https://github.com/Xiao-MoMi/Custom-Crops.git synced 2025-12-19 15:09:25 +00:00
Files
Custom-Crops/README.md
2025-06-20 23:43:30 +08:00

3.0 KiB

Custom-Crops 🌱

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

📌 Overview

CustomCrops is a high-performance Paper plugin designed to enhance the planting experience on Minecraft servers. It focuses on customization and efficiency, utilizing advanced techniques for optimal performance. 🌾

🔥 Key Features

  • Zstd Compression: Efficient data serialization comparable to Minecraft's native methods.
  • Multi-threaded Tick System: Improves server performance by distributing tasks across multiple threads.
  • 🛠️ Comprehensive API: Enables developers to create custom block mechanisms with specific interactions and behaviors.

🔧 Building the Project

💻 Command Line

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

🛠️ Using an IDE

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

🤝 Contributing

🌍 Translations

  1. Clone the repository.
  2. Create a new language file in:
    /plugin/src/main/resources/translations
    
  3. Submit a pull request with your changes for review. We appreciate your contributions! 💖

🚀 Areas for Improvement

  • Enhance thread scheduler efficiency and reduce ConcurrentHashMap usage.
  • Optimize map storage in sections using a palette system.
  • Replace the current sponge flow-nbt library with a more efficient alternative (e.g., sparrow-nbt).
  • Implement an improved region file format with file headers and sectors for random read/write operations (4.0 milestone).

💖 Support the Developer

If you enjoy using CustomCrops, consider supporting the developer! 🥰


📚 CustomCrops API

📌 Repository

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

📌 Dependency

dependencies {
    compileOnly("net.momirealms:custom-crops:3.6.40")
}

🎉 Fun Fact

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