ModRealms Launcher

Modified from HeliosLauncher

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

Downloads

You can download from GitHub Releases

Development (ModRealms fork)

All ModRealms-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	Helios-Launcher-setup-VERSION.exe
macOS x64	Helios-Launcher-setup-VERSION-x64.dmg
macOS arm64	Helios-Launcher-setup-VERSION-arm64.dmg
Linux x64	Helios-Launcher-setup-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 (ModRealms' 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/ModRealms-Network/ModRealmsLauncher.git
> cd ModRealmsLauncher
> 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}",
      "program": "${workspaceFolder}/node_modules/electron/cli.js",
      "args" : ["."],
      "outputCapture": "std"
    },
    {
      "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

Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much.

For instructions on setting up Microsoft Authentication, see https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md.

---

See you ingame.