Skip to content

A ResoniteModLoader mod that imports metadata alongside audio files.

Notifications You must be signed in to change notification settings

noblereign/ResoniteMetadataImporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MetadataImporter

A ResoniteModLoader mod for Resonite that imports metadata alongside audio files.

When you import an audio file, the mod looks for a Slot named "Metadata" beneath the root of your audio entity interface. That slot is then filled with Dynamic Variables containing the metadata from the audio file. If TagLibSharp can read it, this mod will expose it.
If a Slot named Metadata doesn't exist, the mod will add one on its own.

Useful if you like to import your music into the game, you can make an entity interface that displays the proper metadata (like artist, album, etc) rather than just a filename.

Entity Interface Config

The mod has a couple of Dynamic Variables it looks for to determine how to do the import:

  • MetadataImporter.Separator (string): What separator should be used when converting multiple entries into a string? Default: ,
  • MetadataImporter.CastToStrings (bool): Should the mod forcibly output strings, instead of using the canonical types? Default: false

These variables should be bound to the Dynamic Variable Space on the root of your audio entity interface.

Intercompatibility

This mod has been confirmed to work with files imported through ResoniteMP3, and CommunityBugFixCollection's "Import Multiple Audio Files" patch.

Also, if your entity interface implements the Resonite MetaDisc (Res-MD) Song Orb standard, the mod can detect that and fill in the proper fields.
Res-MD is still a work-in-progress, there'll be a link to the wiki page once it's complete!

Screenshots

Screenshot showing the default Resonite audio player. It has the Metadata slot injected beneath it, full of the audio metadata.

Screenshot showing the default Resonite audio player. It has the Metadata slot injected beneath it, full of the audio metadata.

Screenshot showing an example use-case of the mod. A song orb surfaces the proper track and artist names from the metadata, rather than just a filename

Screenshot showing an example use-case of the mod. A song orb surfaces the proper track and artist names from the metadata, rather than just a filename.

resmd-import.mp4

Video showing many audio files being imported with proper metadata, showcasing the compatibility with CommunityBugFixCollection.

Installation

  1. Install ResoniteModLoader.
  2. Place MetadataImporter.dll into your rml_mods folder. This folder should be at C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods for a default install.
  3. Place TagLibSharp.dll into your rml_libs folder. This folder should be at C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_libs for a default install.

You can create those folders if they're missing, or if you launch the game once with ResoniteModLoader installed it will create those folders for you.

  1. Start the game. If you want to verify that the mod is working you can check your Resonite logs.

Third-Party Libraries

This mod is powered by TagLibSharp, which is under the LGPL-2.1 license.

About

A ResoniteModLoader mod that imports metadata alongside audio files.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages