Updated Installation & Configuration (markdown)

Marie 2023-03-04 22:24:53 +01:00
parent 71c36c3893
commit 9459fa8d5c
2 changed files with 125 additions and 147 deletions

@ -1,147 +0,0 @@
## Requirements setup
Generally this launcher requires these libraries:
| Name | Description |
| --- | --- |
| webkit2gtk | To run Neutralino apps |
| libayatana-appindicator3-1 | To run Neutralino apps |
| unzip | To unpack zip archives (DXVK / Wine) |
| tar | To unpack tar archives (DXVK / Wine) |
| git | To check for new versions of the launcher |
| curl | For archive downloads: game, voice data, runners and so on |
| xdelta3 | To apply the patch to the game (compiled with LZMA support) |
| cabextract | To install fonts to the Wine prefix |
| libnotify | To send system notifications |
System-specific library installation instructions:
| Type | Instruction |
| --- | --- |
| apt (Debian) | `sudo apt install unzip tar git curl xdelta3 cabextract libnotify-bin libayatana-appindicator3-1` |
| pacman (Arch Linux) | `sudo pacman -Syu unzip tar git curl xdelta3 cabextract libnotify` |
| dnf (Fedora) | `sudo dnf install unzip tar git curl xdelta cabextract libnotify webkit2gtk3` |
#### Fedora special instructions
The `libayatana-appindicator` package with its requirements (since they haven't been pushed to the fedora's repos):
| Name | Link |
| - | - |
| libayatana-ido | [rpm](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-ido3-0_4-0-0.9.0-1.4.x86_64.rpm) / [details](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-ido3-0_4-0-0.9.0-1.4.x86_64.rpm.mirrorlist) |
| libayatana-indicator | [rpm](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-indicator3-7-0.9.0-1.7.x86_64.rpm) / [details](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-indicator3-7-0.9.0-1.7.x86_64.rpm.mirrorlist) |
| libayatana-appindicator | [rpm](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-appindicator3-1-0.5.90-1.4.x86_64.rpm) / [details](https://download.opensuse.org/tumbleweed/repo/oss/x86_64/libayatana-appindicator3-1-0.5.90-1.4.x86_64.rpm.mirrorlist) |
Install them in the same order as in the table above using the command:
```sh
sudo rpm -i <path to rpm file>
```
#### Optional features and packages
If you would like to unlock the optional launcher functionalities, install the following packages too.
| Name | Description |
| --- | --- |
| [MangoHud](https://github.com/flightlessmango/MangoHud) | To use MangoHud |
| [vkBasalt](https://github.com/DadSchoorse/vkBasalt) | To use shaders |
| [GameMode](https://github.com/FeralInteractive/gamemode) | To use GameMode (performance optimization) |
These requirements can't be easily installed so you should do it manually.
## Launcher
Choose one of the launcher sources below that fit to your system. For Steam Deck, Flatpak (see instructions below) is recommended.
| Source | Link |
| --- | --- |
| AppImage (universal) | [Releases](https://gitlab.com/KRypt0n_/an-anime-game-launcher/-/releases) page |
| AUR (Arch Linux) | [an-anime-game-launcher-bin](https://aur.archlinux.org/packages/an-anime-game-launcher-bin) |
| Pacstall (Ubuntu) | [an-anime-game-launcher-bin](https://pacstall.dev/packages/an-anime-game-launcher-bin) |
| Ebuilds (Gentoo) | [an-anime-game-launcher-bin](https://gitlab.com/an-anime-team/aagl-ebuilds) |
#### Installation via Flatpak
**Normal installation**
1. Ensure flathub's remote is installed:
* `flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo`
2. Install launcher.moe's remote:
* `flatpak remote-add --if-not-exists launcher.moe https://gol.launcher.moe/gol.launcher.moe.flatpakrepo`
3. Install the launcher
* `flatpak install launcher.moe com.gitlab.KRypt0n_.an-anime-game-launcher`
**[Flatpak configuration options](https://gitlab.com/lane__/an-anime-game-launcher-flatpak/-/blob/master/README.md)** (such as game path)
**Launcher and game uninstall**
This is to fully remove the flatpak installation and the data saved in `<LAUNCHER>` (abbreviation, see below).
If you specified another game installation path, you need to remove that manually.
```
flatpak uninstall --delete-data com.gitlab.KRypt0n_.an-anime-game-launcher
```
## Configuration options
The launcher configuration file `config.yaml` will be generated in the following path:
* Flatpak: `~/.var/app/com.gitlab.KRypt0n_.an-anime-game-launcher/`
* Others: `~/.local/share/anime-game-launcher/`
For shorter notation, `<LAUNCHER>` is used as an abbreviation for this path. This is NOT an environment variable.
#### List of configurations
Be sure to close the launcher before doing any changes, or they might be overwritten.
* `server`: `global` for the international game version, `cn` for the Chinese version.
* Repeat this change after a launcher start & close if it was not applied.
* `folders`
* `prefix`: Path to the WINEPREFIX directory.
* Defaults to `<LAUNCHER>/game`.
* The directory and contents are generated during the game installation.
* Usually this does not need any adjustment.
* `game`: Path to the game installation.
* Defaults to `<LAUNCHER>/game/drive_c/Program Files/XXXX XXXX` (substituted)
* The directory and contents are generated during the game installation.
* Modify this setting to use an existing game installation or to specify another installation
directory (e.g. limited space).
* TODO: Document all other options
#### Flatpak: Change the installation directory
These commands will create a new directory structure and grant read/write access to the app.
Assign the variable `DST_PATH` to your desired location.
```sh
DST_PATH="/insert/my/new/path/here"
mkdir -p "$DST_PATH/prefix" "$DST_PATH/game" "$DST_PATH/temp"
flatpak override --user com.gitlab.KRypt0n_.an-anime-game-launcher --filesystem="$DST_PATH"
```
Then change the following `config.yaml` settings. Replace `<DST_PATH>` with the same path you already specified above.
```
folders:
prefix: <DST_PATH>/prefix
game: <DST_PATH>/game
temp: <DST_PATH>/temp
```
#### Chinese version
Detected based on locale by default can also be changed manually by adjusting the `server` setting. See above.
#### Command line arguments
* `--run-game`
* Skips the launcher and starts the game immediately. This can be used to quickly start the game
from game managers such as Steam

125
Installation.md Normal file

@ -0,0 +1,125 @@
**For Steam deck users: Refer to the <a href="#-any-distribution-flatpak">Flatpak</a> section**.
## <img src="https://www.flatpak.org/favicon.ico" width="23"/> Any distribution (Flatpak)
First you will have to open up a terminal and add the Flathub repository.
```
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
```
The next step would be to add the launcher repository as well. Note: If you want to apply these changes outside of just your current user, remove the `--user` flag.
```
flatpak remote-add --if-not-exists --user launcher.moe https://gol.launcher.moe/gol.launcher.moe.flatpakrepo
```
Lastly, you can install the launcher by running the following:
```
flatpak install launcher.moe moe.launcher.an-anime-game-launcher
```
## <img src="https://archlinux.org/favicon.ico" width="23"> Arch Linux (AUR)
### Using an AUR helper
You can install the launcher like any other AUR package using `yay` or other preferred AUR helpers.
```
yay -S an-anime-game-launcher-bin
```
### Without an AUR helper
First you will have to clone the repository.
```
git clone https://aur.archlinux.org/packages/an-anime-game-launcher-bin
```
Then move in to the repository directory.
```
cd an-anime-game-launcher-bin
```
And build the package.
```
makepkg -si
```
Note: Any missing dependencies not included in the base Arch repositories using this method will have to be fetched and install from the AUR manually.
## <img src="https://getfedora.org/favicon.ico" width="23"> Fedora (RPM)
Users of Fedora 37 will have to add the following repository by running.
```
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:Maroxy:AAT-Apps/Fedora_37/home:Maroxy:AAT-Apps.repo
```
Users of Fedora Rawhide will have to add this repository, Fedora 37 users can ignore the following command.
```
sudo dnf config-manager --add-repo https://download.opensuse.org/repositories/home:Maroxy:AAT-Apps/Fedora_Rawhide/home:Maroxy:AAT-Apps.repo
```
Lastly, the launcher can be installed by running the following:
```
sudo dnf install an-anime-game-launcher
```
## <img src="https://opensuse.org/favicon.ico" width="23"> openSUSE Tumbleweed (RPM)
First you will need to add the launcher repository by running the following.
```
sudo zypper ar -f https://download.opensuse.org/repositories/home:Maroxy:AAT-Apps/openSUSE_Tumbleweed/home:Maroxy:AAT-Apps.repo aatrepo
```
Then you can install the launcher with the following command:
```
sudo zypper install an-anime-game-launcher
```
## <img src="https://gentoo.org/favicon.ico" width="23"> Gentoo Linux (Ebuild)
Make sure that `app-eselect/eselect-repository` and `dev-vcs/git` is installed.
After that add the launcher's overlay.
```
eselect repository add The-Anime-Game git https://github.com/an-anime-team/aagl-ebuilds.git
```
And sync the repository.
```
emaint sync -r The-Anime-Game
```
Finally, emerge the launcher by running:
```
emerge --ask games-misc/an-anime-game-launcher
```
## <img src="https://nixos.org/favicon.ico" width="23"> NixOS (nixpkg)
### Cachix
It is recommended that you set up Cachix before the installation as not have to compile the launcher yourself.
You can do so by running
```
nix-shell -p cachix --run "cachix use ezkea"
```
Or alternatively in a declarative way by appending the following to your `configuration.nix`
```nix
{
nix.settings = {
substituters = [ "https://ezkea.cachix.org" ];
trusted-public-keys = [ "ezkea.cachix.org-1:ioBmUbJTZIKsHmWWXPe1FSFbeVe+afhfgqgTSNd34eI=" ];
};
}
```
### Installation
Add the following to your `configuration.nix`.
```nix
let
aagl-gtk-on-nix = import (builtins.fetchTarball "https://github.com/ezKEa/aagl-gtk-on-nix/archive/main.tar.gz"){ inherit pkgs; };
in
{
imports = [
aagl-gtk-on-nix.module
];
programs.an-anime-game-launcher.enable = true;
}
```
Then install the launcher by running:
```
nixos-rebuild switch
```
Alternatively, you can install the launcher using <a href="https://github.com/nix-community/home-manager">home-manager</a> by adding the following to your `home.nix`.
```nix
let
aagl-gtk-on-nix = import (builtins.fetchTarball "https://github.com/ezKEa/aagl-gtk-on-nix/archive/main.tar.gz"){ inherit pkgs; };
in
{
home.packages = [ aagl-gtk-on-nix.an-anime-game-launcher ];
}
```
For installation through the `nix` package manager on other distributions refer to the instructions in <a href="https://github.com/ezKEa/aagl-gtk-on-nix">this repository</a>.
## Any distribution (Executable)
Grab the latest binary from the <a href="https://github.com/an-anime-team/an-anime-game-launcher/releases">Release page</a>.
Then set execution permissions for the binary.
```
chmod +x an-anime-game-laucher
```
And run the launcher with the following:
```
./an-anime-game-launcher
```
You will have to install any missing dependencies yourself.