SAAT - Audio API und Toolkit

Audio-API und Audioverwaltung für SMAPI, ohne Nutzung von HarmonyLib.
Fügen Sie Ihren Mods benutzerdefinierte Musik hinzu!

Was macht dieser Mod?

SAAT ist ein Framework zum Hinzufügen, Verwalten und Ändern von Audiospuren in Stardew Valley. Darüber hinaus soll die Audio-Engine zu einem späteren Zeitpunkt verbessert werden, da die Audio-Engine von XNA/MonoGame hinsichtlich Speicherverwaltung und Support mangelhaft ist. Es soll keine Harmonien geben.

Beispiele zum Hinzufügen benutzerdefinierter Audiospuren finden Sie imDokumentation auf Github


Neu in v1.1.2:
- Ein Fehler wurde behoben, der zu der Warnmeldung „Es konnte keine CueDefinition mit dem Namen ‚title_day‘ gefunden werden“ führte.

Neu in v1.1.1:
- Eine Ausfallsicherheitsfunktion, die verhindert, dass das Spiel abstürzt, wenn ein Cue falsch aufgerufen oder nicht gefunden wird.
-- Bei einem Fehlschlag wird ein „Defaulting Cue“ abgespielt. Dieser Cue erzeugt Stille.
- Die Möglichkeit, Audiotitel zwangsweise zur Jukebox hinzuzufügen. Siehe Befehl „addtojukebox“.
-- Dies dient der Migration. Bei Mods, die von Custom Music zu SAAT migriert wurden, werden alle benutzerdefinierten Titel aus der Jukebox-Playlist entfernt, da die Präfix-Notation (cm:) CM erforderlich ist. SAAT validiert alle Titel in der Jukebox und entfernt fehlende, um dies zu verhindern.

Neu in v1.1.0:
- Audiospureinstellungen hinzufügen.
-- Sie können jetzt einen Eintrag in tracks.json so einstellen, dass er kontinuierlich in einer Schleife abläuft.
-- Sie können jetzt einen Eintrag so einstellen, dass er sich sofort zur Jukebox hinzufügt, wenn ein neues Spiel erstellt wird.
- Der Befehl „setdebug“ wurde in „audiodebug“ umbenannt, da eine hohe Wahrscheinlichkeit von Konflikten mit anderen Mods besteht.
- Der Befehl „gen_track_json“ wurde in „tracktemplate“ umbenannt.
- Der Befehl „audio_allocs“ wurde in „audioallocs“ umbenannt.
- Beim Befehl „audioallocs“ wurden einige Formatierungskorrekturen vorgenommen.
- Der Befehl „audioallocs“ verfügt jetzt über einen optionalen Parameter. Durch Hinzufügen einer Titel-ID erhalten Sie weitere Details zu einem bestimmten Titel.
- Es wurden einige interne Umstrukturierungen durchgeführt.
- Aktualisierung der Dokumentation.

Aktuelle Funktionalität:
Ermöglichen Sie das Hinzufügen brandneuer Musik und Soundeffekte zu Stardew Valley
Ermöglicht das Hinzufügen von Musik zur Jukebox.

Noch nicht implementiert / Kommende Funktionen:

Ersetzen/Überschreiben von Audiospuren
Eine Person kann vorhandene Audiospuren durch andere ersetzen und dabei die Vanilla-Assets auf nicht zerstörbare Weise überschreiben.

Audiosignalverarbeitung (APS oder DPS)

Eine kommende Funktion ermöglicht die Bearbeitung von Audiodaten mit Tiefpassfiltern, Hochpassfiltern, Tonhöhenänderungen, Effekten und mehr, ohne dass eine weitere Spur erstellt werden muss.

Richtiges Speichermanagement

Dies soll das Hauptmerkmal der API sein. Stardew Valley nutzt derzeit XNA/MonoGame für die Speicherverwaltung von Audiodaten. Die Speicherverwaltung ist jedoch schlecht konzipiert, da sie entweder alles oder nichts lädt. Normalerweise wird Audiodaten in Blöcken im Speicher abgelegt, anstatt sie auf einmal zu speichern. Dies führt zu einem sehr hohen Speicherverbrauch.

Beispielsweise werden die Wintermusiktitel zu Beginn des Spiels in den Speicher geladen. Auch wenn es Frühling ist. Sie werden den Audiotitel für drei Viertel des Spiels nicht hören, er verbraucht aber trotzdem Speicher.

Hinweis: Diese Teilmenge der API/des Mods wird in C geschrieben. Um die Leistung sicherzustellen, ist Native erforderlich.

Gepacktes Audioformat

In Verbindung mit einer ordnungsgemäßen Speicherverwaltung muss Audio pro Mod in Binärdateien komprimiert werden. Dies ermöglicht ein schnelleres Laden/Entladen/Neuladen.

Es wirdnicht erforderlich sein, aber es optimiert die Leistung. Besonders bei größeren Audiodateien.

Toolkit für gepacktes Audioformat

Um Inhaltsersteller bei der Optimierung von Audio für die Leistung zu unterstützen und zu ermutigen, wird ein Tool zum Erstellen des oben genannten gepackten Audioformats bereitgestellt.

Quellcode und Dokumentation