Neutrino Packing Machine

    @eneris/minecraft-client
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.1 • Public • Published

    Minecraft Client

    NPM

    Usage

    import {MinecraftClient} from '@eneris/minecraft-client';
    
    //Vanilla Minecraft Client
    let client: MinecraftClient = await MinecraftClient.getMinecraftClient("1.15", {
        gameDir: '/home/username/.minecraft'
    });
    
    //Forge Minecraft Client with promoted Version
    let client: MinecraftClient = await MinecraftClient.getForgeClient("1.15", "recommended", {
        gameDir: '/home/username/.minecraft'
    });
    
    //Forge Minecraft Client with custom Version
    let client: MinecraftClient = await MinecraftClient.getForgeClient("1.15", "14.23.4.2709", {
        gameDir: '/home/username/.minecraft'
    });
    
    import {InstallationProgress} from '@eneris/minecraft-client';
    
    //Vanilla Minecraft Client with Progress Callback
    let client: MinecraftClient = await MinecraftClient.getMinecraftClient("1.15", {
        gameDir: '/home/username/.minecraft'
    }, InstallationProgress.callback(currentStep => {
        //Step Callback
    }, progress => {
        //Progress Callback (in %)
    }));

    Valid Forge version types:

    • latest
    • recommended

    Authentication

    import {Authentication} from '@eneris/minecraft-client';
    
    //This is required to download all the Libraries and assets
    await client.checkInstallation();
    
    //Offline Authentication
    client.launch(Authentication.offline("Username"));
    
    //Username/Password Authentication
    client.launch(await Authentication.login("Username (Email)", "Password"));
    
    //Token Authentication
    client.launch(await Authentication.refresh("accessToken"));

    Mods

    import {CurseForgeMod, CustomForgeMod, ForgeMod} from '@eneris/minecraft-client';
    
    //List Mods
    let mods: ForgeMod[] = [
        new CurseForgeMod("Iron Chests", 228756, 2595146),
        new CustomForgeMod("DynmapBlockScan", "http://www.dynmap.us/builds/DynmapBlockScan/DynmapBlockScan-3.0-alpha-1-forge-1.12.2.jar")
    ];
    
    //Install Mods
    client.checkMods(mods);

    Install

    npm i @eneris/minecraft-client

    DownloadsWeekly Downloads

    0

    Version

    3.2.1

    License

    MIT

    Unpacked Size

    127 kB

    Total Files

    48

    Last publish

    Collaborators

    • eneris