Skip to content

Latest commit

 

History

History
104 lines (92 loc) · 3.44 KB

README.md

File metadata and controls

104 lines (92 loc) · 3.44 KB
Raw

MinigameAPI

Flexible, modern and easy to use library to creating minigames in minecraft.
Library works from 1.13.2 to 1.20.x.
Please report every bugs in issues section.

JavaDocs: https://timsixth.pl/javadocs/minigame_api/1.4.0/
Documentation: https://timsixths-plugins.gitbook.io/minigameapi-docs/

Warning

The library requires T-DataBasesAPI on Paper 1.20.6 and newer versions.
https://github.com/timsixth/T-DataBasesAPI/releases

Library features:

  • Arena management system
  • Game management system
  • Countdown to game start (On player level bar or on the player chat)
  • Game cosmetics system
  • Teams in game
  • Advanced loading system from SQL databases (MySQL or SQLite) or YAML files
  • Game statistics system
  • Coins system
  • Simple minigame configuration
  • Integration with T-DataBasesAPI (Thanks to this plugin management of SQL databases is really simple)
  • Simple saving, deleting and updating system (You don't have to write query to database or use YAML spigot API to execute these actions)
  • Commands API (You can create parent commands and subcommands in separate classes)
  • Addons system (You can create addon will works with every mini game which is using this library)

Addons

Getting started

Important

{VERSION} - current version form GitHub releases section:
https://github.com/timsixth/MinigameAPI/releases

Maven

<repositories>
  <repository>
   <id>jitpack.io</id>
   <url>https://jitpack.io</url>
  </repository>
</repositories>
<!-- library module includes addon system, api, addons-api and runnable plugin-->
<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>library</artifactId>
   <version>{VERSION}</version>
</dependency>

<!-- library-lite module includes only api and runnable plugin-->
<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>library-lite</artifactId>
   <version>{VERSION}</version>
</dependency>

<!-- api module includes only api and T-DataBasesAPI (It's recommended to use this module 
to create the minigame)-->
<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>api</artifactId>
   <version>{VERSION}</version>
</dependency>

<!-- addons-api module includes only api and addons-api-->
<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>addons-api</artifactId>
   <version>{VERSION}</version>
</dependency>

<!-- example-minigame module includes example usage of minigame-->
<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>example-minigame</artifactId>
   <version>{VERSION}</version>
</dependency>

Gradle

allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}
  
 dependencies {
   //includes all modules
   implementation 'com.github.timsixth:MinigameAPI:{VERSION}'
   //includes only library, api, and addons-api modules
   implementation 'com.github.timsixth.MinigameAPI:library:{VERSION}'
   //includes only api and library-lite modules
   implementation 'com.github.timsixth.MinigameAPI:library-lite:{VERSION}'   
   //includes only api module
   implementation 'com.github.timsixth.MinigameAPI:api:{VERSION}' 
   //includes only api and addons-api modules
   implementation 'com.github.timsixth.MinigameAPI:addons-api:{VERSION}' 
   //includes example-minigame module
   implementation 'com.github.timsixth.MinigameAPI:example-minigame:{VERSION}' 
}