WoWS Collaboration Character Mix Voice Mod Installation Batch Program Instructions

Version covered by this instructions: 21.3

Table of Contents:

1. License Agreement
   
2. Outline
   
3. Features
   
4. Setup
   
5. Interactive Instructions
   
6. Command Line Instructions
   
7. Command Line Usage
   
8. Exit Code
   
9. Notes
   
10. Uninstall
    
11. System Requirements
    
12. Copyrights
    

License Agreement:

• The author is not responsible for any damage caused to the user by using this batch or mods created with this batch, regardless of whether the batch file has been modified or not, and regardless of whether the game is inside or outside of the game.
  
• This batch may not work properly in all environments, and the author does not guarantee that it will always work properly.
  
• The author does not guarantee that any defects in the operation of this batch will always be addressed by the author.
  
• Even if this batch cannot be used because WoWS has been updated, the author does not guarantee that the author will update the batch every time.
  
• You may modify this batch and use it, but redistribution of the unmodified batch or distribution of the modified batch is prohibited.
  

Only those who agree to all of these conditions may use this batch.

Outline:

• This batch program allows you to create a voice mod that allows any character you choose from those implemented in the collaboration to speak during game combat, and install it in the WoWS game client. The creation and installation is done at the same time, and as soon as the batch is finished, the game can be started and the voice mod can be used.
  
• The voice mods created in this batch will be available for selection in the Esc key menu in-game -> Settings -> Audio -> Modification pull-down.
  
• All the content that the characters speak is in Japanese.
  

• Target Collaboration:

  Arpeggio of Blue Steel

  High School Fleet

  Azur Lane

  Legend of the Galactic Heroes

  (N/A)
• Target Characters:

  Iona (CV: Mai Fuchigami), Takao (CV: Manami Numakura), Kongo (CV: Yukana), Hiei (CV: M.A.O), Haruna (CV: Hibiku Yamamura), Kirishima (Yotaroh) (CV: Yumi Uchiyama), Myoko (CV: Ayaka Fukuhara), Nachi (CV: Satomi Sato), Ashigara (CV: Suzuko Mimori), Haguro (CV: Hiromi Igarashi), Maya (CV: MAKO), Musashi (CV: Rie Kugimiya), Yamato (CV: Mai Nakahara), Gunzou Chihaya (CV: Kazuyuki Okitsu)
  

  Akeno Misaki & Mashiro Munetani (CV: Shiina Natsukawa & Lynn), Wilhelmina & Thea (CV: Hiromi Igarashi & Chitose Morinaga), Kouko Nosa (CV: Yuko Kurose), Mei Irizaki (CV: Atsumi Tanezaki), Maron Yanagiwara (CV: Natsumi Takamori), Moeka China (CV: Sora Amamiya)
  

  Aurora (CV: Marie Miyake), Belfast (CV: Yui Horie), Cleveland (CV: Saya Horigome), Enterprise (CV: Yui Ishikawa), Admiral Hipper (CV: Yuri Yamaoka), Hood (CV: Atsuko Tanaka), Nelson (CV: Yuki Kuwahara), Atago & Kaga (CV: Ai Kayano), Azuma (CV: Kiyono Yasuno), Dunkerque (CV: Sayaka Harada), Montpelier (CV: Rie Takahashi), Neptune (CV: Mikako Izawa), Prinz Eugen (CV: Ayane Sakura), Yukikaze (CV: Kana Yuki), Baltimore (CV: Minami Takahashi), Itsen (CV: Yu Asakawa), Jean Bart (CV: Marina Inoue), Littorio (CV: Shizuka Ito), Roon (CV: Satomi Sato), Shokaku (CV: Risa Taneda), Sovetskaya Rossiya (CV: Manami Numakura), New Jersey (CV: Miyu Tomita), Saint Louis (CV: Asami Seto), Zara (CV: Atsumi Tanezaki), Formidable (CV: Rie Kugimiya), Chapayev (CV: Masumi Tazawa), Bismarck (CV: Ayaka Fukuhara)
  

  Reinhard von Lohengramm (CV: Mamoru Miyano), Siegfried Kircheis (CV: Yuichiro Umehara), Frederica Greenhill (CV: Aya Endo), Dusty Attemborough (CV: Kaito Ishikawa), Yang Wen-li (CV: Kenichi Suzumura)
  

  (N/A)
  Currently, the voice of Kirishima before becoming a plush is not implemented, so please select "Kirishima_bear" ("Yotaroh" in the game) instead.
  In this batch, all the voices of Isoroku (Isoroku the cat) are excluded because we do not know what he is says, and cannot be use them to create voice mods.

Features:

• You can create an individual character voice mod for all the target characters.
  
• You can select two to all characters arbitrarily, mix them together, and create a voice mod in which one of them at random speaks at the timing of the voice playback during the game's combat. For example, if you mix character A with character B, either A or B will speak. You can create any number of mixed voice mods.
  
• You can choose which character to speak when receiving radio chats (quick commands) from other player ships from the following options. When sending, only the character selected as your character will speak. This is a common setting for all voice mods that the batch creates at that time.
  
  1. Only selected own character (If you select more than one character, all of them)
     
  2. All of target collaboration implementation characters
     
  3. All of target collaboration implementation characters except the selected own character
     
  4. None (No one speaks at all)
     
• This batch allows you to create voice mods that coexist with sound effect mods. If you have a prepared configuration file for a sound effect mod with its sound file, you can combine them. If the sound effect mod has voice settings in its configuration file, they will be ignored and not combined. This is also a common setting for all voice mods that the batch creates at that time.
  
• In the voices that come with officially sold or distributed collaborative character captains, some of the voice playback events are not supported and are silent or play the default male voice. This In the voice mods created by this batch, those unsupported parts are assigned a different voice with a similar meaning as possible, and the default voice is adjusted so that it does not play.
  
• If you run this batch while connected to the Internet, you can use the automatic self-updating feature. There is no need to manually check if this batch is up-to-date before creating a voice mod.
  
• This batch allows you to specify the settings of the voice mod you want to create, either interactively or by specifying options on the command line. All features of this batch can be controlled by specifying options on the command line. If the batch is run without options, you can proceed with the creation process interactively, but some features will not be available.
  

Setup:

Make the batch available in one of the following ways.

• Method 1:
  
  1. Download and run SetupVoiceModBatch.exe and follow the instructions to install the required files. Only in this way can you automatically create a shortcut to the Windows Start menu.
     
     
• Method 2:
  
  1. Create a new directory in an appropriate location, download

     mod_arp_voice.bat

     mod_hsf_voice.bat

     mod_azr_voice.bat

     mod_lgh_voice.bat

     the batch file

     and place it there.
     
     
  2. The first time the batch is launched, the necessary missing files are automatically downloaded and extracted from each server and placed in that directory and others.
     Note: Depending on the security software you are using, the download may fail with a warning message, in which case you should perform method 1 or 3.
     
• Method 3:
  
  1. Same as method 2-1.
     
  2. Download extcmd2.cab, Ionic.Zip.dll from the links on this website, extract the first one with an extraction tool, etc. and put all the exe and dll files in the same directory as the batch file.
     
  3. Download wowsunpack.exe from one of the links below and put it in the directory where you installed WoWS or in the batch directory.
     Download (wargaming.net)
     Download (gitlab.com)
     
  4. Download the XMLStarlet from the link below, extract it with an unzip tool or similar, and place xml.exe in the batch directory.
     Download (sourceforge.net)
     

Interactive Instructions:

1. When this batch is run from Explorer or other program, a command prompt window will open and execution will begin. You may click directly on the batch file, click on the shortcut of the batch, or first open the command prompt and enter the batch name without options to run it.
   
2. If it detects that the latest version of the batch has been released, you will be asked to choose to update to it. Normally, press the Y key to update.
   
3. A guidance message is displayed, and if you are ready, press the Y key.
   
4. Preparation before the start of mod creation, such as checking the execution environment, checking and detecting the version of WoWS, and deploying resource files, is done automatically. If the WoWS installation location is not be found here in the default location, you will be prompted to specify the correct location in full path notation (drive-letter:\directory-name...). In this input field, you can use the Tab key to use the directory/file name completion feature of the command prompt. You can also use the Esc key to clear all entries in the input field.
   
5. You will be asked to choose whether you want to combine the sound effect mod. Only if you choose Y will you be prompted to specify the directory or the zip file containing the mod in full path notation. You can also use the Tab and Esc keys for this input field.
   
6. You will be asked to choose the behavior when received radio chats in each voice mod you will create. (Explained in "Features" above)
   
7. You will be asked if you want to create individual character voice mods for each character. If you choose Y here, an individual character voice mod will automatically be created for all characters.
   
8. You will be asked if you want to create a character mix voice mod. If you choose N here, the batch will be terminated.
   
9. If you choose to create one, you will be prompted to enter a name for the setting of voice mod that you want to create. The maximum length is 30 characters. The characters that cannot be used are some ASCII characters \/:*?"<>|!%&^ and space. For example, if you enter ABC, a voice mod with the setting name "
   _MIX_ABC" will be created.
   
10. You will be asked if you want to mix each character. If you do not select any character, you can create a voice mod that does not speak itself.
    
11. The character mix voice mod is created and the batch returns to step 8.
    
12. You can exit the batch midway at any time by pressing the Q key for any selection input and the Enter key for any string input, leaving blank. At the end of the batch press any key, to close the command prompt window only if it was run from Explorer or other.
    

Command Line Instructions:

1. Launch a command prompt.
   
2. Type to run the batch file name as the command name, plus any options you want.
   
3. As long as the options are appropriate, steps 2 through 11 of the interactive process will proceed and complete automatically without waiting for input. (If there are not enough options to execute everything automatically, you will be prompted to select or enter them in the middle of the execution, just as you would in an interactive format.)
   
4. Confirm that the command was successful, and close the command prompt window with the Exit command, if you want to.
   

Command line execution is also possible from within other batch programs. You can also create a shortcut to this batch file, write the options and arguments to the properties of the shortcut, and then simply run it from the shortcut to run it with the specified options.

Command Line Usage:

• The options can be used in any order.
  
• chara1 in /SY option creates only the specified character. chara2 in /SN option does the opposite, creating characters other than the specified.
  
• Multiple character mix voice mods can be created by specifying multiple /M options.
  
• The length limitation and characters that cannot be used in the name specification of /M option are the same as those described in step 9 of "Interactive Instructions" above.
  
• If you do not specify a character name for chara3 of /M option, you can create a voice mod that does not speak itself.
  
• Except for the name specification of /M option, it is case-insensitive for alphabetic characters.
  
• /Q option is invalid if any input is required during batch execution or if an error occurs.
  
• Duplicate or inconsistent specification of options other than /M option results in an error.
  
• Options and specifications marked with * for the mod creation feature cannot be specify during interactive execution, so be sure to specify them on the command line.
  

Exit Code:

Notes:

• About the target WoWS:
  
  • This batch automatically detects the version of WoWS when it is updated, so it can continue to be used without problems as long as there are no changes to the game's resource structure. Also, voice mods created with this batch can continue to be used as long as there are no changes to the game's supported voice file formats and definition data structures. However, to ensure that the batch can accurately detect the WoWS version, please be sure to launch the game for the first time after installing or updating the WoWS game client.
    
  • If you do not specify the WoWS installation location, it will run under the assumption that WoWS is installed in "C:\Games\World_of_Warships". You will only be prompted for input during the run if WoWS is not installed there, so if you want to target WoWS there but in a different location, for example if you want to use this batch for the Steam or EpicGames version of WoWS, you will need to specify WorldOfWarships.exe and the correct installation location with the /WOWS option.
    For the Steam version of WoWS:
    Example of input fields during execution: "C:\Program Files (x86)\Steam\steamapps\common\World of Warships"
    Example of command line option: /WOWS "C:\Program Files (x86)\Steam\steamapps\common\World of Warships"
    Note: If it contains spaces, brace it with "".
    
  • The location of the voice mods used in-game the WoWS is under "(WoWS installation directory)\bin\(multi-digit number)\res_mods\banks\mods".
    
  • If this batch detects that the WoWS game client is running, which is inferred from the path specified as the WoWS installation directory, it will determine that a voice mod is being used and this batch will terminate with an error without processing the mod creation. Similarly, if a launcher corresponding to the game platform inferred from it is detected to be running, it is determined that the game client is being updated and this batch will terminate with an error.
    
• About voice mod setting names and directory names:
  
  • The setting name of the voice mod created by this batch will always be
    _CharacterName or
    _MIX_xxxxxxx (xxxxxx is any name). If a voice mod created with this batch is installed with other voice mods and has duplicate setting names, it cannot be used in the game.
    
  • If this batch finds a voice mod with a duplicate configuration name, it will overwrite it, but if the /NOW option is specified, it will create a voice mod with a "_(digits)" appended to the configuration name to avoid duplicates. When a voice mod is created, the directory name is usually the same as the configuration name. However, if the /NOW option is not used to override the configuration name, or if there is no target to override, the directory name is created with the same name with "_(digits)" appended to avoid duplication if the directory name already exists.
    
  • In the current version of WoWS, ASCII characters (uppercase and lowercase letters, numbers, and symbols (except for the symbols listed in step 9 of "Interactive Instructions" above)) and UTF-8 encoded characters can be used for the names of voice mod settings displayed in the game preferences screen. But you will need a font that can display them in the game and we cannot guarantee that they will be available in the future.
    
• About combining a sound effect mod:
  
  • When combining a sound effect mod, the target configuration file mod.xml and all sound effect audio files defined by it (even if they are in a subdirectory) must be present in the specified directory or in a zip file.
    
  • If a zip file is specified as the sound effect mod to be combined, and it contains folder names or file names with multi-byte characters, it can be used if they are UTF-8. Otherwise, the zip file cannot be used properly, so unzip the zip file manually to other location and then specify that directory for the batch.
    
  • If a zip file is specified as the sound effect mod to be combined, and it contains multiple mod.xml files, an error will occur. In this case too, please unzip the zip file manually to other location and then specify the directory containing a mod.xml file you want to combine for the batch.
    
• Other:
  
  • At least
    106MB
    30MB
    143MB
    29MB
    a certain amount
    of free space is required on the drive where WoWS is installed and on the drive where this batch is placed. If both are on the same drive, you will need twice that amount.
    
  • When using Aslain's WoWS ModPack, etc., it is sometimes recommended to delete everything in the res_mods directory during the ModPack installation process. So please install the their mods first, and then use this batch to create the voice mod.
    
  • If the full pathnames of the locations where this batch is located, where WoWS is installed, and where the sound effect mod you want to combine is located contain the ASCII characters %, !, &, or ^, this batch cannot be used, so please rename the relevant locations accordingly.
    
  • In the character mix voice mod, which character actually speaks at the time of a voice playback event in the game is determined randomly from all the voice files assigned to that event. For example, in a mixed A and B character voice mod, if there are five A voice files and one B voice file defined as the voice for an event, the probability of B's voice being played is 1/6, and so on.
    

Uninstall:

• If you no longer need the batch, you can delete manually everything under the directory where the batch is located with Explorer or another program.
  
• If the batch was installed using the installer, it can be removed using the uninstaller.
  
• This batch does not record configuration information in OS-managed areas such as the registry.
  

System Requirements:

• This batch has been tested to work with the Windows10 command prompt. This batch is designed to work in any environment that can run WoWS, but it may not always work correctly.
  
• PowerShell is required to download each file and to unzip the zip file during the execution of this batch. If you do not use these feature, you do not need PowerShell.
  
• If you experience any problems, we would appreciate it if you could provide us with more detailed information such as "your environment", "under what situation", "what you did", "what happened", etc. using the feedback submission form of our website.
  
• The author will not confirm the operation of this batch for the Steam, EpicGames, and MicrosoftStore versions of WoWS.
  

Copyrights:

• This batch is copyrighted by the author kani_cream_syumai.
  
• Extcmd2.cab is packaged from binaries distributed on the GnuWin project site, the Windows version of GNU, with only selected commands and libraries needed to run the batch. The licenses for this software are listed on the corresponding pages.
  
• Ionic.Zip.dll is protected by the Microsoft Public License (Ms-PL).
  
• XMLStarlet is open source freeware under the MIT License.
  
• Wowsunpack.exe is copyrighted by Wargaming.net, Inc.
  

(C) 2016-2023 kani_cream_syumai