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 | 0.7.0 ⚠️ | 2.2.0 stable ✅ |

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

> ⚠️ Launcher is currently in development, but you already can use it

# Requirements

To work this launcher requires

* wine
* winecfg
* winetricks
* unzip
* tar

# Development

## Build from source

```sh
npm run build
```

## Run from source

```sh
npm start
```

# Roadmap

To 1.0.0 release

* <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)*
* Add launcher updates notifications
* Make automatical patch state parsing
* Make participation in the anonymous analytics request

To 2.0.0 release

* Add outdated files deletion when new game's update releases
* 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 17:35:22 +03:00			`<img src="repository-pics/logo.jpg">`
Added launcher picture to the readme 2021-10-15 00:04:02 +03: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-23 00:48:43 +03:00			`<img src="repository-pics/launcher-main.png">`

Updated README pictures 2021-10-24 19:47:51 +03:00			`<img src="repository-pics/launcher-settings.png">`
Added launcher picture to the readme 2021-10-15 00:04:02 +03:00
			`<br><br>`
Init commit 2021-09-14 12:06:09 +03: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 23:35:29 +03:00			`# Status`
Update readme 2021-10-14 23:47:00 +03:00
			`\| Game version \| Launcher version \| Patch version \|`
			`\| :---: \| :---: \| :---: \|`
Changed project versioning 2.2.0-beta[N] -> 0.[N].0 for example, 2.2.0-beta5 became 0.5.0 2021-10-24 23:54:48 +03:00			`\| 2.2.0 \| 0.7.0 ⚠️ \| 2.2.0 stable ✅ \|`
Update readme 2021-10-14 23:47:00 +03:00
Fixed releases page link 2021-10-14 23:47:42 +03:00			`Download from [Releases](https://notabug.org/nobody/an-anime-game-launcher/releases)`
Update readme 2021-10-14 23:47:00 +03:00
2.2.0-beta6 - added DXVK support - removed lutris-fshack from runners - added telemetry hosts checking before game started - fixed menu items movement in settings 2021-10-23 22:02:50 +03:00			`> ⚠️ Launcher is currently in development, but you already can use it`
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 14:28:37 +03: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 15:16:13 +03:00			`# Requirements`

			`To work this launcher requires`

			`* wine`
			`* winecfg`
			`* 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-23 00:48:43 +03:00			`* tar`
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 15:16:13 +03:00
Update readme 2021-10-14 23:47:00 +03: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 14:28:37 +03:00			`npm run build`
Update readme 2021-10-14 23:47:00 +03:00			```

			`## Run from source`

			```sh
			`npm start`
			```
Init commit 2021-09-14 12:06:09 +03: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 15:16:13 +03:00			`# Roadmap`

Changed project versioning 2.2.0-beta[N] -> 0.[N].0 for example, 2.2.0-beta5 became 0.5.0 2021-10-24 23:54:48 +03:00			`To 1.0.0 release`
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 15:16:13 +03: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 23:54:48 +03: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)`
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 15:16:13 +03:00			`* Add launcher updates notifications`
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 16:03:17 +03:00			`* Make automatical patch state parsing`
Roadmap update 2021-10-24 23:25:19 +03:00			`* Make participation in the anonymous analytics request`

Changed project versioning 2.2.0-beta[N] -> 0.[N].0 for example, 2.2.0-beta5 became 0.5.0 2021-10-24 23:54:48 +03:00			`To 2.0.0 release`
Roadmap update 2021-10-24 23:25:19 +03:00
2.2.0-beta6 - added DXVK support - removed lutris-fshack from runners - added telemetry hosts checking before game started - fixed menu items movement in settings 2021-10-23 22:02:50 +03:00			`* Add outdated files deletion when new game's update releases`
Roadmap update 2021-10-24 23:25:19 +03: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 16:03:17 +03:00
			`And don't forget to change the patch's URI when it will be changed`
Readme update 2021-10-16 23:25:47 +03:00
Init commit 2021-09-14 12:06:09 +03:00			`<br>`

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