From 7c407a7a84ab3d4463b7ccbb56a65638c1f49b7a Mon Sep 17 00:00:00 2001
From: Alex <15199219+muskit@users.noreply.github.com>
Date: Sun, 17 Aug 2025 11:39:08 -0700
Subject: [PATCH] add documentation

---
 HOWTO.md  | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md |  5 ++++
 2 files changed, 74 insertions(+)
 create mode 100644 HOWTO.md
 create mode 100644 README.md

diff --git a/HOWTO.md b/HOWTO.md
new file mode 100644
index 0000000..d6b39ee
--- /dev/null
+++ b/HOWTO.md
@@ -0,0 +1,69 @@
+# Preparing files
+This is a guide to populating the `data` working folder in this application's directory, which will eventually contain all relevant data for repacking & converting charts. You may set up this folder elsewhere for storage space reasons; you'll get to choose a different working folder path. We will refer to this working folder as `data` throughout the guide.
+
+Start with the `data` folder bundled with the app/repo. Feel free to move it to another location as mentioned above.
+
+**This project will only repack audio on Reverse 3.07 properly.**
+
+## Table of Contents (sorted by descending time consumption)
+1. [Song Audio](#song-audio-datamer_bgm)
+2. [Jackets](#jackets-datajackets)
+3. [Metadata](#metadata-datamusicparametertable)
+4. [Charts](#charts-datamusicdata)
+
+## Song Audio (`data/MER_BGM`)
+*~18.8 GB for WAVs*
+
+Due to the audio indexing data in this project only done for **Reverse 3.07**, these steps will only work for game files of that version.
+
+You will need the latest version of [Audio Cue Editor (ACE)](https://github.com/LazyBone152/ACE).
+
+For each of the files below located in `<WAC>/app/WindowsNoEditor/Mercury/Content/Sound/Bgm`...
+
+- MER_BGM.awb
+- MER_BGM_V3_01.awb
+- MER_BGM_V3_02.awb
+- MER_BGM_V3_03.awb
+- MER_BGM_V3_04.awb
+- MER_BGM_V3_05.awb
+- MER_BGM_V3_06.awb
+- MER_BGM_V3_07.awb
+
+...follow these steps on each file:
+
+1. Load the file in ACE using "File > Load (AWB)".
+    - If asked to open the matching ACB, click "No".
+2. Export all of the AWB's streams using "Tools > Extract All (wav)" into a folder in `data/MER_BGM` depending on the current AWB file according to the table:
+
+| AWB File          | Folder in MER_BGM |
+|-------------------|-------------------|
+| MER_BGM.awb       | MER               |
+| MER_BGM_V3_01.awb | 01                |
+| MER_BGM_V3_02.awb | 02                |
+| MER_BGM_V3_03.awb | 03                |
+| MER_BGM_V3_04.awb | 04                |
+| MER_BGM_V3_05.awb | 05                |
+| MER_BGM_V3_06.awb | 06                |
+| MER_BGM_V3_07.awb | 07                |
+
+## Jackets (`data/jackets`)
+*~54.4 MB*
+
+For this, you will need [UE Viewer](https://www.gildor.org/en/projects/umodel).
+
+1. Run `umodel_64.exe` and configure its Startup Options.
+    - Set "Path to game files" to `<WAC>/app/WindowsNoEditor/Mercury/Content/UI/Textures/JACKET`.
+    - Enable "Override game detection" and set it to "Unreal engine 4.19".
+    - Click OK.
+2. In the left panel, right click on "All packages", then click on "Export folder content".
+    - Under "Texture Export," set format to PNG, and the path to `data/jackets`.
+    - Click OK to begin exporting jacket images.
+
+## Metadata (`data/MusicParameterTable.*`)
+*<1 MB*
+
+In `<WAC>/app/WindowsNoEditor/Mercury/Content/Table/`, simply copy `MusicParameterTable.uasset` and `MusicParameterTable.uexp` into `data`.
+
+## Charts (`data/MusicData`)
+*~59.5 MB*
+Simply copy the `MusicData` folder at `<WAC>/app/WindowsNoEditor/Mercury/Content/` into `data`.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b7487f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# MercuryConverter
+
+This is a rewrite of [WacK-Repackager](https://github.com/muskit/WacK-Repackager) to work with the upcoming Saturn project.
+
+Head over to [HOWTO](HOWTO.md) for required data preparation.
\ No newline at end of file