Archive/opengoal-launcher
1
0
Fork 0
mirror of https://github.com/open-goal/launcher.git synced 2024-10-20 04:57:38 -04:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity
A launcher for the OpenGOAL Project to simplify usage and installation
267 commits 48 branches 57 tags 194 MiB
Rust 42.1%
Svelte 39.3%
TypeScript 15%
JavaScript 2.7%
CSS 0.7%
Other 0.2%
Go to file
trippjoe 2f37313282 running the compatability check during splashscreen
2022-06-17 17:30:41 -04:00
.github lint: formatting 2022-04-30 23:48:57 -04:00
.tauri linting 2022-06-17 16:29:01 -04:00
.vscode migrate: switch to Svelte 2022-04-14 19:49:13 -04:00
backup/components/settings actions: add linter action 2022-04-15 21:46:48 -04:00
docs/screenshots updated screenshot 2022-04-11 17:12:53 -04:00
public migrate: switch to Svelte 2022-04-14 19:49:13 -04:00
scripts release: isolate the updater configuration, only use it when releasing 2022-04-28 17:58:16 -04:00
src running the compatability check during splashscreen 2022-06-17 17:30:41 -04:00
src-tauri running the compatability check during splashscreen 2022-06-17 17:30:41 -04:00
third-party/glew_2.1.0 release: fixes from debugging 2022-04-30 23:42:49 -04:00
.gitignore release: partially fleshed out release workflow 2022-04-19 20:46:50 -04:00
.prettierignore release: a bunch of debugging, appimages fail on releases though 2022-04-20 00:51:37 -04:00
.prettierrc.json actions: add linter action 2022-04-15 21:46:48 -04:00
index.html linting 2022-06-16 20:40:37 -04:00
LICENSE add a license 2022-06-01 00:27:22 -04:00
package-lock.json release: bump to version - 0.2.3 2022-06-17 01:27:16 +00:00
package.json release: bump to version - 0.2.3 2022-06-17 01:27:16 +00:00
README.md docs: document intended release process 2022-04-28 20:07:13 -04:00
splashscreen.html transparent logo 2022-06-17 17:12:05 -04:00
svelte.config.js linting 2022-06-16 20:40:37 -04:00
tsconfig.json linting 2022-06-16 20:40:37 -04:00
tsconfig.node.json renamed files and updated config files accordingly 2022-05-30 10:20:24 -04:00
vite.config.ts linting 2022-06-16 20:40:37 -04:00

README.md

OpenGOAL Launcher

Description

A launcher for users to install and run the OpenGOAL project with ease

Preview

Launcher Preview

Disclaimer

Users are required to provide their own copy of the ISO file in order to run the game.

Resources

Development

We are using Tauri to build a native app, but still with simple Web technology. You will need to setup the prerequesites using the instructions here https://tauri.studio/docs/getting-started/prerequisites

Additionally, this presumes your environment has WebView2 (windows) or webkit2 (linux) already available. This is a requirement for end-users as well! Many modern OSes already ship with such a thing, but it's something we'll need to investigate.

  • npm install
  • npm run tauri dev

This builds the app with Tauri (this is a rust compilation, the first run will take a while) and the frontend is served via Vite -- a nice web server that will hot-reload any changes as you develop.

Release Process

sequenceDiagram
  jak-project->>jak-project: New tag is manually cut and built
  jak-project->>launcher: Repository Dispatch to start release
  launcher->>launcher: Alternatively, manually triggered release here
  launcher->>launcher: Build App for all supported platforms
  launcher->>launcher: Publish release and update latest release metadata file in repo
  website->>GitHub API: Website will display latest release
  app->>launcher: Detect new version and will prompt the user to update