Cauldron Engine
This Documentation is correct for version 0.16.0 of CauldronEngine
What does this do?
Section titled “What does this do?”Cauldron Engine is a Node.js based minecraft launcher. It handles downloading and booting Minecraft Instances. It supports all vanilla versions of minecraft. Additionally, the following loaders are supported:
vanillaforgefabricneoforge
License Information
Section titled “License Information”This project is licensed under GPL 3.0 so please make sure that your project follows the license guidelines.
To Install the package, run the following command
npm i @jackcooperdev/cauldronengineQuick Start
Section titled “Quick Start”const { startGame } = require('@jackcooperdev/cauldronengine/client');
// Installs (if needed) and boots a 1.20.1 Forge clientconst sessionID = await startGame('1.20.1', { type: 'forge' }, authData);See the Client controller for more information.
Using CauldronEngine
Section titled “Using CauldronEngine”Cauldron Engine is split into multiple exports. They are listed below.
Controllers
Section titled “Controllers”| Name | Import | Description |
|---|---|---|
| Client | @jackcooperdev/cauldronengine/client |
Installs and launches a Minecraft Client |
| Manifest | @jackcooperdev/cauldronengine/manifest |
Acquires Relevant Data for install and launch |
| Queue Management | @jackcooperdev/cauldronengine/queue |
Manages Download Queues |
| Name | Import | Description |
|---|---|---|
| Logger | @jackcooperdev/cauldronengine/logger |
Logging |
| Compatibility | @jackcooperdev/cauldronengine/compat |
Tool to Ensure Cross-Platform Compatibility |
| File Tools | @jackcooperdev/cauldronengine/fileTools |
Set of Tools to download / verify files |
| Check Connection | @jackcooperdev/cauldronengine/online |
Checks if Client is Online |
| Launch File Builder | @jackcooperdev/cauldronengine/launchbuild |
Builds launch File |
Environment Variables
Section titled “Environment Variables”| Variable | Description | Default |
|---|---|---|
CAULDRON_PATH |
Root folder used for all installed files. See grabPath | .cauldron in the user’s home / AppData folder |
RESOURCE_SERVER |
Server used to fetch version specs, loader manifests and post processors | https://resources.cauldronmc.com |
Offline Use
Section titled “Offline Use”Versions that have been installed while online can be installed and launched without an internet connection. The engine saves the version manifests and a verified copy of each version’s install data (version.ce) in the Cauldron folder for this.
release and snapshot resolve to the latest versions that were known the last time the engine was online.
If a file is missing while offline, installing fails with:
Version Installation is corrupted! Please Reinstall with a stable internet connection. Issue With: <url>Migrating from 0.6.x
Section titled “Migrating from 0.6.x”Version 0.13.0 reworked the engine around a single install object. The following exports have been removed:
| Removed | Replacement |
|---|---|
launcher (launchGame) |
client (startGame, installGame) |
assets (getAssets) |
Handled by installGame |
jvm (checkJVM, checkCompat) |
Handled by installGame |
libraries (getLibraries) |
Handled by installGame |
session (Session Manager) |
Session IDs are now returned by startGame |
manifest (getManifests, checkManifest, getPackwizJVM) |
getCEObject |
The format of the authentication data passed to the engine has also changed. See Auth Info.
Information
Section titled “Information”For information on how a launcher works, this blog post by Ryan Cao explains it brilliantly. Inside a Minecraft Launcher
Wiki.vg was a great resource that provided lots of information on how various parts of Minecraft works. It has been merged into Minecraft Wiki and can be viewed here
