2022-02-07 15:15:13 -05:00
# OpenGOAL Launcher
2022-02-07 14:55:19 -05:00
2022-02-07 15:15:13 -05:00
## Description
2022-04-15 21:46:48 -04:00
2022-03-27 11:09:17 -04:00
A launcher for users to install and run the OpenGOAL project with ease
2022-02-07 14:55:19 -05:00
2022-04-04 10:08:26 -04:00
## Preview
2022-04-15 21:46:48 -04:00
2022-10-03 23:05:10 -04:00
2022-04-04 10:08:26 -04:00
2022-02-07 15:15:13 -05:00
## Disclaimer
2022-04-15 21:46:48 -04:00
2022-02-07 15:15:13 -05:00
Users are required to provide their own copy of the ISO file in order to run the game.
2022-02-07 14:55:19 -05:00
2022-07-29 09:51:25 -04:00
## Features
2022-08-08 20:01:11 -04:00
2022-10-03 23:05:10 -04:00
- [x] Automatic Updates
2022-07-29 09:51:25 -04:00
- [x] Windows Support
2022-10-03 23:05:10 -04:00
- [x] Linux Support
- [ ] Mac Support (TBD -- Not Planned)
- [x] Texture Pack Management
2022-07-29 09:51:25 -04:00
2022-02-07 15:15:13 -05:00
## Resources
2022-04-15 21:46:48 -04:00
2022-02-08 13:05:17 -05:00
- [OpenGOAL Github Organization ](https://github.com/open-goal/ )
2022-07-29 09:52:22 -04:00
- [OpenGOAL Documentation ](https://opengoal.dev/ )
2022-04-06 22:27:03 -04:00
- [OpenGOAL Discord ](https://discord.gg/twBEFbMnqw )
## Development
2022-10-03 23:05:10 -04:00
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
2022-04-06 22:27:03 -04:00
2022-04-15 21:46:48 -04:00
> 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.
2022-04-06 22:27:03 -04:00
- `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.
2022-04-28 20:06:44 -04:00
## Release Process
```mermaid
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
```
