Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ShrineFox authored Aug 3, 2024
1 parent 9b91dab commit ad6e07d
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,27 @@ This may be useful for [automatically making dual-language mods](https://shrinef
- **Loop Entire Track**: Ignores the start/end sample numbers and infinitely loops the track between the very first and very last sample.
- **Use New Encryption Key**: Uses the provided keycode to encrypt output ``.adx`` when encoding. If the input is already an encrypted ``.adx``, this is used to remove encryption. If unchecked, existing encryption will not be affected by encoding.
## Renaming
- **Drag .txt w/ Ordered Filenames**: See below "How to Support Dual Languages" for a detailed explanation.
- **Ordered Filenames From Txt File**: See below.
- **Source Sound Files Path**: The folder containing sound files used in the ``.txt`` list.
- **Renamed Files Output Path**: The folder where copied and renamed files from the source folder will be created.
- **Renamed Files Output Path**: The folder where copied and renamed files from the source folder will be created.
- **Txt File With Filenames In Order Path**: The .txt file containing a list of filenames from the Source Sound Files folder in the order you would like them renamed and copied to the Renamed Files Output folder.
- **Suffix**: A string that follows the ID in the filename. i.e. ``00005.adx`` would become ``00005_streaming.adx`` with "_streaming" as the suffix.
- **Append OG Name**: Appends the name of the source audio file to the end of the renamed file, after the suffix. Useful for identifying tracks when using Reloaded II's FEmulator, which allows this.
i.e. ``00005_streaming.adx`` would become ``00005_streaming_originalfilename.adx`` if the source file was ``originalfilename.adx``.
- **Left Padding**: The number of digits that comprise the ID. Un-filled digits will be zero. For instance, an ID of ``234`` with a Left Padding of ``5`` becomes ``00234``.
- **Start ID**: Which ID to start counting up from. Useful when you're replacing a sequence of some, but not all audio files in the middle of an archive.
i.e. with start ID ``30``, the first file to be generated will be named ``00030_streaming.adx``
- **Copy and Rename Files**: Using the above settings, files from the source folder will be copied and renamed to the output folder in the order they appear in the list, with the ID counting up by 1 each time.
### Ryo Renaming Options
Learn more about Ryo Framework and why you would want to use these settings [here](https://github.com/ShrineFox/ACBCueConverter/blob/ACE_dependency/README.md).
The following settings do not use the "Suffix," "Append OG Name," or "Left Padding" options.
- **Ryo Output Mode**: Set this to anything other than "Don't Output For Ryo" to enable the following settings.
- **Streaming**: Check this box if you're replacing "streaming" cues (i.e. embedded in ``.AWB`` rather than ``.ACB``.
- **Player Volume**: Check this to override the volume for the sound player rather than the sound itself. Fixes some volume issues.
- **Volume**: The volume percentage applied to all the output sound clips. Uncheck **Override Volume** to use the sound category's default volume.
- **Category**: The ID of the Sound Category applied to all the output sound clips. Varies by game. (i.e. in P5R, se: 0, bgm: 1, voice: 2, system: 3, syste_stream: 12 ... )
- **Folder Suffix**: The suffix applied to each Cue folder's name. Only works when **Cue Names** is checked. (i.e. btl_support becomes btl_support_Joker if the suffix is "Joker")
- **Cue Names**: Whether to use cue names for output folders. If not, folders will be named ``<CUEID>.cue``. This also applies to eacch sound's ``.yaml`` config file.
## Archives
- **Drag Archive to Extract**: Select an ``.acb``/``.afs`` archive to extract to a folder. The folder will appear next to the original archive.
- **Drag Folder to Repack**: Choose a folder containing audio files to repack into the selected archive format. For ``.acb``, it must be next to the original ``.acb``/``.awb`` pair **which will be overwritten**. The original **.AFS** may be overwritten as well if the folder being repacked is in the same directory, but you can move it somewhere else first (it doesn't need to be next to the original).
Expand Down

0 comments on commit ad6e07d

Please sign in to comment.