Skip to content
This repository has been archived by the owner on Oct 11, 2023. It is now read-only.

SlashNephy/Gerolt

Repository files navigation

Gerolt: A toolkit of FINAL FANTASY XIV for Kotlin

Kotlin GitHub release (latest by date) GitHub Workflow Status License Issues Pull Requests

  • Conversion between Eorzea Time & Earth Time.
  • Weather forecasts.

Quick example

fun main() {
    // Gets current Eorzea Time
    val time = EorzeaTime.now()
    
    // Eorzea Time to Earth Time (java.time.Instant)
    val earthTime = time.toEarthTime()
    
    // Eorzea zones enum
    val zone = EorzeaZone.TheLavenderBeds
    
    // Forecasts the weather at The Lavender Beds at [time].
    val weather = time.weather(zone)
}

More examples of Gerolt can be found at Wiki. Please feel free to create new issue if you have any questions.

Setup

We moved the repository to Maven Central.

GitHub release (latest by date)

Gradle Kotlin DSL

We recommend using Gradle Kotlin DSL instead of classic build.gradle.

build.gradle.kts

dependencies {
    implementation("blue.starry:gerolt:$GeroltVersion")
}

License

Gerolt is provided under MIT license.

Copyright (c) 2017-2021 StarryBlueSky.