1.7.0 • Published 3 years ago
yggdrasil v1.7.0
yggdrasil
A Node.js client for doing requests to yggdrasil, the Mojang authentication system, used for Minecraft and Scrolls.
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
requestUser: false //Optional. Request the user object to be included in response
}).then(
(response)=>{},
(error)=>{}
);
//Refresh an accessToken
ygg.refresh(oldAccessToken, clientToken, true).then(
({accessToken, clientToken, user?})=>{},
(error)=>{}
);
// Note that requestUser is an optional parameter. If set to true, it requests the user object from Mojang's authentication servers as well.
//Validate an accessToken
ygg.validate(token).then(
(response)=>{},
(error)=>{}
);
//Invalidate all accessTokens using a current valid accessToken and clientToken.
ygg.invalidate(accessToken, clientToken).then(
(response)=>{},
(error)=>{}
);
//Invalidate all accessTokens
ygg.signout(username, password).then(
(response)=>{},
(error)=>{}
);
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).then(
(response)=>{},
(error)=>{}
);
//Join a server (serverside)
yggserver.hasJoined(username, serverid, sharedsecret, serverkey).then(
(clientInfo)=>{},
(error)=>{}
);
Proxy Support
const ProxyAgent = require('proxy-agent');
const ygg = require('yggdrasil')({
//Any type of HTTP Agent
agent: new ProxyAgent('https://example.com:8080')
});
Further Reading
- Authentication protocol documentation
- node-minecraft-protocol, a Minecraft client and server in Node.js
1.7.0
3 years ago
1.6.1
4 years ago
1.6.0
4 years ago
1.5.2
4 years ago
1.5.1
4 years ago
1.5.0
4 years ago
1.4.0
5 years ago
1.3.0
5 years ago
1.2.0
5 years ago
1.1.1
8 years ago
1.1.0
8 years ago
1.0.0
8 years ago
0.3.0
8 years ago
0.2.0
9 years ago
0.1.0
10 years ago
0.0.4
10 years ago
0.0.3
10 years ago
0.0.2
11 years ago
0.0.1
11 years ago