torchflower-auth
TypeScript icon, indicating that this package has built-in type declarations

2.4.1 • Public • Published

THIS IS MODIFIED TO FIT THE NEEDS OF TORCHFLOWER, PLEASE USE PRISMARINE-AUTH INSTEAD

prismarine-auth

NPM version Build Status Discord Try it on gitpod

Quickly and easily obtain auth tokens to authenticate with Microsoft/Xbox/Minecraft/Mojang

Installation

npm install prismarine-auth

Usage

Authflow

Parameters

  • username? {String} - Username for authentication
  • cacheDirectory? {String | Function} - Where we will store your tokens (optional) or a factory function that returns a cache.
  • options {Object?}
    • [flow] {enum} Required if options is specified - see API.md for options
    • [password] {string} - If passed we will do password based authentication.
    • [authTitle] {string} - See the API.md
    • [deviceType] {string} - See the API.md
  • onMsaCode {Function} - (For device code auth) What we should do when we get the code. Useful for passing the code to another function.

View more examples

Examples

getMsaToken

const { Authflow, Titles } = require('prismarine-auth')

const userIdentifier = 'unique identifier for caching'
const cacheDir = './' // You can leave this as undefined unless you want to specify a caching directory
const flow = new Authflow(userIdentifier, cacheDir)
// Get a auth token, then log it
flow.getMsaToken().then(console.log)

getXboxToken

See docs/API.md

getMinecraftJavaToken

const { Authflow, Titles } = require('prismarine-auth')

const userIdentifier = 'any unique identifier'
const cacheDir = './' // You can leave this as undefined unless you want to specify a caching directory
const flow = new Authflow(userIdentifier, cacheDir)
// Get a Minecraft Java Edition auth token, then log it
flow.getMinecraftJavaToken().then(console.log)

Expected Response

{
    "token": "ey....................",
    "entitlements": {},
    "profile": {
        "id": "b945b6ed99b548675309473a69661b9a",
        "name": "Usname",
        "skins": [ [Object] ],
        "capes": []
    }
}

getMinecraftBedrockToken

See docs/API.md and example.

API

See docs/API.md

Debugging

You can enable some debugging output using the DEBUG enviroment variable. Through node.js, you can add process.env.DEBUG = 'prismarine-auth' at the top of your code.

Testing

Simply run npm test or yarn test

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i torchflower-auth

Weekly Downloads

1

Version

2.4.1

License

MIT

Unpacked Size

75.2 kB

Total Files

36

Last publish

Collaborators

  • antspa767