eml-lib v2.0.0-beta.1

Electron Minecraft Launcher Lib (EML Lib)

Electron Minecraft Launcher Lib (EML Lib) is a Node.js library. It permits to authenticate, download Java and Minecraft and launch Minecraft.

Features

• Authentication: Authenticate users with Microsoft, Azuriom or Crack.
• Minecraft: Automatically download and launch Minecraft (Vanilla and Forge ^1; Fabric, NeoForge, Quilt and MCP are coming soon), and remove unwanted files (such as unwanted mods).
• Java: Automatically download and install Java.
• Bootstraps ^1: Auto-update your launcher.
• Maintenance ^1: Block the launcher during maintenance.
• Server status: Displaying server information (from Minecraft 1.4 to the latest Minecraft version)
• News ^1: Displaying news.
• Background ^1: Displaying a background image.

Installation

Software requirements

• Node.js 15.14.0 or higher: see Node.js;
• Electron 15.0.0 or higher: please install it with npm i electron if you use Microsoft Authentication.

To get all the capacities of this Node.js library, you must set up your EML AdminTool website! Without it, you can only use Minecraft Vanilla, and many features will be disabled (such as News, Bootstrap, etc.).

If you don't want to use the EML AdminTool, you should rather use the Minecraft Launcher Core library.

EML Lib installation

You need Node.js and Electron.

# Using npm
npm i eml-lib

eml-lib package includes TypeScript typings, so you don't need to install @types/eml-lib.

Quick start

Quick start using the EML AdminTool:

const EMLLib = require('eml-lib')

const launcher = new EMLLib.Launcher({
  url: 'https://admintool.electron-minecraft-launcher.com',
  serverId: 'eml',
  account: new EMLLib.CrackAuth().auth('GoldFrite')
})

launcher.launch()

Please refer to the documentation for more information.

Platform compatibility

!WARNING No support will be provided for older versions of Windows, macOS and Linux, or for other operating systems.

Tests

The library have been tested on:

!WARNING Forge is currently not working on Minecraft 1.5.2 and below.

Contributing

Development

Download the code and run the commands:

cd EML-Lib-v2
npm i

Tests

You can submit your tests by creating an issue.

Please indicate the following information in your issue:

• The Minecraft version;
• The operating system the test was performed on (including the version);
• The loader used (Vanilla, Forge, Fabric, etc., including the loader version);
• The result of the test (OK if the test was successful, KO if the test failed, or a detailed explanation if the test was not conclusive and if it breaks the game).

Important information

• This is not an official library from Mojang Studios, Microsoft, Electron or Node.js. Minecraft is a trademark of Mojang Studios.
• This Node.js library is under the MIT license; to get more information, please read the file LICENSE. It is legally obligatory to respect this license.
• If you need some help, you can join this Discord.

^1: Requires the EML AdminTool.