ed/HomuraHime-Mods
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update EXISTING_TOOLS.md with correct CinematicUnityExplorer links

Browse Source 
- Changed from sinai-dev to originalnicodr/CinematicUnityExplorer (295 stars, v1.4.0)
- Updated download URL to correct latest release
- Added feature comparison table
- Added quick start guide for finding audio types
- Documented Hook Manager and C# Console usage
This commit is contained in:
Edward R. Gonzalez
2026-03-22 14:25:35 -04:00
parent 4251a29794
commit 5a9f306f3f
1 changed files with 61 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
docs/EXISTING_TOOLS.md
View File

@@ -1,74 +1,90 @@
# Existing Modding Tools for HomuraHime # Existing Modding Tools for HomuraHime
## Recommended Existing Tools ## Recommended: CinematicUnityExplorer (295 stars)
### 1. UnityExplorer (3k stars) **Purpose:** In-game UI for exploring, debugging, and modifying Unity games with cinematic tools
**Purpose:** In-game UI for exploring, debugging, and modifying Unity games
**Features:**
- Object Explorer - browse scenes, find audio objects
- Inspector - view/edit component values in real-time
- Hook Manager - create Harmony patches at runtime (no rebuild needed)
- C# Console - execute code live
- Mouse Inspect - click objects to inspect them
**Download:** **Download:**
- BepInEx 5.x Mono: https://github.com/sinai-dev/UnityExplorer/releases/download/UnityExplorer.BepInEx5.Mono.zip ```
https://github.com/originalnicodr/CinematicUnityExplorer/releases/latest/download/CinematicUnityExplorer.BepInEx5.Mono.zip
```
**Installation:** **Installation:**
1. Download `CinematicUnityExplorer.BepInEx5.Mono.zip`
2. Extract to: `C:\apps\steam\steamapps\common\Homura Hime\BepInEx\plugins\`
3. Launch game - press **F5** to open
**Features:**
| Feature | Description |
|---------|-------------|
| Object Search | Find audio manager types (FmodVoiceManager, CFVoiceEventUtility, etc.) |
| Inspector | View/edit component values in real-time |
| Hook Manager | Create Harmony patches at runtime (no rebuild needed) |
| C# Console | Execute code live to test audio triggers |
| Mouse Inspect | Click objects to inspect them |
| Freecam | Cinematic camera for screenshots/videos |
| Lights Manager | Add/modify scene lighting |
| Camera Paths | Create cinematic camera sequences |
| Animator Control | Pose characters for screenshots |
---
## Alternative: Yukieiji UnityExplorer (809 stars)
**Vanilla UnityExplorer** - if you don't need cinematic features
**Download:**
``` ```
1. Download UnityExplorer.BepInEx5.Mono.zip https://github.com/yukieiji/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip
2. Extract to: C:\apps\steam\steamapps\common\Homura Hime\BepInEx\plugins\
3. Launch game - press F5 to open UnityExplorer menu
``` ```
### 2. UniverseLib (129 stars)
**Purpose:** UI library for Unity mod plugins
**NuGet:**
- Mono: `rainbowblood.UniverseLib.Mono`
- IL2CPP: `rainbowblood.UniverseLib.IL2CPP`
Note: UniverseLib is included with UnityExplorer, no separate install needed.
--- ---
## Why Keep Our Custom AudioMixerGUI? ## Why Keep Our Custom AudioMixerGUI?
While UnityExplorer is excellent for general debugging, our **AudioMixerGUI** provides: Our **AudioMixerGUI** provides audio-specific sliders and quick testing:
| Feature | UnityExplorer | Our AudioMixerGUI | | Feature | CinematicUnityExplorer | Our AudioMixerGUI |
|---------|---------------|-------------------| |---------|----------------------|-------------------|
| Audio-specific sliders | No | Yes | | Audio-specific sliders | No | Yes |
| One-click enemy cue testing | No | Yes | | One-click enemy cue testing | Via C# Console | Yes |
| Battle cue testing | No | Yes | | Voice count monitoring | Manual via Inspector | Yes |
| Voice count monitoring | Manual | Automatic | | Config persistence | No | Yes (via BepInEx config) |
| Audio presets | No | Yes |
**Recommendation:** Use **BOTH** **Recommendation:** Use **BOTH**
- UnityExplorer for general debugging and object browsing - CinematicUnityExplorer (F5) for debugging, object browsing, screenshots
- Our AudioMixerGUI for focused audio parameter tweaking and cue testing - Our AudioMixerGUI (F1) for audio parameter tweaking
--- ---
## Alternative: Dear ImGui (Future Option) ## Quick Start with CinematicUnityExplorer
If you prefer Dear ImGui-style UI, consider: ### Finding Audio Types
1. Press **F5** to open CinematicUnityExplorer
2. Go to **Object Search** tab
3. Search for: `FmodVoiceManager`, `CFVoiceEventUtility`, `VoiceManager`, `SnapshotManager`
4. Click results to inspect
1. **MelonImGui** - https://github.com/plusno69/MelonImGui ### Creating Runtime Patches
2. **ui_imgui** - https://github.com/nk-mermaid/ui_imgui 1. Go to **Hook Manager** tab
2. Enter class name (e.g., `CFVoiceEventUtility`)
3. Select method (e.g., `PlayCFVoice`)
4. Click to generate patch code
5. Edit and apply at runtime
These require additional dependencies but provide modern ImGui-style UI. ### Testing Audio Triggers via C# Console
```
**Trade-off:** More work to integrate, but looks more professional. // Example - trigger enemy alert sound
CFVoiceEventUtility.PlayCFVoice("Enemy_Alert");
```
--- ---
## Recommended Setup ## Default Hotkeys
1. **Install UnityExplorer** (for general modding/debugging) | Key | Action |
2. **Keep our AudioMixerGUI** (for audio-specific controls) |-----|--------|
3. **Press F1** to toggle our audio mixer | **F5** | Toggle CinematicUnityExplorer |
4. **Press F5** to toggle UnityExplorer | **F1** | Toggle our AudioMixerGUI |
This gives you the best of both worlds - professional debugging tools + dedicated audio mixer. For CinematicUnityExplorer freecam controls, see their documentation.