# DeathSound — Sound & Emote

> Spielt einen eigenen Sound und zeigt ein eigenes Emote-Bild wenn dein Charakter stirbt.

---

## 🇩🇪 Deutsch

### Installation
1. Den Ordner `DeathSound` in dein WoW-AddOns-Verzeichnis kopieren:
   `World of Warcraft\_retail_\Interface\AddOns\DeathSound\`
2. WoW starten — fertig.

---

### Eigene Sounds hinzufügen
1. `.ogg` oder `.mp3` Dateien in den Ordner legen:
   `Interface\AddOns\DeathSound\Sounds\`
2. `UpdateLists.bat` ausführen (liegt im Addon-Ordner)
   → scannt den Sounds-Ordner und schreibt `SoundList.lua` automatisch
3. WoW **komplett neu starten** — kein `/reload` genügt!
4. Im Spiel den Sound über das Optionen-Panel auswählen.

---

### Eigene Overlay-Bilder hinzufügen
1. `.png` oder `.tga` Dateien in den Ordner legen:
   `Interface\AddOns\DeathSound\Images\`
   - **Empfohlenes Format:** `.png` — kleinere Dateien, Alpha-Kanal, universell kompatibel
   - **Legacy-Format:** `.tga` — wird weiterhin unterstützt
   - Maximale Größe im Spiel: `128×128` px
   - Beide Formate unterstützen Transparenz via Alpha-Kanal
2. `UpdateLists.bat` ausführen (liegt im Addon-Ordner)
   → scannt den Images-Ordner und schreibt `ImageList.lua` automatisch
3. WoW **komplett neu starten**
4. Im Optionen-Panel, Tab **Emote**:
   - **Bild-Overlay beim Tod anzeigen** aktivieren
   - Bild aus dem Dropdown auswählen
   - Optional **Zufällig** aktivieren → zeigt bei jedem Tod ein anderes Bild
   - Optional **An 'Geist freilassen'-Popup ankern** → Bild erscheint links neben dem Todes-Dialog, Größe automatisch
   - **Entsperren (Bearbeiten)** klicken → Overlay per Drag verschieben
   - Größe im Eingabefeld eintragen (32–128 px, quadratisch)
   - **Position sperren** wenn fertig

---

### Optionen
Über **ESC → Optionen → AddOns → DeathSound** oder per Slash-Command.

| Befehl | Funktion |
|---|---|
| `/deathsound` | Optionen-Panel öffnen |
| `/deathsound test` | Aktuellen Sound testen |
| `/deathsound on` | Addon aktivieren |
| `/deathsound off` | Addon deaktivieren |
| `/ds` | Kurzform für alle Befehle |

---

### Unterstützte Formate

| Typ | Format | Anmerkung |
|---|---|---|
| Sound | `.ogg` | Empfohlen |
| Sound | `.mp3` | Unterstützt |
| Overlay | `.png` | Empfohlen — klein, Alpha-Kanal, universell |
| Overlay | `.tga` | Legacy — wird weiterhin unterstützt |

---

### Kompatibilität
- World of Warcraft: Midnight (Interface 120005)
- ElvUI: Skin wird automatisch angewendet wenn ElvUI aktiv ist

---

### Hinweise
- Sound- und Bilddateien müssen **vor** dem WoW-Start im Ordner liegen
- `UpdateLists.bat` muss direkt im `DeathSound\` Ordner liegen
- Wenn ein Sound nicht abspielt, wird der volle Dateipfad im Chat ausgegeben
- Das Overlay erscheint automatisch beim Tod und verschwindet bei Wiederbelebung
- Wenn DeathSound deaktiviert ist, erscheinen weder Sound noch Emote-Bild

---

## 🇬🇧 English

### Installation
1. Copy the `DeathSound` folder into your WoW AddOns directory:
   `World of Warcraft\_retail_\Interface\AddOns\DeathSound\`
2. Start WoW — done.

---

### Adding Your Own Sounds
1. Place `.ogg` or `.mp3` files into:
   `Interface\AddOns\DeathSound\Sounds\`
2. Run `UpdateLists.bat` (located in the addon folder)
   → scans the Sounds folder and writes `SoundList.lua` automatically
3. **Fully restart WoW** — a `/reload` is not enough!
4. Open the options panel, go to the **Sound** tab and select your sound.

---

### Adding Your Own Emote Images
1. Place `.png` or `.tga` files into:
   `Interface\AddOns\DeathSound\Images\`
   - **Recommended format:** `.png` — smaller files, alpha channel, works everywhere
   - **Legacy format:** `.tga` — still supported
   - Maximum size in-game: `128×128` px
   - Both formats support transparency via alpha channel
2. Run `UpdateLists.bat` (located in the addon folder)
   → scans the Images folder and writes `ImageList.lua` automatically
3. **Fully restart WoW**
4. Open the options panel, go to the **Emote** tab:
   - Enable **Show image overlay on death**
   - Select an image from the dropdown
   - Optionally enable **Random** to cycle through images randomly on each death
   - Optionally enable **Anchor to Release Spirit popup** — the image will appear to the left of the death dialog, sized automatically
   - Click **Unlock (Edit Mode)** to drag the overlay to your preferred position
   - Enter a size in the input field (32–128 px, square)
   - Click **Lock Position** when done

---

### Options
Via **ESC → Options → AddOns → DeathSound** or slash commands.

| Command | Action |
|---|---|
| `/deathsound` | Open options panel |
| `/deathsound test` | Test the current sound |
| `/deathsound on` | Enable the addon |
| `/deathsound off` | Disable the addon |
| `/ds` | Shorthand for all commands |

---

### Supported Formats

| Type | Format | Note |
|---|---|---|
| Sound | `.ogg` | Recommended |
| Sound | `.mp3` | Supported |
| Emote | `.png` | Recommended — small, alpha channel, universal |
| Emote | `.tga` | Legacy — still supported |

---

### Compatibility
- World of Warcraft: Midnight (Interface 120005)
- ElvUI: skin is automatically applied when ElvUI is active

---

### Notes
- Sound and image files must be in place **before** starting WoW
- `UpdateLists.bat` must be located directly in the `DeathSound\` folder
- If a sound fails to play, the full file path is printed to chat
- The overlay appears automatically on death and hides on resurrection
- If DeathSound is disabled, neither the sound nor the emote image will appear

---

## Credits
Author: Nightwalker559
Thumbnail art generated with AI
