Skip to content

HitChainAPI is a high-performance, scalable Minecraft plugin API for version 1.8.9, designed to be modular and easily extendable. It provides advanced utilities for handling commands, events, storage, and more, making it ideal for developers looking to create feature-rich and efficient plugins.

Notifications You must be signed in to change notification settings

CxmboFight/HitChainAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

HitChainAPI πŸ—οΈβš‘οΈ

The Ultimate Minecraft Plugin API for Developers

Welcome to HitChainAPI, the most advanced and scalable plugin API for Minecraft 1.8.9! This API is built for developers who want to create high-performance, feature-rich plugins with ease. Whether you're crafting complex PvP mechanics, economy systems, or custom gameplay features, HitChainAPI is your gateway to next-level Minecraft plugin development.

HitChainAPI is packed with modular features, advanced utilities, and highly customizable components. It’s designed for the future, ensuring that your plugins will scale with your server as it grows, and that you have the tools to deliver the highest quality gameplay experience.

Key Features πŸš€

✨ Modular Architecture

  • Extendable design, allowing you to easily add new features like PvP systems, quest frameworks, economy plugins, and more.
  • Complete control over plugin components. Build complex systems using simple building blocks.

⚑️ Performance Optimized

  • Built for efficiency with asynchronous handling, optimized event dispatching, and smart resource management.
  • Zero lag even for large-scale servers with thousands of players.
  • Advanced debugging tools and profiling for perfect performance tuning.

πŸ› οΈ Advanced Command System

  • Dynamic and easy-to-extend command framework with support for permissions, async tasks, and advanced subcommands.
  • Built-in permissions system with customizable roles for fine-tuned control over command execution.

πŸ“¦ Data Storage Support

  • Flexible data storage options including SQLite, MySQL, and Redis. Store player data, stats, and much more.
  • Support for cloud storage integrations (Google Cloud, AWS) for seamless cross-server and cross-platform compatibility.

πŸ”§ Utilities and Helpers

  • Message formatting and placeholder support for user-friendly messages.
  • ItemBuilder for easily creating items with custom names, lore, and enchantments.
  • CooldownManager and TimerUtils for handling command and ability cooldowns.
  • Advanced MathUtils for implementing features like PvP combo systems and velocity calculations.

πŸ“Š Metrics and Analytics

  • Track plugin usage and server statistics with MetricsManager.
  • Collect data on user behavior to improve your plugin’s performance and features.

πŸ”’ Secure and Reliable

  • Built-in error handling and exception management to ensure that your plugin runs smoothly without interruptions.
  • Event Priority Management to control the order of event handling, ensuring there’s no conflict between multiple plugins.

Installation & Setup πŸ› οΈ

1. Clone the Repository

Clone the repository to your local machine using Git:

git clone https://github.com/CxmboFight/HitChainAPI.git

2. Build the Project

If you're using Maven, simply run:

mvn clean install

If you're using Gradle, run:

gradle build

This will generate the necessary .jar file for your plugin.

3. Install the Plugin on Your Server

  • Place the generated HitChainAPI.jar file in your server's plugin directory.
  • Restart the server to load the plugin.
  • The plugin will automatically create the default configuration files (config.yml, messages.yml, etc.) in the plugin's folder.

4. Configuration

Edit the config.yml to tailor the plugin to your server's needs. You can customize a wide variety of settings, from message formatting to data storage preferences.

Example Code πŸ“

Here’s a simple example of how you can use HitChainAPI in your plugin:

public class MyPlugin extends HitChainPlugin {

    @Override
    public void onEnable() {
        // Registering commands
        getCommand("mycommand").setExecutor(new MyCommandExecutor());

        // Handling events
        getServer().getPluginManager().registerEvents(new PlayerListener(), this);

        // Accessing utility classes
        MessageUtil.sendMessage(player, "Welcome to the server!", MessageUtil.MessageType.INFO);
    }
}

For more detailed examples, check out the docs/ folder for setup guides, feature tutorials, and API documentation.

Development Guide πŸ§‘β€πŸ’»

HitChainAPI is built with developers in mind. Whether you're contributing or extending the API, here's how to get started:

1. Clone the Repository

Clone the repository and set up the project in your IDE (IntelliJ IDEA, Eclipse, etc.).

2. Work on Features

  • Start by creating a new feature module in the features/ directory.
  • Use the utils/ for building utility classes and helper methods.
  • Integrate with the api/ package to expose your feature to external developers.

3. Write Tests

  • Place your unit and integration tests in the tests/ directory.
  • Ensure your code passes all tests by running the automated testing suite.

4. Contribute to the Project

  • Submit pull requests for any features, bug fixes, or improvements.
  • Check the Issues tab for open tasks and bugs.

Integration with Other Plugins πŸ”—

HitChainAPI is designed to integrate seamlessly with other popular Minecraft plugins and APIs. Here’s how to connect:

  • Economy Systems: Integrate with economy plugins (like EssentialsX) to add custom features like virtual currencies, transactions, and item shops.
  • Quest Systems: Use the QuestSystemFeature to create complex quest chains that interact with player progression and reward systems.
  • External APIs: Extend the API with third-party plugins or external integrations by implementing custom interfaces in the api/ package.

Documentation πŸ“š

  • API Documentation - Learn how to use the core features of HitChainAPI.
  • Setup Guide - Step-by-step instructions on how to get started with the API and integrate it into your plugins.
  • Feature Docs - Detailed documentation on each feature (PvP, Economy, etc.).
  • Integration Guide - Learn how to integrate with external APIs and plugins.

Contributing 🀝

We welcome contributions to HitChainAPI! If you have an idea for a new feature, bug fix, or improvement, please open an issue or submit a pull request. Before contributing, please ensure that your code passes all unit tests and adheres to the coding standards.

Code of Conduct

Be respectful and professional. We're here to build a strong community of developers.


License πŸ“œ

HitChainAPI is licensed under the MIT License. See the LICENSE file for more information.


Support & Contact πŸ€”

If you need help or have any questions about the API, feel free to open an issue or reach out through the following:


Unleash your creativity with HitChainAPI! πŸ’₯ Create the next-level Minecraft experiences today.

About

HitChainAPI is a high-performance, scalable Minecraft plugin API for version 1.8.9, designed to be modular and easily extendable. It provides advanced utilities for handling commands, events, storage, and more, making it ideal for developers looking to create feature-rich and efficient plugins.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages