-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,211 +1,40 @@ | ||
| <p align="center"><img src="./app/assets/images/SealCircle.png" width="150px" height="150px" alt="aventium softworks"></p> | ||
|
|
||
| <h1 align="center">Helios Launcher</h1> | ||
| <h1 align="center">VI Software Launcher</h1> | ||
|
|
||
| <em><h5 align="center">(formerly Electron Launcher)</h5></em> | ||
| <em><h5 align="center">(Basado en el proyecto "dscalzi/HeliosLauncher")</h5></em> | ||
|
|
||
| [<p align="center"><img src="https://img.shields.io/github/actions/workflow/status/dscalzi/HeliosLauncher/build.yml?branch=master&style=for-the-badge" alt="gh actions">](https://github.com/dscalzi/HeliosLauncher/actions) [<img src="https://img.shields.io/github/downloads/dscalzi/HeliosLauncher/total.svg?style=for-the-badge" alt="downloads">](https://github.com/dscalzi/HeliosLauncher/releases) <img src="https://forthebadge.com/images/badges/winter-is-coming.svg" height="28px" alt="winter-is-coming"></p> | ||
| [<p align="center"><img src="https://img.shields.io/github/actions/workflow/status/dscalzi/HeliosLauncher/build.yml?branch=master&style=for-the-badge" alt="gh acciones">](https://github.com/dscalzi/HeliosLauncher/actions) [<img src="https://img.shields.io/github/downloads/dscalzi/HeliosLauncher/total.svg ?style=for-the-badge" alt="descargas">](https://github.com/dscalzi/HeliosLauncher/releases) <img src="https://forthebadge.com/images/badges/winter- se-proxima.svg" height="28px" alt="se-proxima-el-invierno"></p> | ||
|
|
||
| <p align="center">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p> | ||
| <p align="center">Únase a servidores con mods sin preocuparse por instalar Java, Forge u otras modificaciones. Nosotros nos encargaremos de eso por usted.</p> | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## Features | ||
| ## Características | ||
|
|
||
| * 🔒 Full account management. | ||
| * Add multiple accounts and easily switch between them. | ||
| * Microsoft (OAuth 2.0) + Mojang (Yggdrasil) authentication fully supported. | ||
| * 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. | ||
| * 🔒 Gestión completa de cuentas. | ||
| * Agregue varias cuentas y cambie fácilmente entre ellas. | ||
| * Autenticación de Microsoft (OAuth 2.0) + Mojang (Yggdrasil) totalmente compatible. | ||
| * Las credenciales nunca se almacenan ni se transmiten directamente a Mojang. | ||
| * 📂 Gestión eficiente de activos. | ||
| * Reciba actualizaciones de clientes tan pronto como las publiquemos. | ||
| * Los archivos se validan antes del lanzamiento. Se volverán a descargar los archivos corruptos o incorrectos. | ||
| * ☕ **Validación automática de Java.** | ||
| * Si tiene instalada una versión incompatible de Java, instalaremos la correcta *para usted*. | ||
| * No es necesario tener Java instalado para ejecutar el iniciador. | ||
| * 📰 Servicio de noticias integrado de forma nativa en el iniciador. | ||
| * ⚙️ Gestión de configuración intuitiva, incluido un panel de control Java. | ||
| * Soporta todos nuestros servidores. | ||
| * Cambie entre configuraciones de servidor con facilidad. | ||
| * Ver el recuento de jugadores del servidor seleccionado. | ||
| * Actualizaciones automáticas. Así es, el lanzador se actualiza solo. | ||
| * Ver el estado de los servicios de Mojang. | ||
|
|
||
| This is not an exhaustive list. Download and install the launcher to gauge all it can do! | ||
| Esta no es una lista exhaustiva. ¡Descarga e instala el lanzador para evaluar todo lo que puede hacer! | ||
|
|
||
| #### Need Help? [Check the wiki.][wiki] | ||
| #### ¿Necesitas ayuda? [Consulta la wiki.][wiki] | ||
|
|
||
| #### Like the project? Leave a ⭐ star on the repository! | ||
| #### ¿Te gusta el proyecto? ¡Deja una estrella ⭐ en el repositorio! | ||
|
|
||
| ## Downloads | ||
| ## Descargas | ||
|
|
||
| You can download from [GitHub Releases](https://github.com/dscalzi/HeliosLauncher/releases) | ||
|
|
||
| #### Latest Release | ||
|
|
||
| [](https://github.com/dscalzi/HeliosLauncher/releases/latest) | ||
|
|
||
| #### Latest Pre-Release | ||
| [](https://github.com/dscalzi/HeliosLauncher/releases) | ||
|
|
||
| **Supported Platforms** | ||
|
|
||
| If you download from the [Releases](https://github.com/dscalzi/HeliosLauncher/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. | ||
|
|
||
| ```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..** | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Development | ||
|
|
||
| This section details the setup of a basic developmentment environment. | ||
|
|
||
| ### Getting Started | ||
|
|
||
| **System Requirements** | ||
|
|
||
| * [Node.js][nodejs] v18 | ||
|
|
||
| --- | ||
|
|
||
| **Clone and Install Dependencies** | ||
|
|
||
| ```console | ||
| > git clone https://github.com/dscalzi/HeliosLauncher.git | ||
| > cd HeliosLauncher | ||
| > npm install | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| **Launch Application** | ||
|
|
||
| ```console | ||
| > npm start | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| **Build Installers** | ||
|
|
||
| To build for your current platform. | ||
|
|
||
| ```console | ||
| > 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][vscode]. | ||
|
|
||
| Paste the following into `.vscode/launch.json` | ||
|
|
||
| ```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][mainprocess]. You can debug scripts in the [renderer process][rendererprocess] by opening the DevTools Window. | ||
|
|
||
| #### Debug Renderer Process | ||
|
|
||
| This allows you to debug Electron's [renderer process][rendererprocess]. This requires you to install the [Debugger for Chrome][chromedebugger] 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. | ||
|
|
||
| --- | ||
|
|
||
| ## Resources | ||
|
|
||
| * [Wiki][wiki] | ||
| * [Nebula (Create Distribution.json)][nebula] | ||
| * [v2 Rewrite Branch (Inactive)][v2branch] | ||
|
|
||
| The best way to contact the developers is on Discord. | ||
|
|
||
| [][discord] | ||
|
|
||
| --- | ||
|
|
||
| ### See you ingame. | ||
|
|
||
|
|
||
| [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' | ||
| [discord]: https://discord.gg/zNWUXdt 'Discord' | ||
| [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' | ||
| Puede descargar desde [Versiones de GitHub](https://github.com/VI-Software/vis-launcher) |