Giter Club home page Giter Club logo

commoncore's Introduction

CommonCore

This repository contains the CommonCore library and plugins as well as the website for CommonCore plugins. You can visit the website at commoncore.jakubvanko.com.

Table of Contents

Introduction

CommonCore is a Bukkit library that provides Minecraft plugins with the most useful functionalities. All plugins developed using CommonCore have a similar configuration structure.

The most important principles of CommonCore plugins are complete flexibility and customizability. Server administrators can use the configuration of CommonCore plugins to specify or change almost every functionality provided by CommonCore plugins.

CommonCore also comes bundled with XSeries that provides developers with additional utilities to simplify plugin creation.

Features

  • Material Convertor
    • Ensures cross-version material compatibility (1.8 - 1.15)
    • Administered by XSeries
  • Sound Convertor
    • Ensures cross-version sound compatibility (1.8 - 1.15)
    • Administered by XSeries
  • Item Builder
    • Implements Builder design pattern to simplify the creation of ItemStacks
  • Config Loader
    • Loads ItemStacks, Recipes and Inventories directly from the configuration
  • Message Manager
    • Creates adaptable strings (abbreviations) and simplifies the process of messaging players
  • Vault Manager
    • Integrates and simplifies the loading and interaction of the Vault plugin API
  • Inventory GUI Simplification
    • Implements an action-like inventory GUI structure
  • Complete Documentation
    • Includes a complete documentation for programmers and also users of CommonCore plugins
  • XSeries
    • Includes XSeries to provide additional utilities for your plugin
  • BStats
    • Includes BStats to provide metrics for your plugin
  • Custom Items and Textures Support
    • Implements experimental support for the 3rd party Custom Items and Textures plugin.

Installation

To use CommonCore library in a plugin, the library's .jar file needs to be downloaded and set as a dependency for the given project. It is also vitally important to include the compressed CommonCore code in the final plugin's .jar file.

Development

The development of CommonCore needs the following dependencies located in the folder named "__external":

  • XSeries - must be EXTRACTED into the compiled artifact
  • Vault - NOT to be included in the compiled artifact
  • Spigot API at least 1.13.2 - NOT to be included in the compiled artifact

Plugins developed using the CommonCore library must extract the CommonCore library into the compiled artifact of the plugin.

Documentation

Documentation and tutorials for programmers and server administrators are to be found on the website of the CommonCore library.

Plugins

Plugins currently using the CommonCore library:

commoncore's People

Contributors

jakubvanko avatar knokko avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.