Cauldron Engine

This Documentation is correct for version 0.6.3 of CauldronEngine

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, there is support for plugins where additional loaders (such as forge) can be booted.

License Information

This project is licensed under GPL 3.0 so please make sure that your project follows the license guidelines.

Setup

To Install the package, run the following command

npm i @jackcooperdev/cauldronengine

Using CauldronEngine

Cauldron Engine is split into multiple exports. They are listed below.

Controllers

| Name | Import | Description | |--------------------------------------------------------------------------|-----------------------------------------------|-----------------------------------------------| | Launcher | @jackcooperdev/cauldronengine/launcher | Manages the launching of a Minecraft Instance | | Manifest | @jackcooperdev/cauldronengine/manifest | Acquires Relevant Data for launch | | Assets | @jackcooperdev/cauldronengine/assets | Manages Asset Download | | JVM | @jackcooperdev/cauldronengine/jvm | Manages JVM Download | | Libraries | @jackcooperdev/cauldronengine/libraries | Manages Library Download | | Queue Management | @jackcooperdev/cauldronengine/queue | Manages Download Queues |

Tools

| Name | Import | Description | |-------------------------------------------------------------------------|-------------------------------------------------|---------------------------------------------| | Logger | @jackcooperdev/cauldronengine/logger | Logging | | Compatability | @jackcooperdev/cauldronengine/compat | Tool to Ensure Cross-Platform Compatability | | File Tools | @jackcooperdev/cauldronengine/fileTools | Set of Tools to download / verify files | | Session Manager | @jackcooperdev/cauldronengine/session | Manages Minecraft Sessions | | Check Connection | @jackcooperdev/cauldronengine/online | Checks if Client is Online | | Launch File Builder | @jackcooperdev/cauldronengine/launchBuild | Builds launch File |

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