mirror of https://github.com/dscalzi/HeliosLauncher.git synced 2024-10-31 19:36:39 -07:00

v1.0.0-beta.2

Fixed bug which prevented mods with declared extensions in their identifiers from being loaded.
Synced distribution.json with remote.
Updated electron-builder.
Updated readme to include information on beta testing.

2018-08-15 09:17:59 -04:00

6.5 KiB

Raw Blame History

WesterosCraft Launcher

stark

Join WesterosCraft without worrying about installing Java, Forge, or other mods. We'll handle that for you.

Features

🔒 Full account management.
- Add multiple accounts and easily switch between them.
- Credentials are never stored and transmitted directly to Mojang.
📂 Efficient asset management.
- Receive client updates as soon as we release them.
- Files are validated before launch. Corrupt or incorrect files will be redownloaded.
☕ Automatic Java validation.
- If you have an incompatible version of Java installed, we'll install the right one for you.
- You do not need to have Java installed to run the launcher.
📰 News feed natively built into the launcher.
⚙️ Intuitive settings management, including a Java control panel.
Supports all of our servers.
- Switch between server configurations with ease.
- View the player count of the selected server.
Automatic updates. That's right, the launcher updates itself.
View the status of Mojang's services.

This is not an exhaustive list. Download and install the launcher to gauge all it can do!

Beta Tests

The launcher is currently available for beta testing. For information on beta, and download instructions, please see the Beta Thread.

Downloads

Latest Release

Latest Prerelease

Supported Platforms

Go to the Releases tab and download the installer for the latest release.

Platform	File
Windows x64	`westeroscraftlauncher-setup-VERSION.exe`
macOS	`westeroscraftlauncher-VERSION.dmg`
Linux x64	`westeroscraftlauncher-VERSION-x86_64.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..

Development

Getting Started

System Requirements

Node.js v10.8.0+

Clone and Install Dependencies

> git clone https://github.com/WesterosCraftCode/ElectronLauncher.git
> cd ElectronLauncher
> 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": "${workspaceRoot}",
      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
      "windows": {
        "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd"
      },
      "args": ["."],
      "console": "integratedTerminal",
      "protocol": "inspector"
    },
    {
      "name": "Debug Renderer Process",
      "type": "chrome",
      "request": "launch",
      "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
      "windows": {
        "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd"
      },
      "runtimeArgs": [
        "${workspaceRoot}/.",
        "--remote-debugging-port=9222"
      ],
      "webRoot": "${workspaceRoot}"
    }
  ]
}

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.

Resources

The best way to contact the developers is on Discord.

6.5 KiB Raw Blame History