an-anime-game-launcher/README.md

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

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

<br><br>

# Status

| Game version | Launcher version | Patch version |
| :---: | :---: | :---: |
| 2.2.0 | 2.2.0-beta3 ⚠️ | 2.2.0-stable ✅ |

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

> ⚠️ Launcher is currently in development

# Requirements

To work this launcher requires

* wine
* winecfg
* winetricks
* unzip

# Development

## Build from source

```sh
npm run build
```

## Run from source

```sh
npm start
```

# Roadmap

To 2.2.0-release1

* <s>Fix AppImage builds</s>
* <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>
* Make Proton-GE default compatibility tool and fix game input issues
* Add additional telemetry checking
* Add preferences menu
* Add launcher updates notifications
* Cache launcher background picture

<br>

### Please, try to use "An Anime Game" phrase instead of the real game name to avoid search engines parsing
Added launcher picture to the readme 2021-10-14 23:04:02 +02:00			`<img src="repository-pics/logo.png">`

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

			`<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 \|`
			`\| :---: \| :---: \| :---: \|`
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			`\| 2.2.0 \| 2.2.0-beta3 ⚠️ \| 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
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			`> ⚠️ Launcher is currently in development`

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`
			`* winecfg`
			`* winetricks`
			`* unzip`

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`

			`To 2.2.0-release1`

Readme update 2021-10-16 22:25:47 +02:00			`* <s>Fix AppImage builds</s>`
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			`* <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>`
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			`* Make Proton-GE default compatibility tool and fix game input issues`
			`* Add additional telemetry checking`
			`* Add preferences menu`
			`* Add launcher updates notifications`
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			`* Cache launcher background picture`
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`