README.md

Mystical Machines Launcher

Modified from HeliosLauncher

Join Mystical Machines' servers easily and keep up to date with our packs and fixes!

Downloads

You can download from GitHub Releases

Development (Mystical Machines fork)

All Mystical Machines-specific changes (UI, assets, default configuration, etc..) will be in the master branch.

A development branch mr-features will be used to work on new additions to the core mechanics of the original project (as below) and will keep up to date with the original project. We may submit features from this branch as a PR to the original project.

Latest Release

Coming Soon!

Supported Platforms

If you download from the Releases tab, select the installer for your system.

Platform	File
Windows x64	Mystical-Machines-Launcher-Setup-VERSION.exe
macOS	Mystical-Machines-Launcher-VERSION.dmg
Linux x64	Mystical-Machines-Launcher-VERSION.AppImage

Console

To open the console, use the following keybind.

ctrl + shift + i

Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.

Export Output to a File

If you want to export the console output, simply right click anywhere on the console and click Save as..

Help

For help regarding this version (Mystical Machines' fork), contact the staff on the discord server below:

Original Authors

This project is forked from HeliosLauncher, a project by dscalzi for the server WesterosCraft. Please visit and support their project at the links below!

• Project Link
• Original Project Wiki
• Aventium Softworks Discord

> git clone https://github.com/dscalzi/HeliosLauncher.git
> cd HeliosLauncher
> npm install

---

Launch Application

> npm start

---

Build Installers

To build for your current platform.

> npm run dist

Build for a specific platform.

Platform	Command
Windows x64	npm run dist:win
macOS	npm run dist:mac
Linux x64	npm run dist:linux

Builds for macOS may not work on Windows/Linux and vice-versa.

---

Visual Studio Code

All development of the launcher should be done using Visual Studio Code.

Paste the following into .vscode/launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Debug Main Process",
      "type": "node",
      "request": "launch",
      "cwd": "${workspaceFolder}",
      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
      },
      "args": ["."],
      "console": "integratedTerminal",
      "protocol": "inspector"
    },
    {
      "name": "Debug Renderer Process",
      "type": "chrome",
      "request": "launch",
      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
      },
      "runtimeArgs": [
        "${workspaceFolder}/.",
        "--remote-debugging-port=9222"
      ],
      "webRoot": "${workspaceFolder}"
    }
  ]
}

This adds two debug configurations.

Debug Main Process

This allows you to debug Electron's main process. You can debug scripts in the renderer process by opening the DevTools Window.

Debug Renderer Process

This allows you to debug Electron's renderer process. This requires you to install the Debugger for Chrome extension.

Note that you cannot open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.

---

Note on Third-Party Usage

You may use this software in your own project so long as the following conditions are met.

• Credit is expressly given to the original authors (Daniel Scalzi).
  • Include a link to the original source on the launcher's About page.
  • Credit the authors and provide a link to the original source in any publications or download pages.
• The source code remain public as a fork of this repository.

We reserve the right to update these conditions at any time, please check back periodically.

---

The best way to contact the developers is on Discord.

---

See you ingame.