v4 • minecraft‐java‐core

Getting support

Installing

npm i minecraft-java-core
# or
yarn add minecraft-java-core

Standard Example (ESM)

const { Launch, Microsoft } = require('minecraft-java-core');
const launcher = new Launch();
const fs = require('fs');
let mc
(async () => {
 if (!fs.existsSync('./account.json')) {
 mc = await new Microsoft().getAuth();
 fs.writeFileSync('./account.json', JSON.stringify(mc, null, 4));
 } else {
 mc = JSON.parse(fs.readFileSync('./account.json'));
 if (!mc.refresh_token) {
 mc = await new Microsoft().getAuth();
 fs.writeFileSync('./account.json', JSON.stringify(mc, null, 4));
 } else {
 mc = await new Microsoft().refresh(mc);
 fs.writeFileSync('./account.json', JSON.stringify(mc, null, 4));
 if (mc.error) process.exit(1);
 }
 }
 const opt = {
 url: "https://luuxcraft.fr/api/user/48c74227-13d1-48d6-931b-0f12b73da340/instance",
 path: './minecraft',
 authenticator: mc,
 version: '1.8.9',
 intelEnabledMac: true,
 instance: "Hypixel",
 ignored: [
 "config",
 "logs",
 "resourcepacks",
 "options.txt",
 "optionsof.txt"
 ],
 loader: {
 type: 'forge',
 build: 'latest',
 enable: true
 },
 memory: {
 min: '14G',
 max: '16G'
 },
 };
 launcher.Launch(opt);
 launcher.on('progress', (progress, size) => console.log(`[DL] ${((progress / size) * 100).toFixed(2)}%`));
 launcher.on('patch', pacth => process.stdout.write(pacth));
 launcher.on('data', line => process.stdout.write(line));
 launcher.on('error', err => console.error(err));
})();

Documentation

Launch class

LaunchOptions

Default configuration

const defaultOptions = {
 url: null, // Optional custom manifest URL
 authenticator: null, // Microsoft/Mojang/AZauth profile
 timeout: 10000, // Network timeout in ms
 path: '.Minecraft', // Root directory (alias: root)
 version: 'latest_release', // Minecraft version (string or 'latest_...')
 instance: null, // Multi‐instance name (optional)
 detached: false, // Detach Java process from parent
 intelEnabledMac: false, // Rosetta toggle for Apple Silicon
 downloadFileMultiple: 5, // Parallel downloads
 loader: {
 path: './loader', // Where to install loaders
 type: null, // forge | neoforge | fabric | ...
 build: 'latest', // Build number / tag
 enable: false, // Whether to install the loader
 },
 mcp: null, // Path to MCP config (legacy mods)
 verify: false, // SHA‐1 check after download
 ignored: [], // Files to skip verification
 JVM_ARGS: [], // Extra JVM arguments
 GAME_ARGS: [], // Extra game arguments
 java: {
 path: null, // Custom JVM path
 version: null, // Explicit Java version
 type: 'jre', // jre | jdk
 },
 screen: {
 width: null,
 height: null,
 fullscreen: false,
 },
 memory: {
 min: '1G',
 max: '2G',
 },
} as const;

Events

Authentication (built‐in)

Utilities

File structure (simplified)

src/
 Authenticator/ Microsoft, Mojang, AZauth flows
 Minecraft/ Version JSON, assets, libraries, args builder
 Minecraft-Loader/ Forge, NeoForge, Fabric, Quilt, ... installers
 StatusServer/ Server ping implementation
 utils/ Downloader & helpers
 Launch.ts Main entry point
assets/ LWJGL native indexes

Contributors

License