A launcher for the OpenGOAL Project to simplify usage and installation
Go to file
Tyler Wilding 0b145074a4
install: display the nice error messages based on the error codes (#89)
* install: display the nice error messages based on the error codes

* setup: feedback
2022-07-02 22:24:24 -04:00
.github build(deps): bump actions/checkout from 2 to 3 (#74) 2022-06-22 00:00:47 -04:00
.tauri release: update release metadata to latest 2022-06-22 01:54:18 +00:00
.vscode migrate: switch to Svelte 2022-04-14 19:49:13 -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 install: display the nice error messages based on the error codes (#89) 2022-07-02 22:24:24 -04:00
src-tauri Reinstalling game after a launcher update (#88) 2022-07-02 21:40:51 -04:00
third-party/glew_2.1.0 release: fixes from debugging 2022-04-30 23:42:49 -04:00
.gitignore release: fix new metadata file path 2022-06-21 21:34:40 -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 build(deps-dev): bump svelte-preprocess from 4.10.6 to 4.10.7 (#78) 2022-06-24 16:17:57 -04:00
package.json build(deps-dev): bump svelte-preprocess from 4.10.6 to 4.10.7 (#78) 2022-06-24 16:17:57 -04:00
README.md docs: document intended release process 2022-04-28 20:07:13 -04:00
svelte.config.js linting 2022-06-16 20:40:37 -04:00
tsconfig.json install: display the nice error messages based on the error codes (#89) 2022-07-02 22:24:24 -04:00
tsconfig.node.json renamed files and updated config files accordingly 2022-05-30 10:20:24 -04:00
vite.config.ts splash screen script 2022-06-18 14:36:28 -04:00

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