Skip to content

Commit

Permalink
Merge pull request #1 from starbounded-dev/full-transition
Browse files Browse the repository at this point in the history
feat: transition to starbounded launcher
  • Loading branch information
sheazywi authored Jul 30, 2024
2 parents e4eb630 + fd6848f commit b695cd3
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 114 deletions.
123 changes: 15 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<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">Starbounded Launcher</h1>

<em><h5 align="center">(formerly Electron Launcher)</h5></em>
<em><h5 align="center">(forked from Helios Launcher, formerly Electron Launcher)</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/starbounded-dev/starbounded-launcher/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/starbounded-dev/starbounded-launcher/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">Join modded servers without worrying about installing Java, Forge, or other mods. We'll handle that for you.</p>

![Screenshot 1](https://i.imgur.com/6o7SmH6.png)
![Screenshot 2](https://i.imgur.com/x3B34n1.png)
![Screenshot 1](https://i.imgur.com/mrjpY4X.png)
![Screenshot 2](https://i.imgur.com/qSFn8Bm.png)

## Features

Expand All @@ -33,35 +33,26 @@

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

#### Need Help? [Check the wiki.][wiki]

#### Like the project? Leave a ⭐ star on the repository!

## Downloads

You can download from [GitHub Releases](https://github.com/dscalzi/HeliosLauncher/releases)

#### Latest Release

[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher.svg?style=flat-square)](https://github.com/dscalzi/HeliosLauncher/releases/latest)

#### Latest Pre-Release
[![](https://img.shields.io/github/release/dscalzi/HeliosLauncher/all.svg?style=flat-square)](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` |
| Platform | File |
| -------- |-------------------------------------------|
| Windows x64 | `Starbounded-Launcher-setup-VERSION.exe` |
| macOS x64 | `Starbounded-Launcher-setup-VERSION-x64.dmg` |
| macOS arm64 | `Starbounded-Launcher-setup-VERSION-arm64.dmg` |
| Linux x64 | `Starbounded-Launcher-setup-VERSION.AppImage` |

## Console

To open the console, use the following keybind.
To open the console, use the following keybind, just as a chronium browser.

```console
ctrl + shift + i
Expand Down Expand Up @@ -91,8 +82,8 @@ This section details the setup of a basic developmentment environment.
**Clone and Install Dependencies**

```console
> git clone https://github.com/dscalzi/HeliosLauncher.git
> cd HeliosLauncher
> git clone https://github.com/starbounded-dev/starbounded-launcher.git
> cd starbounded-launcher
> npm install
```

Expand Down Expand Up @@ -124,88 +115,4 @@ Build for a specific platform.

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](https://discordapp.com/api/guilds/211524927831015424/embed.png?style=banner3)][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'
---
Binary file added app/assets/images/homepage_starbounded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added app/assets/images/login_starbounded.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions app/assets/js/configmanager.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const logger = LoggerUtil.getLogger('ConfigManager')

const sysRoot = process.env.APPDATA || (process.platform == 'darwin' ? process.env.HOME + '/Library/Application Support' : process.env.HOME)

const dataPath = path.join(sysRoot, '.starboundedlauncher')
const dataPath = path.join(sysRoot, '.starbounded')

const launcherDir = require('@electron/remote').app.getPath('userData')

Expand Down Expand Up @@ -45,7 +45,7 @@ const firstLaunch = !fs.existsSync(configPath) && !fs.existsSync(configPathLEGAC

exports.getAbsoluteMinRAM = function(ram){
if(ram?.minimum != null) {
return ram.minimum/1024
return ram.minimum/2048
} else {
// Legacy behavior
const mem = os.totalmem()
Expand Down
2 changes: 1 addition & 1 deletion app/assets/js/distromanager.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const ConfigManager = require('./configmanager')

// Old WesterosCraft url.
// exports.REMOTE_DISTRO_URL = 'http://mc.westeroscraft.com/WesterosCraftLauncher/distribution.json'
exports.REMOTE_DISTRO_URL = 'https://helios-files.geekcorner.eu.org/distribution.json'
exports.REMOTE_DISTRO_URL = 'https://files.starbounded.me/distribution.json'

const api = new DistributionAPI(
ConfigManager.getLauncherDirectory(),
Expand Down
2 changes: 1 addition & 1 deletion app/assets/js/ipcconstants.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// NOTE FOR THIRD-PARTY
// REPLACE THIS CLIENT ID WITH YOUR APPLICATION ID.
// SEE https://github.com/dscalzi/HeliosLauncher/blob/master/docs/MicrosoftAuth.md
exports.AZURE_CLIENT_ID = '847fa3d4-f724-45da-b4ca-743a7467893b'
exports.AZURE_CLIENT_ID = '1ce6e35a-126f-48fd-97fb-54d143ac6d45'
// SEE NOTE ABOVE.


Expand Down
4 changes: 2 additions & 2 deletions app/assets/lang/_custom.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ title = "Starbounded Launcher"

[ejs.landing]
mediaGitHubURL = "https://github.com/starbounded-dev/starbounded-launcher"
mediaTwitterURL = "#"
mediaTwitterURL = "https://x.com/StarboundedSTD"
mediaInstagramURL = "#"
mediaYouTubeURL = "#"
mediaYouTubeURL = "https://www.youtube.com/@StarboundedSTD "
mediaDiscordURL = "https://discord.gg/G8kGNXR2Ef"

[ejs.settings]
Expand Down

0 comments on commit b695cd3

Please sign in to comment.