Archive/opengoal-launcher
1
0
Fork 0
mirror of https://github.com/open-goal/launcher.git synced 2024-10-19 14:47:36 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
A launcher for the OpenGOAL Project to simplify usage and installation
476 commits 49 branches 56 tags 194 MiB
Rust 41.7%
Svelte 39.5%
TypeScript 15.1%
JavaScript 2.7%
CSS 0.8%
Other 0.2%
Go to file
Tyler Wilding 2df3776aa8
ci: some more CI cleanup with npm -> yarn
2023-03-01 20:29:49 -05:00
.github ci: some more CI cleanup with npm -> yarn 2023-03-01 20:29:49 -05:00
.tauri Merge remote-tracking branch 'origin/main' into dev/new-ui 2023-03-01 01:03:20 -05:00
.vscode migrate: switch to Svelte 2022-04-14 19:49:13 -04:00
public migrate: switch to Svelte 2022-04-14 19:49:13 -04:00
scripts ci: remove npm usages from CI workflows 2023-03-01 01:01:18 -05:00
src lint: format 2023-03-01 01:01:33 -05:00
src-tauri Merge remote-tracking branch 'origin/main' into dev/new-ui 2023-03-01 01:03:20 -05:00
third-party/glew_2.2.0 Fix linux glewinfo 2.2.0 binary (#61) 2022-11-09 20:52:37 -05:00
.gitignore deps: switch to yarn and update all our dependencies 2023-02-18 21:24:33 -05:00
.prettierignore release: a bunch of debugging, appimages fail on releases though 2022-04-20 00:51:37 -04:00
.prettierrc.json Fix a bunch of small things discovered when testing the latest release (#118) 2022-07-23 17:37:59 -04:00
index.html frontend: get off font-awesome icons directly 2023-02-16 02:08:44 -05:00
LICENSE add a license 2022-06-01 00:27:22 -04:00
package.json Merge remote-tracking branch 'origin/main' into dev/new-ui 2023-03-01 01:03:20 -05:00
postcss.config.cjs UI Overhaul (#35) 2022-09-27 20:40:13 -04:00
README.md ci: some more CI cleanup with npm -> yarn 2023-03-01 20:29:49 -05:00
svelte.config.js UI Overhaul (#35) 2022-09-27 20:40:13 -04:00
tailwind.config.cjs UI Overhaul (#35) 2022-09-27 20:40:13 -04:00
tsconfig.json Full pass of launcher code-base, fixing bugs and cleanup (#100) 2022-07-14 18:04:01 -04:00
tsconfig.node.json renamed files and updated config files accordingly 2022-05-30 10:20:24 -04:00
vite.config.ts deps: switch to yarn and update all our dependencies 2023-02-18 21:24:33 -05:00
yarn.lock Merge remote-tracking branch 'origin/main' into dev/new-ui 2023-03-01 01:03:20 -05: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.

Features

  • Automatic Updates
  • Windows Support
  • Linux Support
  • Mac Support (TBD -- Not Planned)
  • Texture Pack Management (Soon)
  • Mod Management

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.app/v1/guides/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