Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

yggdrasil

1.3.0 • Public • Published

yggdrasil

NPM Link Build Status

A Node.js client for doing requests to yggdrasil, the Mojang authentication system, used for Minecraft and Scrolls. There's already one other client out there (at the time of writing) but I don't like it, so I wrote this one.

node-yggdrasil was originally made because I was messing around with trying to make a Minecraft server in JS. Never really got anywhere with it. However, the folks over at PrismarineJS have gotten quite far with it, and use this library in their project.

Usage

$ npm install yggdrasil

Client

//init
const ygg = require('yggdrasil')({
  //Optional settings object
  host: 'https://authserver.mojang.com' //Optional custom host. No trailing slash.
});
 
//Authenticate a user
ygg.auth({
  token: '', //Optional. Client token.
  agent: '', //Agent name. Defaults to 'Minecraft'
  version: 1, //Agent version. Defaults to 1
  user: '', //Username
  pass: '' //Password
}, function(err, data){});
 
//Refresh an accessToken
ygg.refresh(oldtoken, clienttoken, function(err, newtoken, response body){});
 
//Validate an accessToken
ygg.validate(token, function(err){});
 
//Invalidate all accessTokens
ygg.signout(username, password, function(err));

Server

const yggserver = require('yggdrasil').server({
  //Optional settings object
  host: 'https://authserver.mojang.com' //Optional custom host. No trailing slash.
});
 
//Join a server (clientside)
yggserver.join(token, profile, serverid, sharedsecret, serverkey, function(err, response body){});
 
//Join a server (serverside)
yggserver.hasJoined(username, serverid, sharedsecret, serverkey, function(err, client info){});

Proxy Support

const ProxyAgent = require('proxy-agent');
 
const ygg = require('yggdrasil')({
  //Any type of HTTP Agent 
  agent: new ProxyAgent('https://example.com:8080')
});

With ES6 Named Exports

/**
 * Import Client or Server from 'yggdrasil/es6'.
 * Note that the library is stateless when imported this way vs the CommonJS way.
 */
import { Client as ygg, Server as yggServ } from 'yggdrasil/es6'
 
// Use it like you normally would.
 
ygg.validate(token, function(err){})
 
yggServ.join(token, profile, serverid, sharedsecret, serverkey, function(err, response body){});

Further Reading

Install

npm i yggdrasil

DownloadsWeekly Downloads

1,229

Version

1.3.0

License

MIT

Unpacked Size

19.6 kB

Total Files

12

Last publish

Collaborators

  • avatar