A launcher for the OpenGOAL Project to simplify usage and installation
Go to file
OpenGOALBot 4b2f704e4c
Some checks failed
📝 Linter / Frontend (push) Has been cancelled
📝 Linter / Backend Formatting (push) Has been cancelled
🔨 Build / App (macos-12) (push) Has been cancelled
🔨 Build / App (ubuntu-20.04) (push) Has been cancelled
🔨 Build / App (windows-latest) (push) Has been cancelled
📝 Linter / Backend Linter (push) Has been cancelled
🧪 Tests / Frontend (push) Has been cancelled
release: update release metadata to latest
2024-10-18 04:21:51 +00:00
.github ci: enable verbose logs for tauri build to resolve macOS intermittent failures (#564) 2024-09-18 20:31:24 -04:00
.tauri release: update release metadata to latest 2024-10-18 04:21:51 +00:00
.vscode ci: update to macos-12 and node-20 (#466) 2024-04-14 15:25:58 -04:00
docs help: add a reference sheet for the game's default keyboard binds (#569) 2024-09-21 22:12:13 -04:00
fixtures prettier mods.json fixture (#547) 2024-08-31 11:27:27 -07:00
metadata release: bump to version - v2.5.3 2024-10-18 04:04:57 +00:00
public/images/jak1 Dynamically change game background based on user's game completion (#298) 2023-08-29 22:01:56 -04:00
scripts release: fix appimage release asset link 2023-07-31 17:03:32 -04:00
src frontend: simplify the version pagination regex (#593) 2024-10-07 21:04:34 -04:00
src-tauri release: bump to version - v2.5.3 2024-10-18 04:04:57 +00:00
.gitignore Add mod support to the launcher (#476) 2024-04-28 15:27:34 -04:00
.prettierignore New Crowdin updates (#577) 2024-09-27 01:59:31 -04:00
.prettierrc.json build(deps): bump the frontend-deps group with 16 updates (#427) 2024-01-30 21:58:48 -05:00
crowdin.yml i18n: make the app translatable (#196) 2023-05-06 13:10:54 -04:00
index.html splash: cleanup splash implementation, allow changing locale during installation dir step (#552) 2024-09-26 21:35:31 -04:00
LICENSE Add mod support to the launcher (#476) 2024-04-28 15:27:34 -04:00
package-lock.json Add mod support to the launcher (#476) 2024-04-28 15:27:34 -04:00
package.json release: bump to version - v2.5.3 2024-10-18 04:04:57 +00:00
postcss.config.cjs UI Overhaul (#35) 2022-09-27 20:40:13 -04:00
README.md advanced: attempt to open a REPL on linux/macOS (#571) 2024-09-22 13:47:37 -04: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 build(deps): bump the frontend-deps group with 5 updates (#435) 2024-02-10 15:48:48 -05:00
tsconfig.node.json renamed files and updated config files accordingly 2022-05-30 10:20:24 -04:00
vite.config.ts build(deps-dev): bump the frontend-deps group with 8 updates (#289) 2023-07-24 18:38:03 -04:00
vitest.config.ts tests: Start writing tests, Splash and some of the lib/ functions (#280) 2023-07-22 00:07:23 -04:00
yarn.lock bump flowbite-svelte, pull in icons - fixes red bubble Indicator (#598) 2024-10-16 11:35:59 -07:00

OpenGOAL Launcher

Crowdin

Our attempt at distributing the OpenGOAL releases in a cross-platform and easy to use and update way. It also is a place for features involving the games, such as texture pack or mod management.

The launcher uses the Tauri framework.

Usage

See the documentation on our website for hopefully up to date instructions on how to use it.

Asking for help

When asking for help, please download the support package which includes logs to help someone diagnose the problem.

If you cannot do this (for example, the bug relates to making the package / the application won't launch) then you can find the application logs in the following folders:

  • Windows C://Users/<YOUR_USER_NAME>/AppData/Roaming/OpenGOAL-Launcher/logs
  • Linux /home/<YOUR_USER_NAME>/.config/OpenGOAL-Launcher/logs

Note that both AppData and .config are hidden folders.

Development

Tauri requires a valid Rust installation, as well as a valid NodeJS installation.

For installing Rust, it's recommended to follow the instructions here https://www.rust-lang.org/tools/install

Windows

scoop install nodejs
npm install -g yarn

Linux (Ubuntu 22.04)

sudo apt install libwebkit2gtk-4.0-dev build-essential curl wget libssl-dev libgtk-3-dev libayatana-appindicator3-dev librsvg2-dev # tauri deps, see - https://tauri.app/v1/guides/getting-started/prerequisites#setting-up-linux
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash # installs Node Version Manager (ubuntus package is woefully out of date)
source ~/.bashrc
nvm install lts/hydrogen # installs latest nodejs 18.X
npm install -g yarn

macOS

npm install -g yarn

Building and Running

To build and run the application locally, all you have to do is run:

yarn install
yarn tauri dev