Quick Start Guide

Welcome to HyWrapper! This guide will help you get started with the library in your preferred language.

1. Get an API Key

First, obtain an API key from Hypixel's Developer Portal.

2. Python Quick Start

Installation

pip install hywrapper

Basic Usage

import asyncio
from hywrapper import HypixelClient

async def main():
    client = HypixelClient(api_key="your-api-key")
    response = await client.get_player("ac29411d-0826-412f-98c0-dd14b334c1fa")

    if response.success:
        print(f"Found player: {response.player.displayname}")

asyncio.run(main())

3. TypeScript Quick Start

Installation

npm install hywrapper-ts

Basic Usage

import { HypixelClient } from 'hywrapper-ts';

async function main() {
    const client = new HypixelClient('your-api-key');
    const response = await client.getPlayer('ac29411d-0826-412f-98c0-dd14b334c1fa');

    if (response.success) {
        console.log(`Found player: ${response.player?.displayname}`);
    }
}

main();

4. Kotlin Quick Start

Dependency (Gradle)

repositories {
    mavenCentral()
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.Joshy3282:HyWrapper:1.0-SNAPSHOT")
}

Basic Usage

import com.joshy.hywrapper.HypixelClient
import kotlinx.coroutines.runBlocking

fun main() = runBlocking {
    val client = HypixelClient(apiKey = "your-api-key")
    val response = client.getPlayer("ac29411d-0826-412f-98c0-dd14b334c1fa")

    if (response.success) {
        println("Found player: ${response.player?.displayname}")
    }
}