dusk/README.md.old

### Regions
Currently, **only the glb version (Europe & Americas) is supported**. There may be patches for other versions in the future.

### Information
The Game's anticheat is fundamentally incompatible with Wine in multiple ways (at least 3). This patch removes it entirely and imitates it's behaviour. This is much more radical than classical micropatching, so the risks are probably higher (not enough time has passed to tell). Please contact me if you want to know how the patch works.

And no, it does not work on Windows.

### Installation
**Wine 8.4+ (staging branch) is recommended to run the Game**. Apparently, some older Wine versions may also work. [DXVK](https://github.com/doitsujin/dxvk) is recommended, but not required.

If you're not using Proton GE, **a fix for Media Foundation is required to play videos. The Game may crash without it.** You can download it from [here](https://github.com/z0z0z/mf-install). You might need to [limit the number of cores available to the game](https://github.com/z0z0z/mf-install/issues/44) if your CPU has more than 8.

[Honkers Launcher](https://github.com/an-anime-team/honkers-launcher) can be used to install and patch the Game automatically. If you don't want to use the launcher, follow the manual installation instructions below.

macOS users: The Game requires a modified version of Wine to run on macOS. [Yaagl](https://github.com/3Shain/yet-another-anime-game-launcher) can be used to install it (and the Game) automatically.

Manual installation:
- Download and install the Game from the official website (not from Steam!). Do not launch the Game
- Clone this repo (not into the game directory!): `git clone https://notabug.org/mkrsym1/dusk`
- Open the directory with BH3.exe in your terminal
- Install the patch: `install.sh`. Use `install.sh --root-cmd <command>` to use something else instead of polkit

Now you can start the Game using `launch.bat`

### Guidelines
1. **Please don't share this project in public.** This might attract unnecessary attention from either the Game Company or the Anticheat Company
2. **Please don't abuse this project for cheating.** We're just trying to play the Game through Wine

### Troubleshooting
Please do not report any issues with the Game to the official channels. Use the issue tracker of this repository

TROUBLESHOOTING.md will be added in the future

### Credits
- mkrsym1 &mdash; project leader, reverse engineering, TVM autoanalysis and metadata generator tool (not public), TVMBootstrap.dll, patches, patch installer
- [An Anime Team](https://github.com/an-anime-team) &mdash; [Honkers Launcher](https://github.com/an-anime-team/honkers-launcher), [mirror of this repository](https://codeberg.org/an-anime-team/dusk)
- [3Shain](https://github.com/3Shain) &mdash; [Yaagl](https://github.com/3Shain/yet-another-anime-game-launcher), modified Wine for macOS

License: MIT