<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>Tag</version>
</dependency>

<!-- library-lite module includes only api and runnable plugin-->
<dependency>
<groupId>com.github.timsixth.MinigameAPI</groupId>
<artifactId>library-lite</artifactId>
<version>Tag</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>Tag</version>
</dependency>

 

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

//includes all modules
implementation 'com.github.timsixth:MinigameAPI:Tag'

//includes only library, api, and addons-api modules
implementation 'com.github.timsixth.MinigameAPI:library:Tag'

//includes only api module
implementation 'com.github.timsixth.MinigameAPI:api:Tag'
}
 

public class MyPluginConfigurator extends DefaultPluginConfigurator {

    @Override
    public PluginConfiguration configure ( ) {
        return PluginConfiguration. builder ( )
                . tablesPrefix ( "thetag_" )
                . useDataBase ( true )
                . arenaSaveType (ArenaSaveType. SINGLE_FILE )
                . useDefaultStatsSystem ( true )
                . build ( ) ;
    }
}

Object save ( ) ; //Saves new model to database or file
boolean delete ( ) ; //Deletes model from file or table
Object update ( ) ; //Updates new model to database or file

//For example
User user = new User ( ) ;
user. save ( ) ;
 

ArenaFactory arenaFactory = MiniGame. getArenaFactory ( )
Arena arena = arenaFactory. createArena ( "arenaName", player. getLocation ( ), new HashMap <> ( ) ) ;

//or
Arena arena = arenaFactory. createArena ( "arenaName", player. getLocation ( ) ) ;
 

void addLocation (name, location ) ; //Adds new location
Map < String, Location > getLocations ( ) ; //Gets map of locations
void removeLocation (name ) ; //Removes location from map
Location getLocationByName (name ) //Gets location by name
Optional <Location > getLocation (name ) ; //Gets location by name
 

Arena getArena ( ) ; //Gets arena which is using to play this game
List <UserGame > getPlayingUsers ( ) ; //Gets list of game users
GameState getState ( ) ; //Gets current game state
void setState (GameState gameState ) ; //Sets new game state
Optional <UserGame > getUserGame (UUID uuid ) ; //Gets UserGame by player's uuid
void sendMessage ( String message ) ; //Sends message to everyone who is playing on this game
int getRounds ( ) ; //Gets rounds amount
void setRounds ( int rounds ) ; //Sets rounds amount
void addRound ( ) ; //Adds one round to rounds
List <Team > getTeams ( ) ; //Gets list of teams
Optional <Team > getTeamByName ( String name ) ; //Gets team by name
Optional <Team > getTeamByPlayer (Player player ) ; //Gets team by player
void addUserGame (UserGame userGame ) ; //Adds a player to playing users
void removeUserGame (UserGame userGame ) ; //Removes a player from playing users
UserGame createUserGame (UUID playerUUID ) //Creates new user game
Team createTeam ( String name, String displayName, ChatColor color ) //Creates new team
runState ( ) //Runes current game state
void addRecoverableUserGame (RecoverableUserGame recoverableUserGame ) ; //Added new recoverableUserGame
void removeRecoverableUserGame (RecoverableUserGame recoverableUserGame ) ; //Removes recoverableUserGame
Optional <RecoverableUserGame > getRecoverableUserGame (UUID playerUuid ) ; //Gets user by uuid
List <RecoverableUserGame > getRecoverableUserGames ( ) ; //Gets list of RecoverableUserGames
void hidePlayers (UserGame user ) //Hides all online players for user who is playing in the game
void showPlayers (UserGame user ) // Show all online players for user who is playing in the game
 

Game game = new GameImpl (arena ) ; //creates new game instance

UserGame userGame = game. createUserGame (player. getUniqueId ( ) ) ;

//create the first player who joined this game

game. addUserGame (userGame ) ; //adds this player to list
gameManager. addGame (game ) ; //adds this game to list
 

game. setState ( new MyState ( ) ) ;

public class MyGameState implements GameState {

  @Override
  public void run ( ) {
      //define your logic
    }
}
 

UserCoinsFactory userCoinsFactory = MiniGame. getUserCoinsFactory ( ) ;

UserCoins userCoins   = userCoinsFactory. createUserCoins (player. getUniqueId ( ) ) ;

//or with default coins

UserCoins userCoins = userCoinsFactory. createUserCoins (player. getUniqueId ( ), 100.0 ) ;
 

double getCoins ( ) ; //Gets coins
void setCoins ( double coins ) ; //Sets coins
void addCoins ( double coins ) ; //Adds coins
void removeCoins ( double coins ) ; //Removes coins
boolean hasCoins ( double coins ) ; //Chceks when player has coins
 

userCoins. getCoins ( ) ;
userCoins. setCoins ( 100.1 ) ;
 

builder. useDefaultStatsSystem ( true )

UserStats userStats = statisticsManager. getUserStatsOrCreate (player, arena ) ;
userStats. addWin ( ) ;
 

public class MyCosmetic implements Cosmetic {

@Override
public String getName ( ) {
return "MY_COSEMTIC_NAME"
}

@Override
public void show (Player player ) {
    //your logic
  }
}
 

getCosmeticsManager ( ). addCosmetic ( new MyCosmetic ( ) ) ;

getCosmeticsManager ( ). addCosmetics ( new MyCosmetic ( ), new MyParticleCosmetic ( ) ) ;

getCosmeticsManager ( ). removeCosmetic ( new MyCosmetic ( ) ) ;