Touhou Patch Center:Download: Difference between revisions

From Touhou Patch Center
Jump to navigation Jump to search
m (Translatability! Hopefully.)
(Slightly rewritten troubleshooting, and better translation sections.)
Line 3: Line 3:
<translate>
<translate>
== Main Package (Multi-Language, Multi-Game) ==
== Main Package (Multi-Language, Multi-Game) ==
::[[File:Gnome-dev-zipdisk.svg|24px|link=]] <big>[[Media:thcrap.zip|Download from {{ns:4}}]] &bull; [[File:Gnome-dev-zipdisk.svg|24px|link=]] [https://github.com/thpatch/thcrap/releases/download/{{Image:thcrap.zip}}/thcrap_brliron.zip Download from GitHub]</big>
</translate>
:<big>'''Latest build: [[Media:thcrap.zip|{{Image:thcrap.zip}}]]'''</big>
::[[File:Gnome-dev-zipdisk.svg|24px|link=]] <big>[[Media:thcrap.zip|<translate>Download from {{ns:4}}</translate>]] &bull; [[File:Gnome-dev-zipdisk.svg|24px|link=]] [https://github.com/thpatch/thcrap/releases/download/{{Image:thcrap.zip}}/thcrap_brliron.zip <translate>Download from GitHub</translate>]</big>
:<span class="plainlinks">'''[[/Changelog|Changelog]]'''</span>
:<big>'''<translate>Latest build: [[Media:thcrap.zip|{{Image:thcrap.zip}}]]</translate>'''</big>
:'''Source code:''' [https://github.com/thpatch/thcrap @ GitHub]
:<span class="plainlinks">'''[[Special:MyLanguage/{{FULLPAGENAME}}/Changelog|<translate>Changelog</translate>]]'''</span>
:'''<translate>Source code:</translate>''' [https://github.com/thpatch/thcrap @ GitHub]


<translate>
== System Requirements ==
== System Requirements ==
* Windows XP with at least Service Pack 2, or a later version of Windows; also works with Wine
* Windows XP with at least Service Pack 2, or a later version of Windows; also works with Wine
Line 26: Line 28:
# Download Patch and unzip (directory does not have to be specified; feel free to place wherever you want)
# Download Patch and unzip (directory does not have to be specified; feel free to place wherever you want)
# Run <tt>thcrap_configure</tt> to find the Touhou games.
# Run <tt>thcrap_configure</tt> to find the Touhou games.
# Pick your language'''s'''.<br />Yes, plural. If you understand English to some degree, we recommend to ''always'' include <tt>lang_en</tt> at the bottom, and your native language on top of that. [[Project:Patch stacking|Read more on the topic of patch stacking here.]]
# Pick your language'''s'''.<br />Yes, plural. If you understand English to some degree, we recommend to ''always'' include <tt>lang_en</tt> at the bottom, and your native language on top of that. [[Special:MyLanguage/Project:Patch stacking|Read more on the topic of patch stacking here.]]
# Wait for the downloads to occur.
# Wait for the downloads to occur.
# In the browsing dialog, select the path where your Touhou games are located, or hit Cancel to search your whole system.
# In the browsing dialog, select the path where your Touhou games are located, or hit Cancel to search your whole system.
Line 34: Line 36:


=== Running on top of vpatch ===
=== Running on top of vpatch ===
This is possible as of the 2013-10-25 build. Unfortunately we can't automate such a setup due to the DLL-centric design of vpatch, so this requires a few manual steps:
This is possible as of the 2013-10-25 build. Due to the DLL-centric design of vpatch, thcrap_configure doesn't automate this yet, so this requires a few manual steps for now:


# In order to make {{GameLabel|th06}} run '''at all''', replace <tt>vpatch_th06.dll</tt> with our [[:File:vpatch_th06_unicode.zip|modified Unicode version]].
# In order to make {{GameLabel|th06}} run '''at all''', replace <tt>vpatch_th06.dll</tt> with our [[:File:vpatch_th06_unicode.zip|modified Unicode version]].
Line 44: Line 46:


===File Output===
===File Output===
Usage: To dump all the files used in a Touhou game as it runs. This is useful for locating a certain sprite name for image replacement as well as advanced patching.
This will dump all the original, unpatched files loaded by a game as it runs.


Steps:
Steps:
Line 55: Line 57:
Then, run the shortcut.
Then, run the shortcut.


===Steam===
===Steam integration===
Usage: To place the shortcuts into Steam. Full integration is one of our [[Development_notes/Future_ideas#Steam_Integration|contemplated ideas]].
We'd actually need a new guide how to do this at this place!
 
Steps: See [http://www.shrinemaiden.org/forum/index.php/topic,16308.msg1096948.html#msg1096948 here]


== Troubleshooting ==
== Troubleshooting ==
Line 73: Line 73:
:* If necessary, repeat this until you have no patches left. Note that running thcrap with no patches is still ''different'' from running the original, unpatched game. It still applies the game-independent features of thcrap, like its locale independence code or its propagation to child processes, onto the game, which might be the cause of your bug.
:* If necessary, repeat this until you have no patches left. Note that running thcrap with no patches is still ''different'' from running the original, unpatched game. It still applies the game-independent features of thcrap, like its locale independence code or its propagation to child processes, onto the game, which might be the cause of your bug.
:: If the bug still appears with no patches, you're done. But if you ''could'' identify a patch that caused your issue:
:: If the bug still appears with no patches, you're done. But if you ''could'' identify a patch that caused your issue:
::* Temporarily delete or rename <tt>thcrap_update.dll</tt> in the thcrap directory.
::* Temporarily delete or rename <tt>thcrap_update.dll</tt> in the thcrap directory in order to disable automatic updates.
::* Look at <tt>thcrap_log.txt</tt> and check which files '''of that patch''' are actually loaded by the game. These are indicated by lines beginning with a <tt> + </tt>.
::* Look at <tt>thcrap_log.txt</tt> and check which files '''of that patch''' are actually loaded by the game. These are indicated by lines beginning with a <tt> + </tt>.
::* Delete those files one by one, until the bug doesn't appear any more.
::* Delete those files one by one, until the bug doesn't appear any more.
Line 81: Line 81:


=== Known issues ===
=== Known issues ===
====My game isn't recognized by the configuration tool====
====My game isn't recognized by the configuration tool, and no shortcut is created====
Issue: The game does not create a shortcut to certain games.
If that game happens to be {{GameLabel|th06}} or any of the older fighting games ({{GameLabel|th075}}, {{GameLabel|th105}} or {{GameLabel|th123}}): thcrap does not support them yet.
 
Solution: If that game happens to be {{GameLabel|th06}} or any of the fighting games ({{GameLabel|th075}}, {{GameLabel|th105}}, {{GameLabel|th123}} or {{GameLabel|th135}}): thcrap does not support them yet.


Otherwise, please post the game's executable on either https://thpatch.net/w/logos/discord.png [https://discord.thpatch.net/ Discord] or https://thpatch.net/w/logos/irc.png our [https://webchat.freenode.net/?channels=#thcrap IRC channel] '''#thcrap''' on '''irc.freenode.net'''. We'll see what we can do.
Otherwise, please post the game's executable on either https://thpatch.net/w/logos/discord.png [https://discord.thpatch.net/ Discord] or https://thpatch.net/w/logos/irc.png our [https://webchat.freenode.net/?channels=#thcrap IRC channel] '''#thcrap''' on '''irc.freenode.net'''. We'll see what we can do.
Line 90: Line 88:
====Dialog====
====Dialog====


=====Blank text=====
=====Blank text when running on Wine=====
Issue: There is a known issue with Wine not displaying untranslated Japanese text. This is due to Wine's glyph replacement system not being sophisticated enough to use Japanese glyphs from a default system font in case the currently selected font (''[[:File:THBiolinum.otf|Touhou Biolinum]]'' for Latin script languages) does not contain Japanese glyphs, as is the case on Windows.
<!-- Don't translate this until a Linux user has confirmed that the second one is still an issue in recent Wine! Because maybe a Wine update is the simple solution here. -->
 
* First, try running thcrap on this game without selecting a translation patch, i.e., just using <tt>base_tsa</tt>. If you still get blank text, installing Japanese fonts for Wine should fix that.
Workaround: None. This is an issue in Wine.
* If you then still get blank text ''with a translation patch'', Wine's glyph replacement system is not sophisticated enough to use Japanese glyphs from a default system font in case the currently selected font (''[[:File:THBiolinum.otf|Touhou Biolinum]]'' for Latin script languages) does not contain Japanese glyphs.


=====Dialogue does not fit in text box=====
=====Dialogue does not fit in text box=====
Issue: In-game text cut off when characters are speaking.
Unfortunately, ZUN's engine has never been able to do automatic line breaks, and we don't want to combat this by having the wiki parser guess where to put a line break. This means that ''all of the line breaks have to be done manually''.
 
Solution: ZUN's engine has never been able to do automatic line breaks, and we don't want to combat this by having the wiki parser guess where to put a line break. This means that ''all of the line breaks have to be done manually''.


If you see such a line, just log in, look for the corresponding page and split it yourself. If it's a 3rd party patch, then e-mail the project leader about the issue, or tell them on GitHub or wherever they host their patch.
If you see such a line, just log in, look for the corresponding page and split it yourself. If it's a third-party patch, then e-mail the project leader about the issue, or tell them on GitHub or wherever they host their patch.


====Errors====
====Errors====


=====Could not load the function: thcrap_init=====
=====Could not load the function: thcrap_init=====
Issue: Error: Could not load the function: thcrap_init
We don't know yet what exactly this causes - if you have this problem, please get in touch with us so that we can debug it. Probably some antivirus. Reinstalling thcrap and the affected game seems to help.
 
Solution: We don't know yet what exactly this causes - if you have this problem, please get in touch with us so that we can debug it. Probably some antivirus. Reinstalling thcrap and the affected game seems to help.


=====Japanese text error=====
=====Japanese text error=====
[[File:The ZUN Mutex.png|frame|right|The ZUN Mutex]]
[[File:The ZUN Mutex.png|frame|right|The ZUN Mutex]]
Issue: You get an error message that looks the picture on the right.
The error to the right is shown whenever a Touhou game is started and there is another Touhou game process active, meaning that you cannot run two Touhou games at the same time. Check Task Manager for any zombie processes and kill them if necessary.
 
</translate>
Solution: You are running more than one game process, could be because you attempted to open another game while one is running or you have zombie game processes that are running. Open one game only if it's the former or open task manager and kill the zombie processes if it's the latter.
<div style="clear: both;">
 
<translate>
=====The translation is incomplete/missing=====
===== Some translations are incomplete or missing =====
Issue: The text is appearing in japanese.
Check the corresponding text page on this site; most likely, the translations there have not been finished yet.
 
Solution: This is not a bug; the translations on the wiki have not been finished yet, and we would need someone to complete the translations.


====Patch configuration====
====Patch configuration====
Line 124: Line 116:
=====Why does Patch X not work with Patch Y?=====
=====Why does Patch X not work with Patch Y?=====
[[File:Patch Used Wrong.png|thumb|right|Oops!]]
[[File:Patch Used Wrong.png|thumb|right|Oops!]]
Issue: When using a patch, some of the features mix together!
When you are using multiple patches, the order is important. For example one may want to use [https://github.com/Gamer251/thcrap-gamer251/tree/master/mima Gamer251's Mima patch] for the Mima sprite and dialog, the Alphes patch for Alphes-style art, and [[Patch:lang_en|our English patch]] to have the rest of the game translated to English. If one was to use the Mima patch first, then the Alphes patch, then the English one, they would discover that while the other patches were applied, the English title screen was applied to the Mima's custom title. So for a typical patch selection, the correct way to select a patch if it's not already not added for you (as seen with [https://github.com/Nazeo/thcrap-nazeo/tree/master/gangster Nazeo's gangster patch]) is using the main language first, then the mod.
 
</translate>
Solution: When you are using multiple patches, the order is important. For example one may want to use [https://github.com/Gamer251/thcrap-gamer251/tree/master/mima Gamer251's Mima patch] for the Mima sprite and dialog, the Alphes patch for Alphes-style art, and [[Patch:lang_en|our English patch]] to have the rest of the game translated to English. If one was to use the Mima patch first, then the Alphes patch, then the English one, they would discover that while the other patches were applied, the English title screen was applied to the Mima's custom title. So for a typical patch selection, the correct way to select a patch if it's not already not added for you (as seen with [https://github.com/Nazeo/thcrap-nazeo/tree/master/gangster Nazeo's gangster patch]) is using the main language first, then the mod.
<div style="clear: both;">
 
<translate>
====Updating====
====The patch does not seem to update.====
Issue: The game does not seem to update.
A complete, manual reinstallation of the latest thcrap version usually fixes this.
 
Solution: You are using an old version of thcrap. Download the most current version and this should resolve the issue.


====HALP====
====HALP====
Issue: Something not covered here? Everything just going wrong? We have the solution! (Most of the time)
Something not covered here? Everything just going wrong? We have the solution! (Most of the time.)


Solution: Please visit our https://thpatch.net/w/logos/discord.png [https://discord.thpatch.net/ Discord] or IRC channel '''#thcrap''' on '''[http://webchat.freenode.net/?channels=#thcrap irc.freenode.net]'''. Things we would need are OS, game, what you were doing, and the patcher's log file (<tt>thcrap_log.txt</tt>).
Please visit our https://thpatch.net/w/logos/discord.png [https://discord.thpatch.net/ Discord] or IRC channel '''#thcrap''' on '''[http://webchat.freenode.net/?channels=#thcrap irc.freenode.net]'''. Things we would need are OS, game, what you were doing, and the patcher's log file (<tt>thcrap_log.txt</tt>).


== Run configuration parameters ==
== Run configuration parameters ==
Line 164: Line 154:


===== Example: Disabling music title and spell card translations for a specific language =====
===== Example: Disabling music title and spell card translations for a specific language =====
</translate>
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
{
{
Line 173: Line 164:
},
},
</syntaxhighlight>
</syntaxhighlight>
 
<translate>
==== <tt>update</tt> ====
==== <tt>update</tt> ====
:Set to <tt>false</tt> to disable automatic updates for this patch.
:Set to <tt>false</tt> to disable automatic updates for this patch.

Revision as of 00:52, 25 September 2017



Project overview
About Tutorial FAQ Download Patch servers github.png Bug tracker Wiki security

Main Package (Multi-Language, Multi-Game)

Gnome-dev-zipdisk.svg Download from Touhou Patch CenterGnome-dev-zipdisk.svg Download from GitHub
Latest build: 2020-06-06
Changelog
Source code: @ GitHub

System Requirements

  • Windows XP with at least Service Pack 2, or a later version of Windows; also works with Wine
  • Internet connection only required for initial configuration and updating; without a connection, thcrap will simply use the last downloaded state

Setup Instructions

Image walkthrough (slightly outdated, though)

Video walkthrough

Concise

  • First of all, you don't need to extract this into a specific game directory. The patcher can run from any directory.
  • Run thcrap_configure.exe and follow the instructions to create your patch configuration.
  • You'll end up with a .js file (the configuration itself) as well as links to start every Touhou game found on your system with this configuration. Note that thcrap does not modify any existing Touhou installation on your system.

Detailed

  1. Download Patch and unzip (directory does not have to be specified; feel free to place wherever you want)
  2. Run thcrap_configure to find the Touhou games.
  3. Pick your languages.
    Yes, plural. If you understand English to some degree, we recommend to always include lang_en at the bottom, and your native language on top of that. Read more on the topic of patch stacking here.
  4. Wait for the downloads to occur.
  5. In the browsing dialog, select the path where your Touhou games are located, or hit Cancel to search your whole system.
  6. Select your preferred version out of the Touhou games with multiple versions on your system.
  7. Use shortcuts.
  8. Enjoy.

Running on top of vpatch

This is possible as of the 2013-10-25 build. Due to the DLL-centric design of vpatch, thcrap_configure doesn't automate this yet, so this requires a few manual steps for now:

  1. In order to make Icon th06.png Embodiment of Scarlet Devil run at all, replace vpatch_th06.dll with our modified Unicode version.
  2. Configure your patch stack as usual. If you have multiple versions of the games installed, it is merely important to choose the correct directory at this point.
  3. Open the generated games.js in a plaintext editor, and replace the game's .exe file names with vpatch.exe (or whatever the local vpatch executable is called).
  4. Starting the games through the shortcuts will then launch thcrap, vpatch and the game itself. thcrap will automatically enable support for Japanese characters and file names, so AppLocale is not required (yes, not even for 東方紅魔郷.exe).

Tricks

File Output

This will dump all the original, unpatched files loaded by a game as it runs.

Steps:

  1. Locate the .js file that is created when you run thcrap_configure.exe (this would be whatever you named your shortcuts, so if you called your shortcut "en" then the .js file will also be called en.js).
  2. Open it with your text editor (notepad, editpadpro, etc)
  3. Change "dat_dump": false to either
  • "dat_dump": true - this will output files to wherever you placed your original game, in a folder called dat
  • "dat_dump": "C:/name/to/dump/path/" - this will output files into the given directory.

Then, run the shortcut.

Steam integration

We'd actually need a new guide how to do this at this place!

Troubleshooting

How to debug a game crash, freeze, or other issue unrelated to translation

A complete patch setup is made up of a number of individual parts, any one of which will be responsible for the issue you're experiencing. If possible, please try to pin down the cause before reporting an issue to us.

  • Does the issue appear in the original, unpatched game?
While thcrap fixes some of the bugs in the original games as part of its patch support, we sadly don't have the capacities to fix all of them, as we are mostly busy with thcrap's own bugs and features, first and foremost. Still, please report the issue, maybe it is trivial enough that one of our developers can look at it and fix it fairly quickly.
  • Try removing patches from your stack, one by one, starting at the bottom.
  • To do this, edit the run configuration .js file generated by thcrap_configure in a plaintext editor like Notepad.
For example, if you only selected the English translation, you'd edit en.js (or whatever you've named it). You'd first remove the
, { "archive": "thpatch/lang_en/" }
section, then check whether that fixed your error, using your existing shortcuts or launchers. If it didn't, remove the next patch, and so on.
If you are unfamiliar with JSON, use JSONLint or JSON Formatter to verify the syntax of your edited file. This site also gives you helpful error messages if you e.g. left a comma at the end of the "patches" section.
  • If necessary, repeat this until you have no patches left. Note that running thcrap with no patches is still different from running the original, unpatched game. It still applies the game-independent features of thcrap, like its locale independence code or its propagation to child processes, onto the game, which might be the cause of your bug.
If the bug still appears with no patches, you're done. But if you could identify a patch that caused your issue:
  • Temporarily delete or rename thcrap_update.dll in the thcrap directory in order to disable automatic updates.
  • Look at thcrap_log.txt and check which files of that patch are actually loaded by the game. These are indicated by lines beginning with a + .
  • Delete those files one by one, until the bug doesn't appear any more.
These files will be re-downloaded once you restore thcrap_update.dll.

Known issues

My game isn't recognized by the configuration tool, and no shortcut is created

If that game happens to be Icon th06.png Embodiment of Scarlet Devil or any of the older fighting games (Icon th075.png Immaterial and Missing Power, Icon th105.png Scarlet Weather Rhapsody or Icon th123.png Touhou Hisoutensoku): thcrap does not support them yet.

Otherwise, please post the game's executable on either discord.png Discord or irc.png our IRC channel #thcrap on irc.freenode.net. We'll see what we can do.

Dialog

Blank text when running on Wine
  • First, try running thcrap on this game without selecting a translation patch, i.e., just using base_tsa. If you still get blank text, installing Japanese fonts for Wine should fix that.
  • If you then still get blank text with a translation patch, Wine's glyph replacement system is not sophisticated enough to use Japanese glyphs from a default system font in case the currently selected font (Touhou Biolinum for Latin script languages) does not contain Japanese glyphs.
Dialogue does not fit in text box

Unfortunately, ZUN's engine has never been able to do automatic line breaks, and we don't want to combat this by having the wiki parser guess where to put a line break. This means that all of the line breaks have to be done manually.

If you see such a line, just log in, look for the corresponding page and split it yourself. If it's a third-party patch, then e-mail the project leader about the issue, or tell them on GitHub or wherever they host their patch.

Errors

Could not load the function: thcrap_init

We don't know yet what exactly this causes - if you have this problem, please get in touch with us so that we can debug it. Probably some antivirus. Reinstalling thcrap and the affected game seems to help.

Japanese text error
The ZUN Mutex

The error to the right is shown whenever a Touhou game is started and there is another Touhou game process active, meaning that you cannot run two Touhou games at the same time. Check Task Manager for any zombie processes and kill them if necessary.

Some translations are incomplete or missing

Check the corresponding text page on this site; most likely, the translations there have not been finished yet.

Patch configuration

Why does Patch X not work with Patch Y?
Oops!

When you are using multiple patches, the order is important. For example one may want to use Gamer251's Mima patch for the Mima sprite and dialog, the Alphes patch for Alphes-style art, and our English patch to have the rest of the game translated to English. If one was to use the Mima patch first, then the Alphes patch, then the English one, they would discover that while the other patches were applied, the English title screen was applied to the Mima's custom title. So for a typical patch selection, the correct way to select a patch if it's not already not added for you (as seen with Nazeo's gangster patch) is using the main language first, then the mod.

The patch does not seem to update.

A complete, manual reinstallation of the latest thcrap version usually fixes this.

HALP

Something not covered here? Everything just going wrong? We have the solution! (Most of the time.)

Please visit our discord.png Discord or IRC channel #thcrap on irc.freenode.net. Things we would need are OS, game, what you were doing, and the patcher's log file (thcrap_log.txt).

Run configuration parameters

Root level

dat_dump

Dumps original game data from the .dat archive as it's loaded.
As of the 2013-07-29 build, this also dumps the sprite boundaries for all graphic files.
values: false to disable, directory string to specify directory, anything else will enable dumping into game directory/dat

console

Enables or disables the on-screen patch debugging console.
values: true / false

font

Changes the font used in the game to any other font installed on your system.
values: string

Patch level

archive

Specifies the base directory of this patch. Must end in a forward slash (/).
As of the 2014-01-03 build, this can be a directory relative to the one the run configuration is stored in.
value: string

ignore

Ignores any files from this patch that match the given wildcard.
value: array of strings
Example: Disabling music title and spell card translations for a specific language
{
	"archive": "thpatch/lang_en/"
},
{
	"archive": "thpatch/lang_pt-br/",
	"ignore": ["*themes.js", "*spells.js"]
},

update

Set to false to disable automatic updates for this patch.
value: true/false

Alternatively, you can safely delete thcrap_update.dll after configuration to remove all on-line functionality.