Umineko Catbox English Mod Switch: Difference between revisions

Umineko Catbox English Mod
Umineko Catbox English Mod
General
Author	andOlga
Type	Translations
Version	82.7.2
License	Mixed
Last Updated	2023/10/17
Links
	Download
	Website
	Source

Latest revision as of 23:38, 27 Haziran 2024

This is an English patch for Umineko When They Cry: The Symphony of Catbox and Dreams (うみねこのなく頃に咲～猫箱と夢想の交響曲～), the console version of Umineko on the Switch.

Note that this is meant to be used on the actual console release of the game. It is not a standalone application, the patch and instructions are on the official website.

Installation

The game, and this patch, can be played on the following devices/platforms:

PCs, using yuzu or Ryujinx.
Macs, using Ryujinx.
Android devices, using yuzu.
Hackable Switches, using Atmosphère.

No matter the platform you play on, you will need a copy of the base game and the decryption keys for it. Game updates are optional, the patch applies cleanly regardless of the game's version.

You can purchase the game and dump it using nxdumptool from a hackable Switch to obtain a legal copy for emulation.

On PC (yuzu)

The Switch emulator yuzu is compatible with the game and the patch.

To set yuzu up, you will need a copy of the prod.keys file dumped from a hackable Switch and the game itself. Once you have acquired the keys, navigate to File > Open yuzu folder, then find the subfolder called "keys" inside that and paste the file there. Restart yuzu and double-click the giant empty rectangle in the main yuzu window to add your game folder.

To install the patch, download the yuzu version of the patch from the releases page, then right-click the game in yuzu, choose "Open Mod Data Location" and extract the entire archive there.

You may now start the game in yuzu and play it in English.

On PC/Mac (Ryujinx)

The Switch emulator Ryujinx is compatible with the game and the patch.

To set Ryujinx up, you will need a copy of the prod.keys file dumped from a hackable Switch, the Switch firmware, and the game itself. Having acquired these, you may follow their guide to finish your configuration and add the game to the emulator, but please ignore the "Managing mods" section as this patch has a somewhat more complicated structure and cannot be simply added to a per-game folder like they recommend.

To install the patch, download the Atmosphère version of the patch from the releases page (Ryujinx is 100% Atmosphère-compatible), then choose File > Open Ryujinx Folder. Navigate to the "mods" directory and extract the entire archive to that location. If the "mods" directory does not exist, create it first.

You may now start the game in Ryujinx and play it in English.

On Android (yuzu)

Some Android devices may be able to run the game using yuzu's Android port, though the current system requirements are rather high by Android standards: the device has to have a Snapdragon CPU and at least 8GB of RAM.

Just like on PC, you will need a copy of the prod.keys file. yuzu will ask you for its location on its first run. It will also ask you to specify the folder in which the game is located. For performance reasons, it is recommended not putting the game on an SD card unless you absolutely have to, keep it in your internal storage.

Once the initial setup is done, run the base game (in Japanese) at least once and exit it. This will allow you to confirm that your device can actually run the game, and also create some required files necessary for the patch installation to work.

You may now download the yuzu version of the patch from the releases page, and extract it somewhere on your device.

Now return to yuzu, and in the settings menu tap "Open yuzu folder". Pull out the menu on the left, switch to "Internal Storage" (or "SD Card") and find the extracted mod files. Tap and hold the UminekoCatboxEnglish folder to select it, and choose "Copy to..." from the kebab menu on top. Pull out the left panel again, tap "yuzu" and navigate to load/01006A300BA2C000/, then click the "Copy" button to install the patch.

The next time you start the game, it will be in English.

On the Switch (actual hardware)

If you want to play the game on your Switch hardware, it will need Atmosphère installed on it. If you don't have Atmosphère already, please see if it's compatible with your Switch model and install it if it is.

Afterwards, download the Atmosphère version of the patch from the releases page and copy it to the "atmosphere" folder on your SD card. The next time the game starts, it should be in English.

User guide

Alternative translations

There are a number of translations of Umineko to other languages that are based on this patch.

If you wish to create your own fan translation, please check the documentation here.

Changelog

v82.7.2

This is it. After so many long, painful years, full of tears, regret, anger and conflict, it is done.

v10.5.0

This release includes translation- and text-related bugfixes for Saku02.
However, I've only gotten about halfway through the chapter, so some of the later parts may still have issues. Please do not report these, I will get to them eventually.
I am so tired now... After so many years, this will take... just a short while more. Please have patience. The next release, or, at worst, the one after that, should finally take care of everything.

v10.4.0

This releases finalizes the UI updates that have been worked on over the course of the last few months.
All the menus have been overhauled to have better readability, design, and font consistency with the original game.
Special thanks to @DerJaybe for this undertaking, as my graphic editing "skills" would never allow for creating something like this.

Credits

Besides me (&Olga), the following people have directly contributed to this project:

My beloved heart, Tara, who was the brightest star that ever shone in my life. Rest in peace, my love.
@DoctorDiablo, translating the Witch Hunter's Interview Tape story.
@silverwolf-waltz, helping port over the translations for Hane and Saku.
@Quplet, providing help with porting some of the main episodes.
LHCollider, helping with testing.

Furthermore, this patch would be impossible without the resources and tools provided by the following projects:

kaleido by Neurochitin, which can decompile and recompile the SNR script format used by the game, as well as generate the patch.rom files that can be used to replace files in the base game.
enter_extractor by TellowKrinkle, which can extract files from the base game's data.rom format, as well as generate pic and txa files used to store the game's images.
HigurashiENX by MasaGratoR, which is a similar translation patch for the Switch version of Higurashi. Specifically, the IPS patch generation scripts from that project were used to translate some of the text hardcoded into the executables of the game.
Umineko Project, a similar translation work done for the PS3 version of Umineko, which serves as the base for the translated script and images used in the patch.
Umineko Tsubasa English Patch, which served as the initial source for the translation of the Tsubasa arcs present in the PC version (these were heavily edited to be consistent with the main story as well as with each other).
ArsMagica's English patch for Hane, now lost to time, which served as the initial source for the translation of the Hane arcs.
The 07th-Expansion wiki, which had a translation for Our Confession as well as most of the new Tsubasa stories.
A random person who just showed up on the Hinamizawa Discord one day with the nickname of "last-note", dumped a full translation of Last Note, and left.
The original translation of the PC version of Umineko by The Witch Hunt. While their work isn't being used directly, without these people Umineko would have never made it to the West in any form at all.
And, of course, the game itself, created by 07th-Expansion and producted (sic) by Entergram. Please buy the game on the eShop to support the creators.
- You can technically also buy the game on PSN, though that version isn't fully compatible with the patch, and the parts that may be compatible (romfs changes) are untested. If you get that one, you're on your own in trying to get it to run.
- There are also a few various versions of Umineko native to PC. How good they are varies depending on the version you dig up, but none of them properly support the creators, none of them are compatible with this patch, and all of them have various missing content compared to the console release of the game.
  - This includes the Steam version, as it is a re-release of the old indie version of Umineko, and as such does not include any of the console version's improvements. Because of this, buying this release does not help support the creators of the console version in any way, though it does help support the author and the original creator of the series, Ryukishi07. The Steam version is also not compatible with this patch.

External links

Official website - https://andolga.github.io/umineko-catbox-english/
GitHub - https://github.com/andOlga/umineko-catbox-english

@@ Line 1: / Line 1: @@
 {{Infobox Switch Homebrews
 |title=Umineko Catbox English Mod
-|image=uminekocatboxenglishmodswitch.png
+|image=uminekocatboxenx.png
 |description=English patch for Umineko Catbox.
 |author=andOlga
-|lastupdated=2023/05/01
+|lastupdated=2023/10/17
 |type=Translations
-|version=v10.0.1
+|version=82.7.2
 |license=Mixed
-|download=https://github.com/andOlga/umineko-catbox-english/releases
+|download=https://dlhb.gamebrew.org/switchhomebrews/uminekocatboxenx.7z
-|website=https://github.com/andOlga/umineko-catbox-english
+|website=https://andolga.github.io/umineko-catbox-english/
 |source=https://github.com/andOlga/umineko-catbox-english
 |donation=
 }}
-{{#seo:
+<!--Direct link only do not reupload-->
-|title=Switch Rom Hacks (Translations) - GameBrew
+This is an English patch for Umineko When They Cry: The Symphony of Catbox and Dreams (うみねこのなく頃に咲 ～猫箱と夢想の交響曲～), the console version of Umineko on the Switch.
-|title_mode=append
-|image=uminekocatboxenglishmodswitch.png
+Note that this is meant to be used on the actual console release of the game. It is not a standalone application, the patch and instructions are on the [https://andolga.github.io/umineko-catbox-english/ official website].
-|image_alt=Umineko Catbox English Mod
-}}
+==Installation==
-The English patch for Umineko Catbox is a translation patch for the console version of Umineko When They Cry: The Symphony of Catbox and Dreams, which includes Episodes 1 through 8, all content from Tsubasa, Hane, and Saku, as well as 4 new exclusive stories. The patch is meant to be used on the actual console release of the game and is not a standalone application.
+The game, and this patch, can be played on the following devices/platforms:
+*PCs, using yuzu or Ryujinx.
+*Macs, using Ryujinx.
+*Android devices, using yuzu.
+*Hackable Switches, using Atmosphère.
+No matter the platform you play on, you will need a copy of the base game and the decryption keys for it. Game updates are optional, the patch applies cleanly regardless of the game's version.
+You can [https://store-jp.nintendo.com/list/software/70010000012343.html purchase the game] and dump it using [[NXDumpTool Switch|nxdumptool]] from a hackable Switch to obtain a legal copy for emulation.
+===On PC (yuzu)===
+The Switch emulator [https://yuzu-emu.org/ yuzu] is compatible with the game and the patch.
+To set yuzu up, you will need a copy of the <code>prod.keys</code> file dumped from a hackable Switch and the game itself. Once you have acquired the keys, navigate to File > Open yuzu folder, then find the subfolder called "keys" inside that and paste the file there. Restart yuzu and double-click the giant empty rectangle in the main yuzu window to add your game folder.
+To install the patch, download the yuzu version of the patch from the releases page, then right-click the game in yuzu, choose "Open Mod Data Location" and extract the entire archive there.
+You may now start the game in yuzu and play it in English.
+===On PC/Mac (Ryujinx)===
+The Switch emulator [https://ryujinx.org/ Ryujinx] is compatible with the game and the patch.
-==Description==
+To set Ryujinx up, you will need a copy of the <code>prod.keys</code> file dumped from a hackable Switch, the Switch firmware, and the game itself. Having acquired these, you may [https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide follow their guide] to finish your configuration and add the game to the emulator, but please ignore the "Managing mods" section as this patch has a somewhat more complicated structure and cannot be simply added to a per-game folder like they recommend.
-The translation patch was made possible due to the resources and tools provided by various projects. These include kaleido by Neurochitin, which can decompile and recompile the SNR script format used by the game, as well as generate the patch.rom files that can be used to replace files in the base game. enter_extractor by TellowKrinkle, which can extract files from the base game's data.rom format, as well as generate pic and txa files used to store the game's images . HigurashiENX by MasaGratoR, which is a similar translation patch for the Switch version of Higurashi. Specifically, the IPS patch generation scripts from that project were used to translate some of the text hardcoded into the executables of the game. Umineko Project, a similar translation work done for the PS3 version of Umineko, which serves as the base for the translated script and images used in the patch. ArsMagica's English patch for Hane, which served as the initial source for the translation of the Hane arcs.
-The original translation of the PC version of Umineko by The Witch Hunt also played a significant role in the creation of the patch. Although their work isn't being used directly, without these people Umineko would have never made it to the West in any form at all. It is important to note that the Steam version of the game is not compatible with this patch in any way and is significantly inferior to the console releases (no voice acting, worse visuals, worse UI, missing content). Therefore, it is recommended to buy the game on the eShop or PSN to support the creators.
+To install the patch, download the Atmosphère version of the patch from the releases page (Ryujinx is 100% Atmosphère-compatible),
+then choose File > Open Ryujinx Folder. Navigate to the "mods" directory and extract the entire archive to that location. If the "mods" directory does not exist, create it first.
-The patch is available in two versions, the master branch, and the rebirth branch. The master branch is left untouched, save for a notice at the top, and is meant to preserve the imperfections of the patch, including various minor text issues here and there. On the other hand, the rebirth branch is where all new development on the project shall happen. The rebirth branch focuses on fixing the remaining text issues, improving the quality of the translation, and making it more consistent.
+You may now start the game in Ryujinx and play it in English.
-It is worth noting that while the rebirth branch aims to improve the translation quality, some fans prefer the original patch, including its imperfections. Therefore, there is a tradeoff between having a more polished translation, and preserving the original experience. Ultimately, the choice between the master and rebirth branch comes down to personal preference.
+===On Android (yuzu)===
+Some Android devices may be able to run the game using [https://play.google.com/store/apps/details?id=org.yuzu.yuzu_emu yuzu's Android port], though the current system requirements are rather high by Android standards: the device has to have a Snapdragon CPU and at least 8GB of RAM.
-==Applying the patch==
+Just like on PC, you will need a copy of the <code>prod.keys</code> file. yuzu will ask you for its location on its first run. It will also ask you to specify the folder in which the game is located. For performance reasons, it is recommended not putting the game on an SD card unless you absolutely have to, keep it in your internal storage.
-You can play the game and install the patch on either a PC or a hackable Nintendo Switch with Atmosphère. If playing on PC, you have the option to use either Ryujinx or Yuzu emulator, both of which have been tested with the patch and work well. To begin, follow the instructions below.
-Keep in mind that to play on PC, you will need to acquire an NSP of the base game and add it to your emulator. To ensure compliance with US laws, you must purchase the game on the [https://store-jp.nintendo.com/list/software/70010000012343.html eShop] and dump it using [[NXDumpTool Switch]] from a hackable Nintendo Switch to obtain a legal copy for emulation. It is important to note that software distribution laws may vary in other countries.
+Once the initial setup is done, run the base game (in Japanese) at least once and exit it. This will allow you to confirm that your device can actually run the game, and also create some required files necessary for the patch installation to work.
-===On PC (using Ryujinx)===
+You may now download the yuzu version of the patch from the releases page, and extract it somewhere on your device.
-[https://ryujinx.org/ Ryujinx], the Nintendo Switch emulator, can run both the game and its patch. To set up the emulator, you will need the <code>prod.keys</code> file, the Nintendo Switch firmware, and the game. Once you have acquired these files, you can refer to [https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide their guide] on setting up and configuring Ryujinx, but keep in mind that the "Managing mods" section does not apply to this patch, which has a more complex structure and cannot be added to a per-game folder as recommended.
-To install the patch on Ryujinx, first download the Atmosphère version (Ryujinx is fully compatible with Atmosphère) from [https://github.com/andOlga/umineko-catbox-english/releases/latest/download/patch_atmos.zip here]. Next, select "File" -> "Open Ryujinx Folder" and navigate to the "mods" directory. Extract the entire patch archive to this location. If the "mods" directory does not exist, create it before extracting the files.
+Now return to yuzu, and in the settings menu tap "Open yuzu folder". Pull out the menu on the left, switch to "Internal Storage" (or "SD Card") and find the extracted mod files. Tap and hold the <code>UminekoCatboxEnglish</code> folder to select it, and choose "Copy to..." from the kebab menu on top. Pull out the left panel again, tap "yuzu" and navigate to <code>load/01006A300BA2C000/</code>, then click the "Copy" button to install the patch.
-===On PC (using Yuzu)===
+The next time you start the game, it will be in English.
-[https://yuzu-emu.org Yuzu], another emulator for the Nintendo Switch, is capable of running the game and its patch. To use Yuzu, you will need a copy of the "prod.keys" file that is extracted from a hackable Nintendo Switch and the game itself. After obtaining the keys, open Yuzu and navigate to File -> Open Yuzu folder. Then, locate or create a subfolder called "keys" and paste the "prod.keys" file there. Restart Yuzu and add your game folder by double-clicking the empty rectangle in the main Yuzu window.
-To install the patch on Yuzu, download the Yuzu version from this link: https://github.com/andOlga/umineko-catbox-english/releases/latest/download/patch_yuzu.zip. Next, right-click on the game in Yuzu and select "Open Mod Data Location". Extract the entire archive there.
+===On the Switch (actual hardware)===
+If you want to play the game on your Switch hardware, it will need [[Atmosphere Switch|Atmosphère]] installed on it. If you don't have Atmosphère already, please see if it's compatible with your Switch model and install it if it is.
-===On Nintendo Switch (the actual hardware)===
+Afterwards, download the Atmosphère version of the patch from the releases page and copy it to the "atmosphere" folder on your SD card. The next time the game starts, it should be in English.
-To play the game on your Nintendo Switch, you will require [[Atmosphere Switch]] installed on your device. Check if your Switch model is compatible with Atmosphère and install it if you haven't already. Then, download the Atmosphère version of the patch from [https://github.com/andOlga/umineko-catbox-english/releases/latest/download/patch_atmos.zip here] and copy it to the "atmosphere" folder located in your SD card. Once done, the game will start in English on the next launch.
-==Media==
+==User guide==
-'''Umineko No Naku Koro Ni Saku Op ~ Kasaneawase no Nekobako by Sasaki Rico ~ English Subtitles - ([https://www.youtube.com/watch?v=7vfnLOOlpVA Clockwork Magic])'''<br>
+===Alternative translations===
-<youtube>7vfnLOOlpVA</youtube>
+There are a number of [https://github.com/andOlga/umineko-catbox-english/forks translations of Umineko to other languages] that are based on this patch.
-==Want to Contribute?==
+If you wish to create your own fan translation, please check the documentation [https://github.com/andOlga/umineko-catbox-english/blob/rebirth/CONTRIBUTING.md here].
-Click [https://github.com/andOlga/umineko-catbox-english/blob/rebirth/CONTRIBUTING.md here] for those who want to contribute to the Umineko When They Cry patch or create translations.
 ==Changelog==
-'''v10.0.1'''
+'''v82.7.2'''
-* This release restores a missing voiceline in Saku01.
+*This is it. After so many long, painful years, full of tears, regret, anger and conflict, it is done.
-'''v10.0.0'''
+'''v10.5.0'''
-*This release includes some fairly minor text fixes for the first Saku story.
+* This release includes translation- and text-related bugfixes for Saku02.
-*It also marks the beginning of a new series of fixes all throughout the patch, hoping to bring it up to the highest standard possible. The release cadence is likely going to be quite slow, as it's difficult for me to bring myself to work on this patch at this point. However, please look forward to more in the future.
+* However, I've only gotten about halfway through the chapter, so some of the later parts may still have issues. Please do not report these, I will get to them eventually.
+* I am so tired now... After so many years, this will take... just a short while more. Please have patience. The next release, or, at worst, the one after that, should finally take care of everything.
+'''v10.4.0'''
+* This releases finalizes the UI updates that have been worked on over the course of the last few months.
+* All the menus have been overhauled to have better readability, design, and font consistency with the original game.
+* Special thanks to @DerJaybe for this undertaking, as my graphic editing "skills" would never allow for creating something like this.
 ==Credits ==
-Besides me, the following people have ''directly'' contributed to this project:
+Besides me (&Olga), the following people have directly contributed to this project:
 * My beloved heart, Tara, who was the brightest star that ever shone in my life. Rest in peace, my love.
-* [[/github.com/doctordiablo|@DoctorDiablo]], translating the Witch Hunter's Interview Tape story.
+* [https://www.github.com/doctordiablo @DoctorDiablo], translating the Witch Hunter's Interview Tape story.
-* [[/github.com/silverwolf-waltz|@silverwolf-waltz]], helping port over the translations for Hane and Saku.
+* [https://www.github.com/silverwolf-waltz @silverwolf-waltz], helping port over the translations for Hane and Saku.
-* [[/github.com/quplet|@Quplet]], providing help with porting some of the main episodes.
+* [https://www.github.com/quplet @Quplet], providing help with porting some of the main episodes.
 * [https://www.youtube.com/lhcollider LHCollider], helping with testing.
-Furthermore, this patch would be impossible without the resources and tools provided by the the following projects:
+Furthermore, this patch would be impossible without the resources and tools provided by the following projects:
 * [https://gitlab.com/Neurochitin/kaleido/-/tree/saku/ kaleido] by Neurochitin, which can decompile and recompile the SNR script format used by the game, as well as generate the <code>patch.rom</code> files that can be used to replace files in the base game.
 * [https://github.com/07th-mod/enter_extractor enter_extractor] by TellowKrinkle, which can extract files from the base game's <code>data.rom</code> format, as well as generate <code>pic</code> and <code>txa</code> files used to store the game's images.
 * [https://github.com/masagrator/HigurashiENX HigurashiENX] by MasaGratoR, which is a similar translation patch for the Switch version of Higurashi. Specifically, the IPS patch generation scripts from that project were used to translate some of the text hardcoded into the executables of the game.
 * [https://umineko-project.org Umineko Project], a similar translation work done for the PS3 version of Umineko, which serves as the base for the translated script and images used in the patch.
-* [https://uminekotsubasa.github.io/ Umineko Tsubasa English Patch], which served as the initial source for the translation of the Tsubasa arcs present in the PC version (these were ''heavily'' edited to be consistent with the main story as well as with each other).
+* [https://uminekotsubasa.github.io/ Umineko Tsubasa English Patch], which served as the initial source for the translation of the Tsubasa arcs present in the PC version (these were heavily edited to be consistent with the main story as well as with each other).
 * ArsMagica's English patch for Hane, now lost to time, which served as the initial source for the translation of the Hane arcs.
 * [https://07th-expansion.fandom.com/wiki/07th_Expansion_Wiki The 07th-Expansion wiki], which had a translation for Our Confession as well as most of the new Tsubasa stories.
@@ Line 83: / Line 104: @@
 * The original translation of the PC version of Umineko by [https://witch-hunt.com The Witch Hunt]. While their work isn't being used directly, without these people Umineko would have never made it to the West in any form at all.
 * And, of course, the game itself, created by 07th-Expansion and producted (sic) by Entergram. Please buy the game on the [https://store-jp.nintendo.com/list/software/70010000012343.html eShop] to support the creators.
-** You can ''technically'' also buy the game on [https://store.playstation.com/ja-jp/product/JP0741-CUSA16973_00-UMINEKOSAKUZZZZZ PSN], though that version isn't fully compatible with the patch, and the parts that ''may be'' compatible (romfs changes) are untested. If you get that one, you're on your own in trying to get it to run.
+** You can technically also buy the game on [https://store.playstation.com/ja-jp/product/JP0741-CUSA16973_00-UMINEKOSAKUZZZZZ PSN], though that version isn't fully compatible with the patch, and the parts that may be compatible (romfs changes) are untested. If you get that one, you're on your own in trying to get it to run.
 ** There are also a few various versions of Umineko native to PC. How good they are varies depending on the version you dig up, but none of them properly support the creators, none of them are compatible with this patch, and all of them have various missing content compared to the console release of the game.
-*** This includes the Steam version, as it is a re-release of the old indie version of Umineko, and as such does not include any of the console version's improvements. Because of this, buying this release does not help support the creators of the console version in any way, though it ''does'' help support the author and the original creator of the series, Ryukishi07. The Steam version is also not compatible with this patch.
+*** This includes the Steam version, as it is a re-release of the old indie version of Umineko, and as such does not include any of the console version's improvements. Because of this, buying this release does not help support the creators of the console version in any way, though it does help support the author and the original creator of the series, Ryukishi07. The Steam version is also not compatible with this patch.
 == External links ==
-* Github - https://github.com/andOlga/umineko-catbox-english
+* Official website - https://andolga.github.io/umineko-catbox-english/
+* GitHub - https://github.com/andOlga/umineko-catbox-english