Skip to content

README.md

Latest commit

 

History

History
36 lines (27 loc) · 1.53 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.53 KB

gameapi_banner GitHub release (release name instead of tag name)

The API dedicated for minecraft widely understood game and minigame development, based on Spigot API.

Purpose

Provides all needed tools and functionalities to fully control the game flow and store necessary data. Every element of this API is coded with much care to make it understandable and clear as well as comfortable and easy to use.

Every class will obtain carefully written documentation, by far classes and mechanic themself are under development. The plan for JavaDoc is to implement it with following releases, possibly along with ALPHA ones.

Maven

This API is created with Java 8 and built using Maven. It uses Spigot API 1.8.8.

Repository:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

Dependency:

<dependency>
    <groupId>com.github.TheKaVu</groupId>
    <artifactId>GameAPI</artifactId>
    <version>v0.1.0-RELEASE</version>
</dependency>

Note: This API is in early development state thus depending on it might be risky. Changes are done almost day by day so major incompatibilities must be expected. As any of provided functionality were barely tested right now it is obvious that many bugs and malfunction could encounter.