HeliosLauncher/README.md

213 lines
7.3 KiB
Markdown
Raw Normal View History

2024-02-08 23:41:10 -08:00
<p align="center"><img src="./app/assets/images/Icon.png" width="150px" height="150px" alt="aventium softworks"></p>
2017-05-16 23:26:46 -07:00
<h1 align="center">MRS Launcher</h1>
2017-05-16 23:26:46 -07:00
2024-02-11 23:03:22 -08:00
<h3 align="center"><a href="https://github.com/dscalzi/HeliosLauncher">Forked from Helios Launcher</a></h3>
2019-09-05 13:08:47 -07:00
2024-02-08 23:41:10 -08:00
[<p align="center"><img src="https://img.shields.io/github/actions/workflow/status/peunsu/MRSLauncher/build.yml?branch=master&style=for-the-badge" alt="gh actions">](https://github.com/peunsu/MRSLauncher/actions) [<img src="https://img.shields.io/github/downloads/peunsu/MRSLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/peunsu/MRSLauncher/releases)
2017-05-16 23:26:46 -07:00
[<p align="center"><img src="https://img.shields.io/endpoint?url=https://minecraft-server-status-badge.vercel.app/api/server/mysticred.space?port=25565&logo=curseforge&logoColor=ffffff&label=MRS Server&labelColor=F16436&color=28231d&style=for-the-badge">](https://mysticred.space) [<img src="https://img.shields.io/discord/330997213255827457?style=for-the-badge&logo=discord&logoColor=ffffff&label=Discord&labelColor=6173f4&color=28231d" alt="discord">](https://discord.gg/Z8j6ahF4MJ)
2019-03-05 21:37:31 -08:00
<p align="center">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p>
2017-05-16 23:26:46 -07:00
2024-02-08 23:41:10 -08:00
![Screenshot 1](https://i.imgur.com/hL9gCr3.jpg)
![Screenshot 2](https://i.imgur.com/m1yHiM6.jpg)
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
## Features
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
* 🔒 Full account management.
* Add multiple accounts and easily switch between them.
2022-02-11 16:51:28 -08:00
* Microsoft (OAuth 2.0) + Mojang (Yggdrasil) authentication fully supported.
2018-07-22 14:54:35 -07:00
* 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.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
This is not an exhaustive list. Download and install the launcher to gauge all it can do!
2017-05-16 23:26:46 -07:00
2018-08-31 09:42:18 -07:00
#### Need Help? [Check the wiki.][wiki]
2018-07-22 14:54:35 -07:00
#### Like the project? Leave a ⭐ star on the repository!
2018-07-22 14:54:35 -07:00
## Downloads
2024-02-08 23:41:10 -08:00
You can download from [GitHub Releases](https://github.com/peunsu/MRSLauncher/releases)
2018-07-22 14:54:35 -07:00
2018-08-31 09:42:18 -07:00
#### Latest Release
2018-08-08 19:37:37 -07:00
2024-02-11 23:00:52 -08:00
[![](https://img.shields.io/github/v/release/peunsu/MRSLauncher?style=flat-square)](https://github.com/peunsu/MRSLauncher/releases/latest)
2018-07-22 14:54:35 -07:00
2018-08-31 09:42:18 -07:00
#### Latest Pre-Release
2024-02-11 23:00:52 -08:00
[![](https://img.shields.io/github/v/release/peunsu/MRSLauncher?include_prereleases&style=flat-square&label=pre-release)](https://github.com/peunsu/MRSLauncher/releases)
2018-07-22 14:54:35 -07:00
2018-08-08 19:37:37 -07:00
**Supported Platforms**
2024-02-08 23:41:10 -08:00
If you download from the [Releases](https://github.com/peunsu/MRSLauncher/releases) tab, select the installer for your system.
2018-07-22 14:54:35 -07:00
| Platform | File |
| -------- | ---- |
2024-02-08 23:41:10 -08:00
| Windows x64 | `MRS-Launcher-setup-VERSION.exe` |
| ~~macOS x64~~ | ~~`MRS-Launcher-setup-VERSION-x64.dmg`~~ |
| ~~macOS arm64~~ | ~~`MRS-Launcher-setup-VERSION-arm64.dmg`~~ |
2024-02-08 23:41:10 -08:00
| Linux x64 | `MRS-Launcher-setup-VERSION.AppImage` |
2018-07-22 14:54:35 -07:00
## Console
To open the console, use the following keybind.
```console
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..**
2019-09-05 13:08:47 -07:00
![console example](https://i.imgur.com/T5e73jP.png)
2018-07-22 14:54:35 -07:00
## Development
2021-02-01 15:04:52 -08:00
This section details the setup of a basic developmentment environment.
2018-07-22 14:54:35 -07:00
### Getting Started
**System Requirements**
2023-02-12 15:58:06 -08:00
* [Node.js][nodejs] v18
2018-07-22 14:54:35 -07:00
---
**Clone and Install Dependencies**
```console
2024-02-08 23:41:10 -08:00
> git clone https://github.com/peunsu/MRSLauncher.git
> cd MRSLauncher
2018-07-22 14:54:35 -07:00
> npm install
```
---
**Launch Application**
```console
> npm start
2017-05-16 23:26:46 -07:00
```
2018-07-22 14:54:35 -07:00
---
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
**Build Installers**
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
To build for your current platform.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
```console
> npm run dist
2017-05-16 23:26:46 -07:00
```
2018-07-22 14:54:35 -07:00
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
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
All development of the launcher should be done using [Visual Studio Code][vscode].
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
Paste the following into `.vscode/launch.json`
```JSON
2017-05-16 23:26:46 -07:00
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug Main Process",
"type": "node",
"request": "launch",
2020-08-10 14:41:57 -07:00
"cwd": "${workspaceFolder}",
"program": "${workspaceFolder}/node_modules/electron/cli.js",
"args" : ["."],
"outputCapture": "std"
2017-05-16 23:26:46 -07:00
},
{
"name": "Debug Renderer Process",
"type": "chrome",
"request": "launch",
2020-08-10 14:41:57 -07:00
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
2017-05-16 23:26:46 -07:00
"windows": {
2020-08-10 14:41:57 -07:00
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
2017-05-16 23:26:46 -07:00
},
"runtimeArgs": [
2020-08-10 14:41:57 -07:00
"${workspaceFolder}/.",
2017-05-16 23:26:46 -07:00
"--remote-debugging-port=9222"
],
2020-08-10 14:41:57 -07:00
"webRoot": "${workspaceFolder}"
2017-05-16 23:26:46 -07:00
}
]
}
```
2018-07-22 14:54:35 -07:00
This adds two debug configurations.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
#### Debug Main Process
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
This allows you to debug Electron's [main process][mainprocess]. You can debug scripts in the [renderer process][rendererprocess] by opening the DevTools Window.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
#### Debug Renderer Process
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
This allows you to debug Electron's [renderer process][rendererprocess]. This requires you to install the [Debugger for Chrome][chromedebugger] extension.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
Note that you **cannot** open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.
2017-11-27 13:56:26 -08:00
---
### Note on Third-Party Usage
2021-07-18 21:52:57 -07:00
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.
2022-02-12 07:58:19 -08:00
For instructions on setting up Microsoft Authentication, see https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md.
2022-02-11 16:51:28 -08:00
2018-07-22 14:54:35 -07:00
---
2017-11-27 13:56:26 -08:00
2018-07-22 14:54:35 -07:00
## Resources
2018-08-31 09:42:18 -07:00
* [Wiki][wiki]
* [Nebula (Create Distribution.json)][nebula]
2018-07-22 14:54:35 -07:00
The best way to contact the developers is on Discord.
2017-11-27 13:56:26 -08:00
2019-03-05 21:37:31 -08:00
[![discord](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][discord]
2017-11-27 13:56:26 -08:00
2018-07-22 14:54:35 -07:00
---
2017-05-16 23:26:46 -07:00
2019-03-05 21:40:23 -08:00
### See you ingame.
2017-05-16 23:26:46 -07:00
2018-07-22 14:54:35 -07:00
[nodejs]: https://nodejs.org/en/ 'Node.js'
[vscode]: https://code.visualstudio.com/ 'Visual Studio Code'
[mainprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Main Process'
[rendererprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Renderer Process'
[chromedebugger]: https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome 'Debugger for Chrome'
2019-03-05 21:37:31 -08:00
[discord]: https://discord.gg/zNWUXdt 'Discord'
2019-09-05 13:08:47 -07:00
[wiki]: https://github.com/dscalzi/HeliosLauncher/wiki 'wiki'
[nebula]: https://github.com/dscalzi/Nebula 'dscalzi/Nebula'
[v2branch]: https://github.com/dscalzi/HeliosLauncher/tree/ts-refactor 'v2 branch'