⚙️
T-MiniGameAPI
WebsiteDiscord
2.0.0
2.0.0
  • 🏠Home
  • 💻Maven and Gradle
  • 📦Minigame setup
  • 🖱️Plugins are using this libarary
  • Basic features
    • 🗺️Configuration
      • 🎯Configurators
      • 🔴Override Configuartors
    • 🧑Models
      • 📦File model
        • 🟢Single file
        • 🟠Many files
      • 🧑‍🦱Users
    • 📔Loaders
      • 📗Loader
        • 📂File loader
  • Minigame features
    • 🅰️Arena system
      • 🟢Arena
      • 🔵ArenaManager
    • 🎮Game system
      • 🔴Game Manager
      • 🔵Game State
      • 🟡Users in game
      • 🟢Teams
    • ⏰Timers
      • 😀SimpleTimer
      • ✨XpTimer
    • 🪙Coins system
      • 🟢UserCoins
      • 🔵UserCoinsManager
    • ✨Statistics system
      • 🟢Default statistics system
      • 🔵Your own statistics system
    • 💥Cosmetics system
      • 📀Cosmetic
        • 💕ParticleCosmetic
      • ✳️Cosmetics Manager
      • 🧒Users' cosmetics
        • 💿UserCosmeticsManager
        • ✅UserCosmetics
  • Modules
    • 🔌What is module ?
    • 🗒️Modules list
    • Internal Modules
      • Commands Module
        • 🧔Parent commands
        • 🧒Sub commands
        • 📑Tab completer
        • ®️Command registration
      • SQL Module
        • 💡DbModel
        • SQLDatabaseDao
        • 💾Database loader
        • SQLDatabaseAdapter
        • SQLDatabaseMigrator
      • MongoDB Module
        • MongoDbConnector
        • 💡MongoDbModel
        • MongoDbDao
        • 💾MongoDb loader
    • 💾How to create module?
Powered by GitBook
On this page
  • How to register MongoDB Module?
  • How to define MongoDb Module configurator (Optional but recommended)?
  1. Modules
  2. Internal Modules

MongoDB Module

PreviousSQLDatabaseMigratorNextMongoDbConnector

Last updated 8 months ago

Module must be shaded to your JAR file

{VERSION} - current version form GitHub releases section:

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

<dependency>
   <groupId>com.github.timsixth.MinigameAPI</groupId>
   <artifactId>mongodb-support</artifactId>
   <version>{VERSION}</version>
</dependency>
allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
}
  
 dependencies {
   implementation 'com.github.timsixth.MinigameAPI:mongodb-support:{VERSION}'    
}

How to register MongoDB Module?

//Use MongoDbLibraryConfiguration instend of LibraryConfiguration
    //Type list with MongoDbModule
    @Override
    protected LibraryConfiguration configure() {
        return new MongoDbLibraryConfiguration(this, getConfiguratorsInitializer())
                .builder()
                .setGameManager(new MyGameManager())
                .registerModules(new MongoDbModule())
                .build();
    }

with custom MongoDb module configuration (Optional but recommended)

    @Override
    protected LibraryConfiguration configure() {
        return new MongoDbLibraryConfiguration(this, getConfiguratorsInitializer())
                .builder()
                .setGameManager(new MyGameManager())
                .registerModules(new MongoDbModule(new MyMongoDbModuleConfigurator().configure()))
                .build();
    }

How to define MongoDb Module configurator (Optional but recommended)?

public class MyMongoDbModuleConfigurator extends DefaultMongoDbModuleConfigurator {

   @Override
    public MongoDbModuleConfiguration configure() {
        return MongoDbModuleConfiguration.builder()
                .mongoDbUri("mongodb://localhost:27017") //you can change this
                .databaseName("minigameapi") //you can change this
                .build();
    }
}

MongoDB module methods:

MongoDbModule mongoDbModule = MongoDbModule.getInstance(); //Gets instance of module

mongoDbModule.getMongoDbConnector(); //Gets MongoDbConnector

https://github.com/timsixth/MinigameAPI/releases