https://github.com/electron-minecraft-launcher/eml-lib-v2
Electron Minecraft Launcher Lib (EML Lib) is a Node.js library. It permits to authenticate and download Java and Minecraft.
https://github.com/electron-minecraft-launcher/eml-lib-v2
Last synced: 6 months ago
JSON representation
Electron Minecraft Launcher Lib (EML Lib) is a Node.js library. It permits to authenticate and download Java and Minecraft.
- Host: GitHub
- URL: https://github.com/electron-minecraft-launcher/eml-lib-v2
- Owner: Electron-Minecraft-Launcher
- License: mit
- Created: 2024-06-10T21:37:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-15T17:45:48.000Z (10 months ago)
- Last Synced: 2025-09-21T07:35:14.204Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 166 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.**
[
](https://discord.gg/YVB4k6HzAY)
[
](#platforms)
[
](package.json)
---
## 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](https://nodejs.org/);
- 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](https://github.com/Electron-Minecraft-Launcher/EML-AdminTool-v2) 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 EML AdminTool, you should rather use the [Minecraft Launcher Core](https://npmjs.com/package/minecraft-launcher-core) library.
### EML Lib installation
You need [Node.js](https://nodejs.org) and [Electron](https://electronjs.org).
```bash
# 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](https://github.com/Electron-Minecraft-Launcher/EML-AdminTool-v2):
```js
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 [wiki](https://github.com/Electron-Minecraft-Launcher/EML-Lib-v2/wiki) for more information.
## Platform compatibility
| OS (platform) | Supported? | Minimum version supported |
| -------------------------- | -------------- | -------------------------- |
| Windows (win32) | Yes | Windows 7 (Windows NT 6.1) |
| macOS (Darwin) | Yes | Mac OS X Lion (10.7) |
| Linux, including Chrome OS | Yes | Variable |
| Others | Not officially | - |
> [!WARNING]
> Mac with Apple Silicon (M1, M2, etc.) is supported only for Minecraft 1.19 and above.
> [!WARNING]
> No support will be provided for older versions of Windows, macOS and Linux, or for other operating systems.
## Tests
The library has been tested on:
Minecraft version
OS
Loader
Result
1.21.10
macOS Tahoe 26.1 (M3)
Vanilla
OK
Forge (60.0.12)
OK
1.21.1
Windows 11 (26120.1252)
Vanilla
OK
Forge (52.0.3)
OK
1.19.4
Windows 11 (26120.1252)
Vanilla
OK
Forge (45.3.0)
OK
1.19
macOS Tahoe 26.1 (M3)
Forge (41.1.0)
OK
1.18.2
Windows 11 (26120.961)
Forge (40.2.0)
OK
1.17.1
Windows 11 (26120.1252)
Vanilla
OK
Forge (37.1.1)
OK
1.16.5
Windows 11 (26120.1252)
Vanilla
Warn: Multiplayer not available.
Forge (36.2.34)
1.14.4
Windows 11 (26120.961)
Forge (28.2.26)
OK
1.12.2
Windows 11 (26120.1252)
Vanilla
OK
Forge (14.23.5.2859)
Non-breaking error: Minecraft is unable to read forge.jar from libraries.
1.7.10
Windows 11 (26120.1252)
Vanilla
OK
Forge (10.13.4.1614)
Non-breaking error: SSL certificate error.
1.4.7
Windows 11 (26120.1252)
Vanilla
Non-breaking error: Minecraft tries to fetch non-existing HTTP data.
1.0.0
Windows 11 (26120.1252)
Vanilla
OK
> [!WARNING]
> Forge is currently not working on Minecraft 1.5.2 and below.
## Contributing
### Development
Download the code and run the commands:
```bash
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](https://discord.gg/nfEHKtghPh).
[^1]: Requires [EML AdminTool](https://github.com/Electron-Minecraft-Launcher/EML-AdminTool-v2).