mirror of https://github.com/open-goal/launcher.git synced 2024-10-20 04:57:38 -04:00

This feature is being added dark, there's no point in exposing it to
users yet because mods need to migrate to the latest (and upcoming
changes) to the `extractor` and `gk`.

Once a handful of mods are done, the remaining polish can be completed
and it can be enabled by default. These items are summarized at the top
of `ModSelection.svelte`

---------

Co-authored-by: dallmeyer <2515356+dallmeyer@users.noreply.github.com>

2024-04-28 15:27:34 -04:00

2.4 KiB

Raw Blame History

OpenGOAL Launcher

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
Asking for help
Development

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

Building and Running

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

yarn install
yarn tauri dev

2.4 KiB Raw Blame History