an-anime-game-launcher/README.md

174 lines
5.1 KiB
Markdown
Raw Normal View History

<img src="repository/pics/logo.jpg">
2021-10-15 00:04:02 +03:00
<img src="repository/pics/launcher-main.png">
<img src="repository/pics/launcher-settings.png">
2021-10-15 00:04:02 +03:00
<br><br>
2021-09-14 12:06:09 +03:00
2022-03-09 09:44:02 +03:00
<h2 align="center">Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing</h2>
<br><br>
2022-02-02 14:23:35 +03:00
# Download
| Source | Link |
| --- | --- |
| AppImage | [Releases](https://gitlab.com/KRypt0n_/an-anime-game-launcher/-/releases) page |
| AUR | [an-anime-game-launcher-bin](https://aur.archlinux.org/packages/an-anime-game-launcher-bin) |
| Pacstall | an-anime-game-launcher-bin [(?)](https://pacstall.dev) |
2022-02-05 17:29:35 +03:00
## Flatpak support
To install the launcher via flatpak you will first have to make sure that you have flathub's remote installed
```zsh
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
```
After installing flathub's remote you install launcher.moe's remote
```zsh
flatpak remote-add --if-not-exists launcher.moe https://gol.launcher.moe/gol.launcher.moe.flatpakrepo
```
Now the only thing remaining is to install the launcher
```zsh
flatpak install launcher.moe com.gitlab.KRypt0n_.an-anime-game-launcher
```
2022-02-02 14:23:35 +03:00
Some additional configuration is possible when using the flatpak. For info about this, see [this page](https://gitlab.com/lane__/an-anime-game-launcher-flatpak/-/blob/master/README.md)
## Chinese version
To use Chinese version of the game make sure that you have
```yaml
server: cn
```
field in your `config.yaml` file (settings -> launcher folder). If your system uses the Chinese language - then it should be selected automatically. If not, then close the launcher, replace `server: global` with `server: cn`, and run it again. After that launcher will download the Chinese version of the game and the patch
# Status
2021-10-14 23:47:00 +03:00
| Game version | Launcher version | Patch version |
| :---: | :---: | :---: |
| 2.5.0 | 2.2.1 | 2.5.0 stable ✅ |
We have our own [An Anime Game](https://discord.gg/ck37X6UWBp) discord server where you can ask any questions
## Usage statistics
2022-01-13 00:44:46 +03:00
This is our current usage statistics. You can find older ones [here](repository/pages/STATISTICS.md)
2022-01-12 21:08:47 +03:00
### Our discord server — 386 member
<img src="repository/pics/stats/2022/mar-apr.png">
2021-11-18 15:09:17 +03:00
<br>
# Requirements
To work this launcher requires
| Name | Description |
| --- | --- |
| webkit2gtk | To run Neutralino apps |
2022-03-24 18:49:29 +03:00
| libayatana-appindicator3-1 | To run Neutralino apps |
2022-02-17 23:16:44 +03:00
| unzip | To unpack zip archives (DXVK / Wine) |
| tar | To unpack tar archives (DXVK / Wine) |
| git | To check for new versions of the launcher |
2022-02-17 23:16:44 +03:00
| 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 |
## Install
2022-02-17 19:36:24 +03:00
### apt
```sh
2022-03-24 18:49:29 +03:00
sudo apt install unzip tar git curl xdelta3 cabextract libnotify libayatana-appindicator3-1
```
### pacman
```sh
sudo pacman -Syu unzip tar git curl xdelta3 cabextract libnotify
```
### dnf
```sh
2022-03-24 18:49:29 +03:00
sudo dnf install unzip tar git curl xdelta cabextract libnotify webkit2gtk
```
2022-03-24 18:49:29 +03:00
[libayatana-appindicator3-1 RPM](https://downloadcontent.opensuse.org/repositories/X11:/Unity/openSUSE_Tumbleweed/x86_64/libayatana-appindicator3-1-0.5.90-13.4.x86_64.rpm)
# Additional requirements
| 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
They're required only for some specific functions
2021-10-14 23:47:00 +03:00
# Development
2022-02-02 14:23:35 +03:00
## Download source
2021-10-14 23:47:00 +03:00
```sh
2021-12-21 00:44:28 +03:00
git clone https://gitlab.com/KRypt0n_/an-anime-game-launcher
cd an-anime-game-launcher
yarn
yarn neu update
2021-10-14 23:47:00 +03:00
```
2021-12-21 00:44:28 +03:00
## Run
2021-10-14 23:47:00 +03:00
```sh
2021-12-21 00:44:28 +03:00
yarn dev
```
## Build
2021-10-14 23:47:00 +03:00
```sh
2021-12-21 00:44:28 +03:00
yarn build
2021-10-14 23:47:00 +03:00
```
2022-01-04 00:20:37 +03:00
## Bundle to AppImage
2021-10-14 23:47:00 +03:00
```sh
2022-01-04 00:20:37 +03:00
yarn bundle
2021-10-14 23:47:00 +03:00
```
2021-09-14 12:06:09 +03:00
# Roadmap
2022-01-12 21:08:47 +03:00
This is our current roadmap goals. You can find older ones [here](repository/pages/ROADMAP.md)
2021-12-21 00:44:28 +03:00
2021-12-22 18:35:45 +03:00
## ➤ To 3.0.0 release
### Features
2021-12-21 00:44:28 +03:00
* <s>Use `LauncherLib.getGameVersion` function instead of the `config.json`'s `version` property</s> *(deprecated due to the new core functions)*
* <s>Fix button flickering at start when the launcher's state updates</s> *(fixed due to the new framework usage and proper state updating)*
2022-01-14 02:04:11 +03:00
* <s>Add downloading pause button</s> *(2.0.0 release)*
2022-01-31 00:01:44 +03:00
* <s>Move launcher on [Empathize](https://github.com/empathizejs/framework)</s> *(2.1.0)*
* <s>Make notifications translations</s> *(2.1.0)*
* <s>ToS Violation Window</s> *(2.1.0)*
* <s>Add `latest.log` file generation</s> *(2.1.2)*
* <s>Add an option to show terminal with the wine's log of the game</s> *(7375c743, released in 2.1.3)*
* <s>Add analytics window</s> *(e0a09323, released in 2.2.0)*
* <s>Add Chinese game's version support (due to changes in the Krock's patch)</s> *(75f2ad66, released in 2.2.0)*
2022-03-09 19:40:57 +03:00
* <s>Add Patch category to the settings menu</s> *(07b32ada, 8a29d4a5, released in 2.2.1)*
2022-01-29 00:26:08 +03:00
* Implement manual config flushing functionality from the Empathize's API
2022-02-20 14:31:37 +03:00
* Game statistics window
* Dark progress bar design
* Changelog window
* Screenshots explorer