msmc

v5.0.5

Published

8 months ago

A bare bones login library for Minecraft based projects to authenticate individuals with a Microsoft account.

Downloads

257

0High
0Medium
0Low

matix_media

hanro50

msmc microsoft oauth2 minecraft login mc es6 commonjs

MSMC

A bare bones login library for Minecraft based projects to authenticate individuals with a Microsoft account.

Support

Examples

A basic ES6 example with MCLC

import { Client } from "minecraft-launcher-core";
const launcher = new Client();
//Import the Auth class
import { Auth } from "msmc";
//Create a new Auth manager
const authManager = new Auth("select_account");
//Launch using the 'raw' gui framework (can be 'electron' or 'nwjs')
const xboxManager = await authManager.launch("raw");
//Generate the Minecraft login token
const token = await xboxManager.getMinecraft();
// Pulled from the Minecraft Launcher core docs.
let opts = {
  clientPackage: null,
  // Simply call this function to convert the msmc minecraft object into a mclc authorization object
  authorization: token.mclc(),
  root: "./.minecraft",
  version: {
    number: "1.18.2",
    type: "release",
  },
  memory: {
    max: "6G",
    min: "4G",
  },
};
console.log("Starting!");
launcher.launch(opts);

launcher.on("debug", (e) => console.log(e));
launcher.on("data", (e) => console.log(e));

A basic commonJS example with MCLC

const { Client } = require("minecraft-launcher-core");
const launcher = new Client();
//Import the Auth class
const { Auth } = require("msmc");
//Create a new Auth manager
const authManager = new Auth("select_account");
//Launch using the 'raw' gui framework (can be 'electron' or 'nwjs')
authManager.launch("raw").then(async (xboxManager) => {
  //Generate the Minecraft login token
  const token = await xboxManager.getMinecraft();
  // Pulled from the Minecraft Launcher core docs.
  let opts = {
    clientPackage: null,
    // Simply call this function to convert the msmc Minecraft object into a mclc authorization object
    authorization: token.mclc(),
    root: "./.minecraft",
    version: {
      number: "1.18.2",
      type: "release",
    },
    memory: {
      max: "6G",
      min: "4G",
    },
  };
  console.log("Starting!");
  launcher.launch(opts);

  launcher.on("debug", (e) => console.log(e));
  launcher.on("data", (e) => console.log(e));
});

A basic commonJS example with GMLL

const gmll = require("gmll");
//Import the Auth class
const { Auth } = require("msmc");

gmll.init().then(async () => {
  //Create a new Auth manager
  const authManager = new Auth("select_account");
  //Launch using the 'raw' gui framework (can be 'electron' or 'nwjs')
  const xboxManager = await authManager.launch("raw");
  //Generate the Minecraft login token
  const token = await xboxManager.getMinecraft();

  var int = new gmll.instance();
  //Launch with the gmll token
  int.launch(token.gmll());
});

A basic ES6 example with GMLL

import { init, instance } from "gmll";
//Import the Auth class
import { Auth } from "msmc";

await init();
//Create a new Auth manager
const authManager = new Auth("select_account");
//Launch using the 'raw' gui framework (can be 'electron' or 'nwjs')
const xboxManager = await authManager.launch("raw");
//Generate the Minecraft login token
const token = await xboxManager.getMinecraft();

var int = new instance();
//Launch with the gmll token
int.launch(token.gmll());

Modules

Auth

This module is the starting point of msmc. It will be the first msmc object you create. It is also the object that'll handle all of msmc's events for you. Mainly the load event.

class Auth extends EventEmitter {
  token: MStoken;
  constructor(prompt?: prompt);
  constructor(token: MStoken);
  createLink(): string;
  login(code: string): Promise<Xbox>;
  refresh(MS: msAuthToken): Promise<Xbox>;
  refresh(refreshToken: string): Promise<Xbox>;
  launch(
    framework: framework,
    windowProperties?: windowProperties,
  ): Promise<Xbox>;
  server(port?: number): Promise<void>;

  on(event: "load", listener: (asset: lexcodes, message: string) => void): this;
  once(
    event: "load",
    listener: (asset: lexcodes, message: string) => void,
  ): this;
}

constructor(prompt?: prompt)
This version of the constructor will generate an Auth object with the vanilla Minecraft launcher token. The prompt variable is a string that provides the prompt field in the vanilla token as that is not provided by default.

type prompt = "login" | "none" | "consent" | "select_account";

To learn more about the prompt type, check out Microsoft's support page. It will provide more details for the possible value of this field.

constructor(token: MStoken) <advanced>
This version of the constructor is for use with custom Microsoft tokens.

interface MStoken {
  client_id: string;
  redirect: string;
  clientSecret?: string;
  prompt?: prompt;
}

The Oauth2 token details needed for you to log people in with Microsoft's service.

Resources:

https://docs.microsoft.com/en-us/graph/auth-register-app-v2
https://docs.microsoft.com/en-us/graph/auth-v2-user#1-register-your-app
https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps
createLink(): string <advance>
Creates a login link using the given Token. Can be used if you're forgoing msmc's default gui based login flow for something custom. In essence you should use this link as a redirect, then capture the returning code url-parameter and feed it into the login function
login(code: string): Promise<Xbox> <advance>
The low level login function msmc uses. The returning promise is for the next stage in the login chain. Mainly the Xbox module. I'd refer you to the next module to learn more!