an-anime-game-launcher/README.md
Observer KRypt0n_ 4d75a85d22
Squashed commit of the following:
commit a8f0d32a87
Author: Observer KRypt0n_ <suimin.tu.mu.ga.mi@gmail.com>
Date:   Thu Mar 23 18:34:14 2023 +0200

    Added dark repository pictures variants

commit 711cc820f1
Author: Marie <marie@kaifa.ch>
Date:   Wed Mar 22 15:01:03 2023 +0100

    chore: Replace download section

    - List available Installation Types
    - Link to the more fancy wiki page for the guides

commit b5d38a7482
Author: Observer KRypt0n_ <suimin.tu.mu.ga.mi@gmail.com>
Date:   Tue Mar 21 18:37:47 2023 +0200

    chore: updated repository pictures

commit f52c8ec968
Author: Observer KRypt0n_ <suimin.tu.mu.ga.mi@gmail.com>
Date:   Sun Mar 19 17:03:59 2023 +0200

    docs: changed ascii chart to png

commit 5df5ce462d
Author: Observer KRypt0n_ <suimin.tu.mu.ga.mi@gmail.com>
Date:   Sun Mar 19 16:50:21 2023 +0200

    docs: added info about branches

commit f0a7fdd583
Author: Observer KRypt0n_ <suimin.tu.mu.ga.mi@gmail.com>
Date:   Sun Mar 19 16:42:16 2023 +0200

    ci: added `next` branch to github actions
2023-03-23 18:42:53 +02:00

3.3 KiB

Modern style Classic style

Discord · Matrix · Wiki


Please don't link to this repository

We understand you want to help people run An Anime Game on Linux. The issue is, the more people know of the tools involved in it, the higher the chances The Anime Game Company will notice them, and then fix the flaws that let us do the needful.

While sharing in your self-managed chat services and through private messaging is fine, we humbly ask that you refrain from publically sharing links to this repository, or to any of the tools involved.

Or share them and ruin it for the dozens of Linux players. It's up to you.

If you're going to share it anyway

Do what you must, but we would respectfully request that you try to label the game as "An Anime Game" instead of the actual name of the game, to avoid search engine parsing.

Documentation

Documentation for the launcher can be found in the repository wiki.

Download

Currently there are 5 options available:

  1. Flatpak
  2. AUR
  3. RPM
  4. Gentoo/ebuild
  5. NixOS

To see the installation guides, Please visit the wiki page here

Chinese version support

This should be automatically enabled if you're using zh_cn (Chinese) as your system language. If you're not using it - you'll need to set China as your launcher.edition in the config.json file

Development

Folder Description
anime-launcher-sdk Unified core functionality for the launcher
src Rust source code
assets App assets folder
assets/locales App localizations
target/release Release build of the app

Clone repo

git clone --recursive https://github.com/an-anime-team/an-anime-game-launcher

Run app

cargo run

Build app

cargo build --release

Updates strategy

Starting from 3.2.1 (fcab428) we have 2 branches: stable (main) and dev (next). Code changes will be pushed into dev branch and merged into stable once they're ready for new version release