an-anime-game-launcher/README.md

<img src="repository-pics/logo.jpg">

<img src="repository-pics/launcher-main.png">

<img src="repository-pics/launcher-settings.png">

<br><br>

# Status

| Game version | Launcher version | Patch version |
| :---: | :---: | :---: |
| 2.2.0 | 1.1.0 | 2.2.0 stable ✅ |

Download from [Releases](https://notabug.org/nobody/an-anime-game-launcher/releases)

### ⚠️ Please, be careful with 2.3.0 game's release. It may suddenly break game's patch state

### ⚠️ Also patch's repository will be changed and you will HAVE to update launcher to the newest version

<br>

# Requirements

To work this launcher requires

* wine
* winetricks
* unzip
* tar
* git

## Install

### apt-get

```sh
sudo apt-get install wine winetricks unzip tar git
```

### pacman

```sh
sudo pacman -Syu wine winetricks unzip tar git
```

# Development

## Build from source

```sh
npm run build
```

## Run from source

```sh
npm start
```

# Roadmap

### ✓ <s>To 1.0.0 release</s>

* <s>Fix AppImage builds</s> *(0.3.0)*
* <s>Parse background banners from the game's API ([issue #1](https://notabug.org/nobody/an-anime-game-launcher/issues/1), [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)*
* <s>Cache launcher background picture ([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)*

### ➤ To 2.0.0 release

* <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)*
* Set default wine version to download so the wine install requirement is no longer needed.
* Add voice packs support
* Add Patch category in settings menu with
  - Always participate in patches testing
  - Applying anti login crash patch
  - Remove patch
* Playing statistics

And don't forget to change the patch's URI when it will be changed

<br>

### Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing
Fixed game's logo file extension 2021-10-24 16:35:22 +02:00			`<img src="repository-pics/logo.jpg">`
Added launcher picture to the readme 2021-10-14 23:04:02 +02:00
2.2.0-beta5 - made settings window - added runners management. Now you can download some runner like proton-ge and run the game with it - updated README pictures - removed usused path files - a lot of small changes and bug fixes 2021-10-22 23:48:43 +02:00			`<img src="repository-pics/launcher-main.png">`

Updated README pictures 2021-10-24 18:47:51 +02:00			`<img src="repository-pics/launcher-settings.png">`
Added launcher picture to the readme 2021-10-14 23:04:02 +02:00
			`<br><br>`
Init commit 2021-09-14 11:06:09 +02:00
2.2.0-beta1 - changed versioning politicy ([game version]-[app state][app build]) - created patches system now launcher automatically applies patches to the game - changed launcher config structure - changed executable file on game launching to the launcher.bat to check the telemetry status and prevent game starting in positive result - updated readme 2021-10-14 22:35:29 +02:00			`# Status`
Update readme 2021-10-14 22:47:00 +02:00
			`\| Game version \| Launcher version \| Patch version \|`
			`\| :---: \| :---: \| :---: \|`
1.1.0 - fixed main window flickering at start - added environmental variables manager - moved common styles to the basic.sass file - added excess files deletion when game's update comes - updated project logo 2021-11-01 10:10:51 +02:00			`\| 2.2.0 \| 1.1.0 \| 2.2.0 stable ✅ \|`
Update readme 2021-10-14 22:47:00 +02:00
Fixed releases page link 2021-10-14 22:47:42 +02:00			`Download from [Releases](https://notabug.org/nobody/an-anime-game-launcher/releases)`
Update readme 2021-10-14 22:47:00 +02:00
Added future problems notifications 2021-11-01 11:36:51 +02:00			`### ⚠️ Please, be careful with 2.3.0 game's release. It may suddenly break game's patch state`

			`### ⚠️ Also patch's repository will be changed and you will HAVE to update launcher to the newest version`

			`<br>`

2.2.0-beta2 - updated readme; added roadmap and requirements - added patch_anti_logincrash applying - partially fixed input issues - made LauncherUI class to where have moved a lot of code from the index.ts - fixed ETA calculation 2021-10-15 14:16:13 +02:00			`# Requirements`

			`To work this launcher requires`

			`* wine`
			`* winetricks`
			`* unzip`
2.2.0-beta5 - made settings window - added runners management. Now you can download some runner like proton-ge and run the game with it - updated README pictures - removed usused path files - a lot of small changes and bug fixes 2021-10-22 23:48:43 +02:00			`* tar`
1.0.0-rc1 - added launcher updates notifications - made automatic patch state parsing - added Baal icons to all notifications - fixed menu category changing in settings - removed excess code 2021-10-28 19:26:44 +02:00			`* git`
2.2.0-beta2 - updated readme; added roadmap and requirements - added patch_anti_logincrash applying - partially fixed input issues - made LauncherUI class to where have moved a lot of code from the index.ts - fixed ETA calculation 2021-10-15 14:16:13 +02:00
Added requirements installation commands 2021-10-28 19:41:38 +02:00			`## Install`

			`### apt-get`

			```sh
			`sudo apt-get install wine winetricks unzip tar git`
			```

			`### pacman`

			```sh
			`sudo pacman -Syu wine winetricks unzip tar git`
			```

Update readme 2021-10-14 22:47:00 +02:00			`# Development`

			`## Build from source`

			```sh
2.2.0-beta3 - added a notification when the game has been installed - removed windows compilation because we will never use it - added background picture parsing using the game's API Thanks Maroxy for all these enhancements + issue #1 + pull request #2 2021-10-17 13:28:37 +02:00			`npm run build`
Update readme 2021-10-14 22:47:00 +02:00			```

			`## Run from source`

			```sh
			`npm start`
			```
Init commit 2021-09-14 11:06:09 +02:00
2.2.0-beta2 - updated readme; added roadmap and requirements - added patch_anti_logincrash applying - partially fixed input issues - made LauncherUI class to where have moved a lot of code from the index.ts - fixed ETA calculation 2021-10-15 14:16:13 +02:00			`# Roadmap`

Readme update 2021-10-29 15:14:03 +02:00			`### ✓ <s>To 1.0.0 release</s>`
2.2.0-beta2 - updated readme; added roadmap and requirements - added patch_anti_logincrash applying - partially fixed input issues - made LauncherUI class to where have moved a lot of code from the index.ts - fixed ETA calculation 2021-10-15 14:16:13 +02:00
Changed project versioning 2.2.0-beta[N] -> 0.[N].0 for example, 2.2.0-beta5 became 0.5.0 2021-10-24 22:54:48 +02:00			`* <s>Fix AppImage builds</s> (0.3.0)`
			`* <s>Parse background banners from the game's API ([issue #1](https://notabug.org/nobody/an-anime-game-launcher/issues/1), [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)`
			`* <s>Cache launcher background picture ([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)`
1.0.0-rc1 - added launcher updates notifications - made automatic patch state parsing - added Baal icons to all notifications - fixed menu category changing in settings - removed excess code 2021-10-28 19:26:44 +02:00			`* <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)`
Roadmap update 2021-10-24 22:25:19 +02:00
Readme update 2021-10-29 15:14:03 +02:00			`### ➤ To 2.0.0 release`
Roadmap update 2021-10-24 22:25:19 +02:00
1.1.0 - fixed main window flickering at start - added environmental variables manager - moved common styles to the basic.sass file - added excess files deletion when game's update comes - updated project logo 2021-11-01 10:10:51 +02: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)`
Add new line to README 2021-10-28 23:35:55 +02:00			`* Set default wine version to download so the wine install requirement is no longer needed.`
Roadmap update 2021-10-24 22:25:19 +02:00			`* Add voice packs support`
			`* Add Patch category in settings menu with`
			`- Always participate in patches testing`
			`- Applying anti login crash patch`
			`- Remove patch`
			`* Playing statistics`
2.2.0-beta4 - added Marie Piontek as a project contributor - added launcher icon - made background picture caching - made automatical patch downloading - added social media buttons from the official launcher Thanks Maroxy for all these enhancements + pull request #6 2021-10-22 15:03:17 +02:00
			`And don't forget to change the patch's URI when it will be changed`
Readme update 2021-10-16 22:25:47 +02:00
Init commit 2021-09-14 11:06:09 +02:00			`<br>`

Readme updates 2021-10-14 20:34:43 +02:00			`### Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing`