Enables seamless interaction with Mojang API, leveraging coroutines for efficient I/O operations. Supports various environments and simplifies API usage through integration with Ktor HTTP client.
This project allows interaction with Mojang API using Kotlin and coroutine.
We have chosen to use Kotlin to simplify our codes, learn the language and take advantage of coroutines for the I/O operations.
Gradle is used to manage dependencies because he's the more friendly with Kotlin.
The project is compiled to :
See Multiplatform documentation
Replace {version} with the latest version number on Maven central.
repositories {
mavenCentral()
}
dependencies {
// for jvm environment
implementation("io.github.universeproject:kotlin-mojang-api-jvm:{version}")
// for js environment
implementation("io.github.universeproject:kotlin-mojang-api-js:{version}")
// for native environment
implementation("io.github.universeproject:kotlin-mojang-api-native:{version}")
}
repositories {
mavenCentral()
}
dependencies {
// for jvm environment
implementation("io.github.universeproject:kotlin-mojang-api-jvm:{version}")
// for js environment
implementation("io.github.universeproject:kotlin-mojang-api-js:{version}")
// for native environment
implementation("io.github.universeproject:kotlin-mojang-api-native:{version}")
}
The Mojang API Implementation allows you to easily interact with API. You just need to define a Http client from Ktor.
import io.ktor.client.*
io.ktor.client.engine.cio.*
io.ktor.client.plugins.contentnegotiation.*
io.ktor.serialization.kotlinx.json.*
kotlinx.serialization.json.Json
io.github.universeproject.kotlinmojangapi.MojangAPI
io.github.universeproject.kotlinmojangapi.MojangAPIImpl
{
json = Json {
ignoreUnknownKeys =
}
httpClient = HttpClient(CIO) {
install(ContentNegotiation) {
json(json)
}
}
mojangApi: MojangAPI = MojangAPIImpl(httpClient)
println(mojangApi.getUUID())
}
This section is dedicated to the maintainers of the project.
To build the project, you need to use the gradle app (gradlew.bat for windows
and gradlew for linux).
gradlew is a wrapper to run gradle command without install it on your computer.
gradlew build
The tests are created using Kotlin test. To simplify the conception of tests, some common tests are placed in JVM test module.
gradlew allTests
When you make change on the projet, you need to create a release of the main branch.
Firstly, you need to create a specific tag version.
A gradle plugin is used to simplify this operation. Basically, you can check the official documentation, but you only need to make this following commands.
To keep coherence, you need to check the last version release for the project.
gradle release -Prelease.useAutomaticVersion=true -Prelease.releaseVersion=<version to release>
For example, if the latest version is 1.2.1, you can create the next release tag using :
# Patch release
gradle release -Prelease.useAutomaticVersion=true -Prelease.releaseVersion=1.2.2 -Prelease.newVersion=1.2.3-SNAPSHOT
# Minor release
gradle release -Prelease.useAutomaticVersion=true -Prelease.releaseVersion=1.3.0 -Prelease.newVersion=1.3.1-SNAPSHOT
# Major release
gradle release -Prelease.useAutomaticVersion=true -Prelease.releaseVersion=2.0.0 -Prelease.newVersion=2.0.1-SNAPSHOT
For the convention, you can check this link.
After these commands, several commits has been made on main branch and a new tag was created.
At this moment, no artifact is published in repository.
If you need new credentials to publish in repository, you need to follow this tutorial :
To publish the artifacts, you need to create a release on the GitHub repository. When you create your release, select your created tag and explain all changes.
When the release is published, automatically, the CI/CD will try to create and publish in the artifact repository.
The CI/CD uses GitHub Secret to publish in artifact repository, so you may need to replace the current secret of the GitHub repository.
If, for X reason, you want to publish the artifact yourself, you need to define several environment variable using by gradle script :
# Export your private key in the file privatekey.key
# replace <keyid> by you gpg key id
gpg --export-secret-keys -a <keyid> > privatekey.key
After defining the variables, you can run one the following commands :
Manual close action allows to verify in the Sonatype staging repository if all files are correctly published.
gradle publishToSentry
You can check if the artifact is correctly in Sonatype staging repository.
If he's present, you can close to trigger the check by repository and if all is good, you can release to publish the artifact in production.
This following command allows to publish, close instantly the artifact to trigger checks and finally release it.
gradle publishToSonatype closeAndReleaseSonatypeStagingRepository
Surfaced from shared tags and platforms — no rankings paid for.
<dependencies>
<!-- for jvm environment -->
<dependency>
<groupId>io.github.universeproject</groupId>
<artifactId>kotlin-mojang-api-jvm</artifactId>
<version>{version}</version>
</dependency>
<!-- for js environment -->
<dependency>
<groupId>io.github.universeproject</groupId>
<artifactId>kotlin-mojang-api-js</artifactId>
<version>{version}</version>
</dependency>
<!-- for native environment -->
<dependency>
<groupId>io.github.universeproject</groupId>
<artifactId>kotlin-mojang-api-native</artifactId>
<version>{version}</version>
</dependency>
</dependencies>