Skip to content

SDLMoe/sdl-commons

Repository files navigation

sdl-commons

Kotlin Gradle License GitHub Workflow Status

SDL's common libraries for Kotlin development.

This library requires Java 17+ and Kotlin 1.9+.

Usage

Maven Central

Edit build.gradle.kts like so, replace <latest-version> with the latest version (see the badge above):

dependencies {
  // BOM for aligning versions to prevent potential problems
  implementation(platform("moe.sdl.commons:commons-bom:<latest-version>"))
  //             ^ this is important, please don't forget to call
  // see: https://docs.gradle.org/current/userguide/platforms.html

  // Add a certain module, see modules below 
  implementation("moe.sdl.commons:commons-event")

  // Or simply, add all modules as dependencies
  implementation(platform("moe.sdl.commons:commons-all"))
}

Modules

Module Description
commons-bom Special module, BOM, apply version constraints
commons-all Special module, add all modules as dependencies
commons-coroutines Extensions of kotlinx.coroutines, e.g. ModuleScope
commons-event Event System and State Machine based on kotlinx.coroutines
commons-logger-logback Extensions of Logback, e.g. PatternLayoutNoLambda

License

Licensed under Apache License, Version 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this library by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.