{"id":15014902,"url":"https://github.com/dscalzi/helioslauncher","last_synced_at":"2025-05-14T01:09:35.444Z","repository":{"id":37270180,"uuid":"118847892","full_name":"dscalzi/HeliosLauncher","owner":"dscalzi","description":"☀ Custom launcher for modded minecraft written in Electron and Node.js","archived":false,"fork":false,"pushed_at":"2025-03-09T18:11:48.000Z","size":38981,"stargazers_count":893,"open_issues_count":39,"forks_count":1832,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-04-03T10:40:26.597Z","etag":null,"topics":["custom-minecraft-launcher","electron","fabric","forge","minecraft","minecraft-launcher"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dscalzi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"dscalzi","patreon":"dscalzi","custom":["https://www.paypal.me/dscalzi"]}},"created_at":"2018-01-25T01:58:30.000Z","updated_at":"2025-03-31T17:12:45.000Z","dependencies_parsed_at":"2024-01-05T01:24:57.444Z","dependency_job_id":"a2848ed3-fa89-4fa9-8e68-73d153ff0661","html_url":"https://github.com/dscalzi/HeliosLauncher","commit_stats":{"total_commits":493,"total_committers":13,"mean_commits":37.92307692307692,"dds":0.04259634888438135,"last_synced_commit":"e401608c33e64f9d8969588bd70767cef4e0ecf2"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dscalzi%2FHeliosLauncher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dscalzi%2FHeliosLauncher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dscalzi%2FHeliosLauncher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dscalzi%2FHeliosLauncher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dscalzi","download_url":"https://codeload.github.com/dscalzi/HeliosLauncher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248243474,"owners_count":21071054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-minecraft-launcher","electron","fabric","forge","minecraft","minecraft-launcher"],"created_at":"2024-09-24T19:46:14.526Z","updated_at":"2025-04-10T15:36:06.555Z","avatar_url":"https://github.com/dscalzi.png","language":"JavaScript","funding_links":["https://github.com/sponsors/dscalzi","https://patreon.com/dscalzi","https://www.paypal.me/dscalzi"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"./app/assets/images/SealCircle.png\" width=\"150px\" height=\"150px\" alt=\"aventium softworks\"\u003e\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eHelios Launcher\u003c/h1\u003e\n\n\u003cem\u003e\u003ch5 align=\"center\"\u003e(formerly Electron Launcher)\u003c/h5\u003e\u003c/em\u003e\n\n[\u003cp align=\"center\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/dscalzi/HeliosLauncher/build.yml?branch=master\u0026style=for-the-badge\" alt=\"gh actions\"\u003e](https://github.com/dscalzi/HeliosLauncher/actions) [\u003cimg src=\"https://img.shields.io/github/downloads/dscalzi/HeliosLauncher/total.svg?style=for-the-badge\" alt=\"downloads\"\u003e](https://github.com/dscalzi/HeliosLauncher/releases) \u003cimg src=\"https://forthebadge.com/images/badges/winter-is-coming.svg\"  height=\"28px\" alt=\"winter-is-coming\"\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eJoin modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.\u003c/p\u003e\n\n![Screenshot 1](https://i.imgur.com/6o7SmH6.png)\n![Screenshot 2](https://i.imgur.com/x3B34n1.png)\n\n## Features\n\n* 🔒 Full account management.\n  * Add multiple accounts and easily switch between them.\n  * Microsoft (OAuth 2.0) + Mojang (Yggdrasil) authentication fully supported.\n  * Credentials are never stored and transmitted directly to Mojang.\n* 📂 Efficient asset management.\n  * Receive client updates as soon as we release them.\n  * Files are validated before launch. Corrupt or incorrect files will be redownloaded.\n* ☕ **Automatic Java validation.**\n  * If you have an incompatible version of Java installed, we'll install the right one *for you*.\n  * You do not need to have Java installed to run the launcher.\n* 📰 News feed natively built into the launcher.\n* ⚙️ Intuitive settings management, including a Java control panel.\n* Supports all of our servers.\n  * Switch between server configurations with ease.\n  * View the player count of the selected server.\n* Automatic updates. That's right, the launcher updates itself.\n*  View the status of Mojang's services.\n\nThis is not an exhaustive list. Download and install the launcher to gauge all it can do!\n\n#### Need Help? [Check the wiki.][wiki]\n\n#### Like the project? Leave a ⭐ star on the repository!\n\n## Downloads\n\nYou can download from [GitHub Releases](https://github.com/dscalzi/HeliosLauncher/releases)\n\n#### Latest Release\n\n[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher.svg?style=flat-square)](https://github.com/dscalzi/HeliosLauncher/releases/latest)\n\n#### Latest Pre-Release\n[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher/all.svg?style=flat-square)](https://github.com/dscalzi/HeliosLauncher/releases)\n\n**Supported Platforms**\n\nIf you download from the [Releases](https://github.com/dscalzi/HeliosLauncher/releases) tab, select the installer for your system.\n\n| Platform | File |\n| -------- | ---- |\n| Windows x64 | `Helios-Launcher-setup-VERSION.exe` |\n| macOS x64 | `Helios-Launcher-setup-VERSION-x64.dmg` |\n| macOS arm64 | `Helios-Launcher-setup-VERSION-arm64.dmg` |\n| Linux x64 | `Helios-Launcher-setup-VERSION.AppImage` |\n\n## Console\n\nTo open the console, use the following keybind.\n\n```console\nctrl + shift + i\n```\n\nEnsure 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.\n\n#### Export Output to a File\n\nIf you want to export the console output, simply right click anywhere on the console and click **Save as..**\n\n![console example](https://i.imgur.com/T5e73jP.png)\n\n\n## Development\n\nThis section details the setup of a basic developmentment environment.\n\n### Getting Started\n\n**System Requirements**\n\n* [Node.js][nodejs] v20\n\n---\n\n**Clone and Install Dependencies**\n\n```console\n\u003e git clone https://github.com/dscalzi/HeliosLauncher.git\n\u003e cd HeliosLauncher\n\u003e npm install\n```\n\n---\n\n**Launch Application**\n\n```console\n\u003e npm start\n```\n\n---\n\n**Build Installers**\n\nTo build for your current platform.\n\n```console\n\u003e npm run dist\n```\n\nBuild for a specific platform.\n\n| Platform    | Command              |\n| ----------- | -------------------- |\n| Windows x64 | `npm run dist:win`   |\n| macOS       | `npm run dist:mac`   |\n| Linux x64   | `npm run dist:linux` |\n\nBuilds for macOS may not work on Windows/Linux and vice-versa.\n\n---\n\n### Visual Studio Code\n\nAll development of the launcher should be done using [Visual Studio Code][vscode].\n\nPaste the following into `.vscode/launch.json`\n\n```JSON\n{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"name\": \"Debug Main Process\",\n      \"type\": \"node\",\n      \"request\": \"launch\",\n      \"cwd\": \"${workspaceFolder}\",\n      \"program\": \"${workspaceFolder}/node_modules/electron/cli.js\",\n      \"args\" : [\".\"],\n      \"outputCapture\": \"std\"\n    },\n    {\n      \"name\": \"Debug Renderer Process\",\n      \"type\": \"chrome\",\n      \"request\": \"launch\",\n      \"runtimeExecutable\": \"${workspaceFolder}/node_modules/.bin/electron\",\n      \"windows\": {\n        \"runtimeExecutable\": \"${workspaceFolder}/node_modules/.bin/electron.cmd\"\n      },\n      \"runtimeArgs\": [\n        \"${workspaceFolder}/.\",\n        \"--remote-debugging-port=9222\"\n      ],\n      \"webRoot\": \"${workspaceFolder}\"\n    }\n  ]\n}\n```\n\nThis adds two debug configurations.\n\n#### Debug Main Process\n\nThis allows you to debug Electron's [main process][mainprocess]. You can debug scripts in the [renderer process][rendererprocess] by opening the DevTools Window.\n\n#### Debug Renderer Process\n\nThis allows you to debug Electron's [renderer process][rendererprocess]. This requires you to install the [Debugger for Chrome][chromedebugger] extension.\n\nNote that you **cannot** open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.\n\n---\n\n### Note on Third-Party Usage\n\nPlease give credit to the original author and provide a link to the original source. This is free software, please do at least this much.\n\nFor instructions on setting up Microsoft Authentication, see https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md.\n\n---\n\n## Resources\n\n* [Wiki][wiki]\n* [Nebula (Create Distribution.json)][nebula]\n* [v2 Rewrite Branch (Inactive)][v2branch]\n\nThe best way to contact the developers is on Discord.\n\n[![discord](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][discord]\n\n---\n\n### See you ingame.\n\n\n[nodejs]: https://nodejs.org/en/ 'Node.js'\n[vscode]: https://code.visualstudio.com/ 'Visual Studio Code'\n[mainprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Main Process'\n[rendererprocess]: https://electronjs.org/docs/tutorial/application-architecture#main-and-renderer-processes 'Renderer Process'\n[chromedebugger]: https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome 'Debugger for Chrome'\n[discord]: https://discord.gg/zNWUXdt 'Discord'\n[wiki]: https://github.com/dscalzi/HeliosLauncher/wiki 'wiki'\n[nebula]: https://github.com/dscalzi/Nebula 'dscalzi/Nebula'\n[v2branch]: https://github.com/dscalzi/HeliosLauncher/tree/ts-refactor 'v2 branch'\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdscalzi%2Fhelioslauncher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdscalzi%2Fhelioslauncher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdscalzi%2Fhelioslauncher/lists"}