GithubHelp home page GithubHelp logo

daxcess / gale Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kesomannen/gale

0.0 0.0 0.0 8.41 MB

Lightweight Thunderstore client

License: GNU General Public License v3.0

JavaScript 0.30% Python 0.09% Rust 58.14% TypeScript 3.56% CSS 0.02% HTML 0.17% Svelte 37.72%

gale's Introduction

logo

Gale Mod Manager

A lightweight mod manager for Thunderstore, built with SvelteKit and Tauri.

Table of Contents

Features

  • Support for most of the games on Thunderstore, including Lethal Company, Risk of Rain 2 and Content Warning
  • A performant and responsive UI with a tiny download and disk size (10 MB!)
  • Import & export profiles (compatible with r2modman/thunderstore mod manager)
  • Feature rich mod config editor
  • Export modpacks automatically, including uploading directly to Thunderstore
  • Launch games through Steam or directly, with any number of instances
  • Usable with the "Install with Mod Manager" button on Thunderstore
  • Automatically transfer profiles from other mod managers
  • Automatic app updates
  • Local mod imports
  • CLI (see the wiki page)

Coming soon

  • Support for modding frameworks other than BepInEx

Installation

Windows

Through Thunderstore

  • Go to the thunderstore page and press "Manual Download".
  • Unzip the downloaded .zip file (for example by right-clicking and choosing "Extract All").
  • Run the Gale_X.X.X_x64_en-US.msi file inside of the unzipped folder.

Through Github

  • Go to Releases.
  • Download the Gale_X.X.X_x64_en-US.msi file for your desired version (the latest is recommended).
  • Run the downloaded file.

Note: You might get a prompt saying "Windows has protected your PC". In this case, click More Info and Run Anyway.

If you're unsure about the safety of this app, I would suggest running it through a service like VirusTotal. It's also worth noting that this project is fully open-source, which means any developer could look at the code and easily spot any malware.

MacOS

TBD

Linux

TBD

Building from source

Windows

Firstly, make sure you have done all of the Tauri prerequisites.

Additionally, make sure you have git and the tauri CLI installed (or install it with cargo install tauri-cli).

After you have cloned the repository, run the following to start a dev server:

npm install
cargo tauri dev

To build Gale, run:

cargo tauri build

After a while, it will output both an .msi and an .exe installer in the src-tauri/target/release/bundle folder.

If you want to modify/distribute the app, keep in mind the license.

Linux

Install the required tools and build chain

Note: The examples use a Debian flavor package manager. Use your system specific package manager such as Yum or Pacman instead.

To build Gale on Linux you will likely require the following packages:

Rust Dependencies

sudo apt update
sudo apt install libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    file \
    libssl-dev \
    libgtk-3-dev \
    libayatana-appindicator3-dev \
    librsvg2-dev

Cargo/Rust

sudo apt install cargo

NVM

If your system does not have the latest node available you can install nvm by following the instructions here.

You can install a version of node that will work with Gale by using:

nvm install 20

Then you set the node version for your current terminal by using this command:

nvm use 20

You will need to set your node version before using any NPM commands later in this guide.

Install the Tauri CLI

cargo install tauri-cli

This will take a while, especially if you've never compiled anything with Rust before.

Start the dev server

nvm use 20
npm install
cargo tauri dev

Build Gale

cargo tauri build

After a while, this it will output both an executable and an installable package (a .deb for debian-based systems) in the src-tauri/target/release/bundle directory.

If you want to modify/distribute the app, keep in mind the license.

Screenshots

Mod list

screenshot

Profile

screenshot

Config editor

screenshot

Modpack export

screenshot

Credits

Material icons licensed under Apache 2.0.

Thanks to Ebkr for helping to navigate the thunderstore API and BepInEx, and of course making the original mod manager!

License

GNU GPLv3

gale's People

Contributors

kesomannen avatar serial-ata avatar rune580 avatar daxcess avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.