VRChaKt

VRChat Web API wrapper for Kotlin.

License

License

MIT
GroupId

GroupId

jp.nephy
ArtifactId

ArtifactId

vrchakt
Last Version

Last Version

2.0.4
Release Date

Release Date

Type

Type

jar
Description

Description

VRChaKt
VRChat Web API wrapper for Kotlin.
Project URL

Project URL

https://github.com/NephyProject/VRChaKt
Source Code Management

Source Code Management

https://github.com/NephyProject/VRChaKt

Download vrchakt

How to add to project

<!-- https://jarcasting.com/artifacts/jp.nephy/vrchakt/ -->
<dependency>
    <groupId>jp.nephy</groupId>
    <artifactId>vrchakt</artifactId>
    <version>2.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/jp.nephy/vrchakt/
implementation 'jp.nephy:vrchakt:2.0.4'
// https://jarcasting.com/artifacts/jp.nephy/vrchakt/
implementation ("jp.nephy:vrchakt:2.0.4")
'jp.nephy:vrchakt:jar:2.0.4'
<dependency org="jp.nephy" name="vrchakt" rev="2.0.4">
  <artifact name="vrchakt" type="jar" />
</dependency>
@Grapes(
@Grab(group='jp.nephy', module='vrchakt', version='2.0.4')
)
libraryDependencies += "jp.nephy" % "vrchakt" % "2.0.4"
[jp.nephy/vrchakt "2.0.4"]

Dependencies

compile (4)

Group / Artifact Type Version
org.jetbrains.kotlin : kotlin-stdlib-jdk8 jar 1.3.31
io.ktor : ktor-client-core-jvm jar 1.2.0
jp.nephy : jsonkt jar 4.10
io.github.microutils : kotlin-logging jar 1.6.26

test (7)

Group / Artifact Type Version
io.ktor : ktor-client-apache jar 1.2.0
io.ktor : ktor-client-cio jar 1.2.0
io.ktor : ktor-client-jetty jar 1.2.0
io.ktor : ktor-client-okhttp jar 1.2.0
ch.qos.logback : logback-core jar 1.2.3
ch.qos.logback : logback-classic jar 1.2.3
org.fusesource.jansi : jansi jar 1.17.1

Project Modules

There are no modules declared in this project.

VRChaKt

VRChat API wrapper for Kotlin. (WIP)

Feature

  • Null-safety. Lightweight. Fast. Written in Kotlin!
  • Supports both of Blocking (Sync) and Non-blocking (Async) execution.
  • Pre-made json models.
  • Endpoint version switch for future api changes.

TODO

  • Support more endpoints.
  • Documentize / Update README.

Usage

import jp.nephy.vrchakt.VRChaKtClient
import jp.nephy.vrchakt.core.EndpointVersion

fun main(args: Array<String>) {
    VRChaKtClient {
        endpointVersion = EndpointVersion.Release
        userAgent = "TestClient (https://github.com/NephyProject/VRChaKt)"
        authentication {
            user("username", "password")
        }
    }.use {
        // Get The Hub world. (Blocking)
        val world = it.world.show("wrld_b51f016d-1073-4c75-930d-9f44222c7fc3").complete()
        println(world.result.description)
        
        // Get friends list. (Async)
        it.friend.list(offline = true).queue { result ->
            result.forEach { friend ->
                println(friend.displayName)
            }
        }
    }
}

License

This project is provided with MIT License.

Versions

Version
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.0.1
1.0.0