an-anime-game-launcher/README.md

203 lines
7.3 KiB
Markdown
Raw Normal View History

2021-10-24 17:35:22 +03:00
<img src="repository-pics/logo.jpg">
2021-10-15 00:04:02 +03:00
<img src="repository-pics/launcher-main.png">
2021-10-24 19:47:51 +03:00
<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
### Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing
<br><br>
# Status
2021-10-14 23:47:00 +03:00
| Game version | Launcher version | Patch version |
| :---: | :---: | :---: |
| 2.3.0 | 1.9.1 | 2.3.0 stable ✅ |
We have our own [An Anime Game](https://discord.gg/ck37X6UWBp) discord server where you can ask any questions
2021-11-12 23:40:05 +03:00
### AppImage
2021-11-27 21:07:31 +03:00
Download AppImage from [Releases](https://gitlab.com/KRypt0n_/an-anime-game-launcher/-/releases) page
2021-11-12 23:40:05 +03:00
### For arch users
This launcher is also available as the [an-anime-game-launcher](https://aur.archlinux.org/packages/an-anime-game-launcher) AUR repository
2021-11-12 23:40:05 +03:00
2021-11-01 15:55:53 +03:00
<br>
## Usage statistics
### 2.2.0 — 29 total
2021-11-23 22:01:57 +03:00
<img src="repository-pics/stats/2.2.0.png">
2021-12-20 19:55:12 +03:00
### 2.3.0 — 73 total
<img src="repository-pics/stats/2.3.0.png">
2021-11-18 15:09:17 +03:00
> You can suggest colors for your countries
<br>
# Requirements
To work this launcher requires
| Name | Description |
| --- | --- |
| webkit2gtk | To run Neutralino apps |
| unzip | To unpack zip archives (DXVKs / wines) |
| tar | To unpack tar archives (DXVKs / wines) |
| git | To check for new versions of the launcher |
| curl | To download archives with game, voice data, runners and so on |
| xdelta3 | To apply the patch to the game |
| cabextract | To install fonts to the wine prefix |
## Install
### apt-get
```sh
sudo apt-get install webkit2gtk unzip tar git curl xdelta3 cabextract
```
### pacman
```sh
sudo pacman -Syu webkit2gtk unzip tar git curl xdelta3 cabextract
```
# 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) |
| [switcheroo-control](https://gitlab.freedesktop.org/hadess/switcheroo-control/) | To select the GPU launcher should use to run the game |
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
2021-12-21 00:44:28 +03:00
## Download
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
```sh
yarn build
2021-10-14 23:47:00 +03:00
```
2021-09-14 12:06:09 +03:00
# Roadmap
2021-12-22 18:35:45 +03:00
## ✓ <s>To 1.0.0 release</s>
* <s>Fix AppImage builds</s> *(0.3.0)*
2021-11-27 21:07:31 +03:00
* <s>Parse background banners from the game's API ([notabug issue #1](https://notabug.org/nobody/an-anime-game-launcher/issues/1), [notabug pull request #2](https://notabug.org/nobody/an-anime-game-launcher/pulls/2))</s> *(0.3.0)*
* <s>Update launcher logo</s> *(0.4.0)*
2021-11-27 21:07:31 +03:00
* <s>Cache launcher background picture ([notabug pull request #6](https://notabug.org/nobody/an-anime-game-launcher/pulls/6))</s> *(0.4.0)*
* <s>Make Proton-GE default compatibility tool and fix game input issues</s> (added runners manager) *(0.5.0)*
* <s>Add preferences menu</s> *(0.5.0)*
* <s>Add additional telemetry checking</s> *(0.6.0)*
* <s>Add DXVK downloading in settings</s> *(0.6.0)*
* <s>Make participation in the anonymous analytics request</s> *(0.8.0)*
* <s>Add launcher updates notifications</s> *(1.0.0-rc1)*
* <s>Make automatic patch state parsing</s> *(1.0.0-rc1)*
2021-10-24 23:25:19 +03:00
2021-12-22 18:35:45 +03:00
## ✓ <s>To 2.0.0 release</s>
2021-10-24 23:25:19 +03:00
* <s>Add runners environmental variables manager</s> *(1.1.0)*
* <s>Add outdated files deletion when new game's update releases</s> *(1.1.0)*
* <s>Add installed packages deletion</s> *(1.2.0)*
* <s>Add voice packs support</s> (Thank @Maroxy for the developments in the previous versions) *(1.3.0)*
* <s>Color variants for progress bar's downloading text dependent on the background picture primary color</s> *(1.4.0, LAB-based in 1.5.3)*
* <s>Playing statistics</s> *(1.4.1)*
* <s>MangoHud support</s> (added HUD selector) *(1.5.0)*
* <s>Add vkBasalt support and "shaders library"</s> *(1.5.0)*
- [yagocl's](https://notabug.org/Krock/GI-on-Linux/src/master/static/vkBasalt_yagocl.conf) basic sharpening preset *(without pictures)*
- [notahuman's](https://notabug.org/Krock/GI-on-Linux/src/master/static/vkBasalt_notahuman.conf) prime preset v2
* <s>Make shaders manager hidden if vkBasalt is not installed</s> *(1.5.4)*
* <s>Make MangoHud option hidden if it is not installed</s> *(1.5.4)*
2021-11-27 21:07:31 +03:00
* <s>GameMode integration ([notabug issue 28](https://notabug.org/nobody/an-anime-game-launcher/issues/28), [notabug pull request 30](https://notabug.org/nobody/an-anime-game-launcher/pulls/30))</s> *(1.5.8)*
* <s>Hybrid GPU integration ([notabug issue 29](https://notabug.org/nobody/an-anime-game-launcher/issues/29), [notabug pull request 33](https://notabug.org/nobody/an-anime-game-launcher/pulls/33))</s> *(1.6.0)*
* <s>Add winetricks auto-downloading when new prefix creates so it is no longer required</s> *(1.6.0)*
* <s>DXVK logs auto-deletion option</s> *(1.6.0)*
* <s>Add default wine version to download</s> (Proton-6.20-GE-1) *(1.6.0)*
* <s>Add dark theme support for settings menu</s> *(1.7.0)*
* <s>Add winetricks and winecfg buttons to settings ([notabug issue 35](https://notabug.org/nobody/an-anime-game-launcher/issues/35))</s> *(1.8.0)*
* <s>Wine prefix folder selection ([notabug issue 37](https://notabug.org/nobody/an-anime-game-launcher/issues/37))</s> *(1.8.0)*
* <s>Use auto-downloaded winetricks in settings menu</s> *(1.9.0, !14)*
* <s>Use `winecfg.exe` from the installed runner in settings menu</s> *(1.9.0, !14)*
* <s>Fix voice data installation</s> *(1.9.0, !15)*
* <s>Add fps unlocker option</s> *(1.9.0, !15)*
2021-12-21 00:44:28 +03:00
2021-12-22 18:35:45 +03:00
## ➤ To 3.0.0 release
### 2.0.0 release goals - moving launcher to Neutralino
#### Core functionality
* <s>Make `constants` class to store launcher's constants</s>
* <s>Make `Downloader` class to download files</s>
* <s>Make `Archive` class to work with archives</s>
* <s>Make `DXVK` class to manage DXVK installations</s>
* <s>Make `Runners` class to manage wines installations</s>
* <s>Make `Configs` class to manage launcher's configs</s>
* Make `Game` class to control game-related features
* <s>Ability to parse current installed version</s>
* <s>Ability to get latest available version</s>
* Ability to download and install updates
* Make `Voice` class to control voice packages-related features
* <s>Ability to parse current installed voice packs and get selected one</s>
* <s>Ability to get latest available voice packs</s>
* Ability to download and install updates
* Make `Patch` class to control patch-related features
* <s>Ability to get current installed patch</s>
* <s>Ability to get latest available patch</s>
* Ability to download and install it
* Add project binaries bundling
* AppImage
#### Launcher functions
* Make `Launcher` class to manage launcher-related features
* Launcher state functionality
* Make Vue components
* Progress bar for the main window
* Checkbox
* Selection
* SelectionList
* PropertiesEditor
* Rewrite sass code, provide more flexible theming ability
* Add `vue-i18n`
### Features
2021-12-21 00:44:28 +03:00
* Add downloading pause button
* Use `LauncherLib.getGameVersion` function instead of the `config.json`'s `version` property
* Fix button flickering at start when the launcher's state updates
2021-11-23 22:01:57 +03:00
* Game's update pre-installation
* Screenshots explorer
2021-10-24 23:25:19 +03:00
* Add Patch category in settings menu with
- Always participate in patches testing
- Applying anti login crash patch
- Remove patch