Skip to content

xFedeT/MinigamesAPI

Repository files navigation

MinigamesAPI (IN DEVELOPMENT)

Build Status Code Climate Visitors

A Minigame Plugin/API core that allow to create custom Minigame

  • Simple to use
  • Lightweight
  • Flexible
  • Null-safe
  • Better performance
  • Better optimization

How it works

Integration

Start using MinigamesAPI by adding this to your pom.xml:

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

<dependencies>
    <dependency>
        <groupId>com.github.xFedeT</groupId>
        <artifactId>MinigamesAPI</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

or build.gradle:

  repositories {
    maven { url 'https://jitpack.io' }
  }

  dependencies {
    implementation 'com.github.xFedeT:MinigamesAPI:VERSION'
  }

Getting Started

Getting MinigamesAPI in you project

public class YourPlugin extends JavaPlugin implements Minigame {
    @Override
    public void onEnable() {
        minigamesAPI = MinigamesProvider.get();
        minigamesAPI.registerMinigame(this);
    }
}

📝 Read the full documentation in the MinigamesAPI Wiki.

📝 See a full working example based on this here.