mirror of
https://github.com/open-goal/launcher.git
synced 2024-10-20 04:57:38 -04:00
28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# OpenGOAL Launcher
|
|
|
|
## Description
|
|
A launcher for users to install and run the OpenGOAL project with ease.
|
|
|
|
## Preview
|
|
![Launcher GIF](./app/src/assets/images/launcher.gif)
|
|
|
|
## Contributing
|
|
As of right now, this project is dependent on the user building the OpenGOAL tools themselves, follow the [OpenGOAL README](https://github.com/water111/jak-project#readme) before attempting to run this.
|
|
If you are interested in contributing to this project please clone the repo to your local machine and install all dependencies with `npm i`.
|
|
To run the application navigate to the root directory and run: `npm run dev`.
|
|
|
|
## Disclaimer
|
|
Users are required to provide their own copy of the ISO file in order to run the game.
|
|
|
|
## Built With
|
|
- [Secure Electron Template](https://github.com/reZach/secure-electron-template)
|
|
- [Node.js](https://nodejs.org/en/)
|
|
- [Electron](https://www.electronjs.org/)
|
|
- [React](https://reactjs.org/)
|
|
- [Redux](https://redux.js.org/)
|
|
- [Chakra UI](https://chakra-ui.com/)
|
|
|
|
## Resources
|
|
- [OpenGOAL Project Repo](https://github.com/water111/jak-project)
|
|
- [OpenGOAL Documentation](https://water111.github.io/jak-project/)
|
|
- [OpenGOAL Discord](https://discord.gg/BVEHQmm8) |