-
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[skip ci]
- Loading branch information
Showing
1 changed file
with
143 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,128 +1,195 @@ | ||
| ## [简体中文](/README_CN.md) | ||
| # thprac | ||
| A tool for practicing Touhou Shmups | ||
| ## [Download](https://github.com/touhouworldcup/thprac/releases/latest) ([latest beta](https://nightly.link/touhouworldcup/thprac/workflows/main/master/thprac.zip)) | ||
| [](https://ko-fi.com/V7V7O03J4) | ||
|
|
||
| # How to use | ||
| Either: place the executable in the same folder as your game, and run it. The game must be updated to the latest version and the executable must have it's original filename (thXX.exe for most games, 東方紅魔郷.exe for Embodment of Scarlet Devil, alcostg.exe for Uwabami Breakers). Thprac will automatically detect vpatch. Steam versions will not work with this method. | ||
| # **thprac** | ||
| > thprac is a tool for practicing Touhou shmups. | ||
| Or: Run the game in whatever way you want (be it through thcrap, with vpatch, through Steam, etc...), then run the thprac exe. Thprac will automatically detect the running game and attach itself to it. You may need to return to the main menu for thprac to take effect. | ||
| [](https://ko-fi.com/V7V7O03J4) | ||
|
|
||
| Or: Use the launcher. This video explains how the launcher works. | ||
| # [Download](https://github.com/touhouworldcup/thprac/releases/latest) - [Download Beta](https://nightly.link/touhouworldcup/thprac/workflows/main/master/thprac.zip) | ||
| > Note that beta versions will only update to the next stable version, not the next beta version. | ||
| ## **Table of Contents** | ||
| * [Downloading](#downloading) | ||
| * [Usage](#usage) | ||
| * [Compatability](#compatability) | ||
| * [Features](#features) | ||
| * [Backspace Menu](#backspace-menu) | ||
| * [Advanced Options](#advanced-options) | ||
| * [Statistics](#statistics) | ||
| * [Game Specific Features](#game-specific-features) | ||
| * [Credits](#credits) | ||
| * [FAQ](#faq) | ||
|
|
||
| ## <a name="downloading"></a> **Downloading** | ||
| If you want to download the tool, you can download the [latest release](https://github.com/touhouworldcup/thprac/releases/latest) here and the [latest beta](https://nightly.link/touhouworldcup/thprac/workflows/main/master/thprac.zip) here. Do note that the latest beta will update into the next stable release and NOT the next beta release. | ||
|
|
||
| ## <a name="usage"></a> **Usage** | ||
| You can use this tool in a variety of ways; the main ways to do this are **placing the executable in the same folder as your game**, **running the executable after running your game**, or **using thprac's launcher**. | ||
|
|
||
| ### **thprac in the Game Folder** | ||
| **This method will NOT work with Steam games.** You can run thprac by placing the `thprac.exe` file in the same folder as your game. This method will also automatically detect vpatch. You must ensure that the game is updated to the latest version and follows one of the following naming schemes. This method also works with vpatch. | ||
| - thXX.exe (most games) | ||
| - 東方紅魔郷.exe (Embodiment of Scarlet Devil) | ||
| - alcostg.exe (Uwabami Breakers) | ||
|
|
||
| ### **thprac after Running the Game** | ||
| **This method will work for most methods.** First, run the game in whichever method you want (whether it's thcrap, using vpatch, Steam, etc.) and then run `thprac.exe`. thprac will then detect the running game and attempt to attach itself to it. You may have to return to the menu screen to see thprac take effect. | ||
|
|
||
| ### **thprac Using the Launcher** | ||
| This video explains how to use the launcher. | ||
| [](https://www.youtube.com/watch?v=sRV4PDQceYo) | ||
|
|
||
| ## Compatibility | ||
| thprac officially supports every version of Windows starting with **Windows Vista**. Windows XP may work using [One-Core-API](https://github.com/Skulltrail192/One-Core-API-Binaries), but this is NOT being actively tested. | ||
| ## <a name="compatability"></a> **Compatability** | ||
| thprac officially supports every version of Windows starting with **Windows Vista**. Windows XP may work using [One-Core-API](https://github.com/Skulltrail192/One-Core-API-Binaries), but this is **NOT** being actively tested. | ||
|
|
||
| thprac is also compatible with **Wine** and the Steam Deck. Do note that the backspace menu is tailored to work well with the Steam Deck, although this is untested. | ||
|
|
||
| **Wine** and the Steam Deck are also officially supported. Note that the backspace menu is also specifically coded to work well with the Steam Deck (not tested though cause I don't have a Steam Deck) | ||
| ## <a name="features"></a> **Features** | ||
| thprac features an enhanced practice mode that supports all main games along with Great Fairy Wars and Uwabami Breakers. | ||
|
|
||
| # Features | ||
| ## Enchanced practice mode (supports all main games, Great Fairy Wars and Uwabami Breakers. Does not support Phantasmagoria of Flower View) | ||
|  | ||
|  | ||
|
|
||
| It replaces the original practice menu with this UI. It also adds a practice menu to "Start Game" in Great Fairy Wars and Uwabami Breakers, which don't have a built in practice mode. On certain spells you can select phases or change certain parameters. | ||
|  | ||
|
|
||
| thprac replaces the original practice menu with a new UI shown in the image above; certain spells allow you to select phases or change certain parameters. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| The menu can be controlled with your keyboard or controller. With this method, you can select the option with UP or DOWN, and change the option with LEFT or RIGHT. You can also use the mouse. Press SHOT to confirm. | ||
| This menu can be controlled using your keyboard or your controller. Using this, you can select options using the **UP** and **DOWN** keys and change the option using the **LEFT** and **RIGHT** keys and the **SHOT** key to select. You can also use your mouse to interact with the menu. | ||
|
|
||
| Thprac will automatically save the options you input into this into any replay saved. When playing back the replay, thprac will automatically apply those options. **Replays saved when playing with thprac and the "Mode" set to "Custom" will not work with the unmodified game** | ||
| thprac will also automatically save the options you selected into any replay saved. When playing back the replay, thprac will automatically apply said options. **Replays saved while thprac is active using "Custom" mode will NOT work with the unmodified game.** | ||
|
|
||
| ## Backspace menu | ||
| In any supported game (except for TH09) you can press BACKSPACE to access the Backspace menu. It will show you options that can be activated with the F keys. | ||
| ## <a name="backspace-menu"></a> **Backspace Menu** | ||
| In any supported game **(except Touhou 9 and 19)**, you can press the **backspace** key to enter the backspace menu. This menu shows a variety of options that can be activated using the function (F) keys. | ||
|
|
||
| NOTE for Steam Deck users: these options are also **clickable**. This means that you can use your left thumb to tap the options to toggle them. Therefore, you only need to map backspace in Steam Input. | ||
| These options are always clickable, meaning you can interact with them using a mouse on a desktop computer or by tapping on them with your left thumb when using a Steam Deck. To use this feature on the Steam Deck, map the backspace key in Steam Input. | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Advanced options | ||
| In any supported game, you can press F12 to access the advanced options. | ||
|  | ||
|  | ||
| ## <a name="advanced-options"></a> **Advanced Options** | ||
| In any supported game, you may use the F12 key to access the advanced options; these options may offer fixes or patches related to the game or other quality of life features. | ||
|
|
||
| ## Statistics (WIP) | ||
| In TH13, press L to view a more advanced HUD | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Game specific features | ||
| ### TH185 Force Wave | ||
|  | ||
| ## <a name="game-specific-features"></a> **Game-specific Features** | ||
| ### 100th BM - Force Wave | ||
|  | ||
|
|
||
| If thprac is enabled ("Mode" is set to "Custom"), this popup will appear whenever the game is about to randomly choose a wave. | ||
| If thprac is enabled using "Custom" mode, the popup above will appear when the game is about to choose a wave. | ||
|
|
||
| ### TH09 Tools (for Phantasmagoria of Flower View) | ||
|  | ||
| ### PoFV - Tools | ||
|  | ||
|
|
||
| When starting a game in Match Mode, you can select "Custom" in a "Mode" prompt. If you do that, this window will appear in your game. It can be moved and resized as you want and can be fully hidden by pushing F11. | ||
| When starting a game in Match Mode, you can select "Custom" in a "Mode" prompt. If you do that, this window will appear in your game. You can move and adjust this window as much as you want. This window can be hidden by pressing the "F11" key. | ||
|
|
||
| ### TH19 Tools | ||
| ### UDoALG - Tools | ||
|  | ||
|
|
||
| It's just like TH09 Tools, but for TH19 | ||
| It's just like PoFV Tools, but for UDoALG. | ||
|
|
||
| ### TH06 pause menu | ||
| ### EoSD - Pause Menu | ||
|  | ||
| Choosing "Exit" will prompt you to save a replay. Warning: replays saved like this will keep going even after the point you chose to save the replay. The player character will stand still and not shoot. | ||
|
|
||
| Choosing "Exit" will now prompt you to save a replay. | ||
|
|
||
| **Warning**: replays saved like this will continue after the point you chose to save the replay. The player character will stand still and not shoot. | ||
|
|
||
| ### ESC + R fix for Violet Detector, Wily Beast and Weakest Creature and Unconnected Marketeers | ||
|
|
||
| # Credits (May 27th 2022 and after) | ||
| ## <a name="credits"></a> **Credits (post May 27th, 2022)** | ||
| - Development: [32th System](https://www.youtube.com/channel/UChyVpooBi31k3xPbWYsoq3w), [muter3000](https://github.com/muter3000), [zero318](https://github.com/zero318), [Lmocinemod](https://github.com/Lmocinemod), [Cao Minh](https://github.com/hoangcaominh), [raviddog](https://github.com/raviddog) | ||
| - Chinese translations: [CrestedPeak9](https://twitter.com/CrestedPeak9), maksim71_doll, DeepL | ||
| - Japanese translations: [Yu-miya](https://www.twitch.tv/toho_yumiya), CyrusVorazan, DeepL | ||
| - Transferring all reports from the [old bugtracker](https://github.com/ack7139/thprac/issues) to [here](https://github.com/touhouworldcup/thprac/issues): [toimine](https://www.youtube.com/channel/UCtxu8Rg0Vh8mX6iENenetuA) | ||
| - Chinese README translations: [TNT569](https://github.com/TNT569) | ||
| - Moving all reports from the [old bugtracker](https://github.com/ack7139/thprac/issues) [here](https://github.com/touhouworldcup/thprac/issues): [toimine](https://www.youtube.com/channel/UCtxu8Rg0Vh8mX6iENenetuA) | ||
| - English README.md: [Galagyy](https://github.com/Galagyy) | ||
| - Chinese README.md translations: [TNT569](https://github.com/TNT569) | ||
|
|
||
| ## <a name="faq"></a> **Frequently Asked Questions (FAQ)** | ||
|
|
||
| ## General | ||
|
|
||
| ### Why did thprac move? | ||
| The original developer, Ack, has indefinitely ceased all future development of thprac/Marketeer. Below is their statement: | ||
| > I will indefinitely cease all future development on thprac/Marketeer, you are free to continue working on it, granting that you follow the license's terms. | ||
| > Due to my insufficient skill, the code is glutted with obscure writings and terrible logic, turning the whole thing into a complete mess. I'm sorry if that disturbs you. | ||
| Ack cannot be contacted at this time, and development has been taken over by others. | ||
|
|
||
| --- | ||
|
|
||
| ### My antivirus says thprac is malware. Is it safe? | ||
| Thprac contains no malicious code, but its behavior may trigger your antivirus. If flagged, add an exception or trust rule in your antivirus to allow thprac to work. Alternatively, you can try [this version](https://github.com/touhouworldcup/thprac/issues/112) and report back if the issue persists. | ||
|
|
||
| --- | ||
|
|
||
| ## Compatibility | ||
|
|
||
| ### Does thprac work with English patches? | ||
| Thprac is compatible with **thcrap** and can function as a thcrap launcher, similar to the [Universal THCRAP Launcher](https://github.com/thpatch/Universal-THCRAP-Launcher/). It does not support static English patches, like those created by gensokyo.org. | ||
|
|
||
| --- | ||
|
|
||
| ### thprac cannot find Embodiment of Scarlet Devil. What should I do? | ||
| Ensure your executable is named either `東方紅魔郷.exe` or `th06.exe`. If thprac still fails to detect it, you can manually launch the game with any filename through the launcher, which will attach thprac to the game. | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| ### How do I save a replay mid-game in TH06-10? | ||
| Saving replays mid-game is not supported due to technical limitations. As per the thprac 2.0.8.3 manual: | ||
| > Because of how these games were programmed, adding this feature would be quite troublesome, so currently there's no direct solution to this. | ||
| However, EoSD now supports this functionality. | ||
|
|
||
| Note: replays saved mid-game do not return to the title screen after the save point. | ||
|
|
||
| --- | ||
|
|
||
| # How to build: | ||
| A Visual Studio solution is bundled that uses the Visual Studio 2022 build tools (v143) for building. However, thprac will compile perfectly fine with Visual Studio 2019 build tools (v142) as well. Your builds will support Windows XP perfectly fine, v141_xp build tools are not needed. | ||
| ### What does "Everlasting BGM" mean? | ||
| This option prevents the background music (BGM) from resetting when you restart the game. | ||
|
|
||
| If you add a new string to the codebase that needs to be localized, put it into thprac_games_def.json and use the [thprac devtools](https://github.com/touhouworldcup/thprac_utils) to generate a new thprac_locale_def.h | ||
| --- | ||
|
|
||
| # Q&A | ||
| ### What does "Coercive Reporting" mean? (Shoot the Bullet/Double Spoiler) | ||
| This feature locks the camera onto the boss at all times and eliminates the camera's recharge time. | ||
|
|
||
| ## Why did thprac move? | ||
| Ack has completely stopped thprac development and can not be contacted at the moment. This is the statement on his original repository | ||
| > I will indefinitely cease all future development on thprac/Marketeer, you are free to continue working on it, granting that you follow the license's terms. | ||
| > Due to my insufficient skill, the code is glutted with obscure writings and terrible logic, turning the whole thing into a complete mess. I'm sorry if that disturbs you. | ||
| --- | ||
|
|
||
| ## My antivirus says it's malware. It is really? | ||
| Thprac contains no malicious code, but due to how it works, an antivirus might complain about it. If your antivirus complains about thprac, add a trust/exception. Also try [this version](https://github.com/touhouworldcup/thprac/issues/112) and report back if your antivirus does not detect it | ||
| ### How do I switch languages? | ||
| - The launcher automatically selects its language based on your Windows settings. | ||
| - To change the language in-game, use the shortcuts: | ||
| - **ALT + 1**: Japanese | ||
| - **ALT + 2**: Chinese | ||
| - **ALT + 3**: English | ||
|
|
||
| ## English patch support | ||
| Thprac is compatible with thcrap. Thprac's launcher can act as a thcrap launcher as well, similair to [Universal THCRAP Launcher](https://github.com/thpatch/Universal-THCRAP-Launcher/). When launching a game with thcrap, thprac will be able to attach to it. Thprac is not compatible with static English patches, like the ones made by gensokyo.org | ||
| These shortcuts do not work in the launcher itself. Refer to the video in the **"How to Use"** section for detailed instructions. | ||
|
|
||
| ## Cannot find Embodiment of Scarlet Devil | ||
| Make sure your exe is named "東方紅魔郷.exe" or "th06.exe". If thprac still can't find it, the launcher can launch an exe with any filename and attach thprac. | ||
| --- | ||
|
|
||
| ## How do I save a replay mid-game in TH06TH07/TH08/TH10? | ||
| You can't. The thprac 2.0.8.3 manual says | ||
| > Because of how these games were programmed, adding this feature would be quite troublesome, so currently there's no direct solution to this | ||
| ## Bug Reporting | ||
|
|
||
| Recently, this feature was added to TH06. However, any replay saved mid game will not return to the title screen even after the point where you saved the replay. Consider this functionality "there and ready but still a bit quirky" | ||
| ### Where can I report bugs? | ||
| Visit the [Issues tab on GitHub](https://github.com/touhouworldcup/thprac/issues) to report bugs or suggest improvements. | ||
|
|
||
| ## What does "Everlasting BGM" mean? | ||
| It prevents the BGM from resetting when you reset the game | ||
| --- | ||
|
|
||
| ## What does "Coercive Reporting" mean? (Shoot the Bullet/Double Spoiler) | ||
| It locks the camera onto the boss at all time and removes the camera's recharge time | ||
| ## Technical Issues | ||
|
|
||
| ## How do I switch language? | ||
| Thprac will automatically set it's language to whatever you set in the launcher. It will automatically set the launcher's language based on your Windows language. The video in "How to use" explains how to change language in the launcher right at the start. With ALT + 1, 2 or 3 you can switch language in-game. This shortcut does not work in the launcher | ||
| ### Unsupported VsyncPatch version in advanced options | ||
| Ensure you're using a compatible version of VsyncPatch. You can download it from [here](https://maribelhearn.com/tools#vpatch). Use DLLs from **rev7** whenever possible. | ||
|
|
||
| ## Where to report bugs? | ||
| [Scroll up and click the "Issues" tabs. Alternatively, clicking this text will take you there](https://github.com/touhouworldcup/thprac/issues) | ||
| --- | ||
|
|
||
| ## It says "Unsupported VsyncPatch verson" in the advanced options | ||
| You can find a compatible version of vpatch [here](https://maribelhearn.com/tools#vpatch). Use DLLs from rev7 whenever you can | ||
| ### FPS adjustment seems to be broken when using vpatch | ||
| Some tools, like "DX8 to DX9 Converter," conflict with VsyncPatch. Replay speed adjustment (slowdown/speedup) is only supported in **TH13**. | ||
|
|
||
| ## FPS adjustment seems to be broken when using vpatch | ||
| Certain tools ("DX8 to DX9 Convertor" for example) conflict with VsyncPatch | ||
| --- | ||
|
|
||
| As for adjusting replay speedup and slowdown FPS: this functionality is only implemented in TH13 | ||
| ## Game-Specific | ||
|
|
||
| ## What is "DDC - Marisa Laser Related"? | ||
| It's an attempt to fix the infamous Marisa laser desync bug in Double Dealing Character | ||
| ### What is "DDC - Marisa Laser Related"? | ||
| This fixes the infamous Marisa laser desync bug in **Double Dealing Character (TH14)**. |