drf-api-client
0.2.0indexedEnables interaction with the unofficial Drop Research Facilities API, utilizing Ktor for networking, and supports live message subscription via a flow mechanism.
0
Stars
—
Used by
dependents
—
Health
/ 100
DRF API Client
A Kotlin Multiplatform library for working with the unofficial Drop Research Facilities (DRF) API.
The library is fully written in common Kotlin code. Prebuilt binaries are available for JVM (Java 11 or later), JS, Wasm, and several native targets.1
[!WARNING] This library uses internal APIs that are not officially supported by the DRF developers and may break at any time.
Usage
First, create a DrfApiClient instance to start using the library.
val drfApiClient = DrfApiClient()
This library uses Ktor for networking. By default, a reasonable default will be picked for the underlying engine. However, in some cases, it might be desirable to customize the engine.
This can be achieved by using one of the constructor overloads. For example, the following code explicitly configures the API client to use the CIO engine.
val drfApiClient = DrfApiClient(CIO)
Subscribing to live messages
The subscribe function of the API client can be used to retrieve a "cold" flow
that returns live messages from the DRF API when collected.
val drfApiClient = ...
drfApiClient.subscribe(apiToken = "")
.onEach { println(it) }
.collect()
Supported platforms
The following targets are supported by this library:
Building from source
Setup
This project uses Gradle's toolchain support to detect and select the JDKs required to run the build. Please refer to the build scripts to find out which toolchains are requested.
An installed JDK 17 (or later) is required to use Gradle.
Building
Once the setup is complete, invoke the respective Gradle tasks using the following command on Unix/macOS:
./gradlew <tasks>
or the following command on Windows:
gradlew <tasks>
Important Gradle tasks to remember are:
clean- clean build resultsbuild- assemble and test the projectpublishToMavenLocal- build and install all public artifacts to the local maven repository
Additionally tasks may be used to print a list of all available tasks.
License
Disclaimer
This is an unofficial tool. The author of this library is not associated with ArenaNet nor with any of its partners. Modifying Guild Wars 2 through any third party software is not supported by ArenaNet nor by any of its partners. By using this software, you agree that it is at your own risk and that you assume all responsibility. There is no warranty for using this software.
drf-api-client
Guild Wars 2
© ArenaNet LLC. All rights reserved. NCSOFT, ArenaNet, Guild Wars, Guild Wars 2, GW2, Guild Wars 2: Heart of Thorns, Guild Wars 2: Path of Fire, Guild Wars 2: End of Dragons, and Guild Wars 2: Secrets of the Obscure and all associated logos, designs, and composite marks are trademarks or registered trademarks of NCSOFT Corporation.
As taken from Guild Wars 2 Content Terms of Use on 2024-01-23 00:57 CET.
For further information please refer to LICENSE.
Footnotes
-
We aim to provide prebuilt libraries for all native targets supported by Ktor. Despite that, some targets may be missing as target support may change over time. In case something is missing, please make sure to let us know. ↩