Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 5.99 KB

README.md

File metadata and controls

87 lines (61 loc) · 5.99 KB
Raw

StarTruckerCustomRadio

A mod for Star Trucker that replaces the build in radio station with your own.

  • ♻ Replace songs, adverts and stings with your own files.
  • 🤠 Supports most[1] audio formats
  • 🎸 Shows title and artists in game if present in file metadata[2].
  • 🧒 Easy installation, no modding knowledge required: just drop it in, it will create a folder, you plop in your files and you're done.
  • ✏ Configurable:
    • Radio station name and frequency can be configured.
    • Folder paths can be changed.
    • You can also choose to leave the default stings/adverts/songs enabled if you wish.
    • More below

[1] if CSCore supports it, we can play it, see full list: https://github.com/filoe/cscore#supported-features
[2] if TagLib supports it, we can read metadata - yadda yadda: https://github.com/taglib/taglib#taglib-audio-metadata-library

Installation

1. Install MelonLoader

Get the MelonLoader installer from their website here and install it to Star Trucker.

Finding the game path:

On Steam, the game can be found by right clicking it > Browse local files.
While installing MelonLoader, choose Star Trucker.exe.

On GamePass, click the game, click the ... button, 'manage', files tab, and click 'browse'.
IMPORTANT: While installing MelonLoader on gamepass, you should choose gamelauncherhelper.exe instead of Star Trucker.exe (!!!)

2. Install the mod

Get the latest release from here.
Drop the Mods folder and UserLibs folder included in the zip into your game folder, the "game folder" being the path where you just installed MelonLoader into.

3. First run

  1. Start the game, if all went well you should see the following warning message: Star_Trucker_ljcRT1fRyH

  2. Close the game.

  3. The mod has created a StarTruckerCustomRadio folder in your local user's music folder.
    You can now add files to the Songs, Adverts and Stings folder, once done, restart. You're done.

Configuration

Every aspect of this mod can be configured through your MelonPreferences.cfg file located in [Game Dir]\UserData.
If the file / settings don't exist yet, run the game (with the mod loaded!) at least once.

All settings

Key Default value Description
RadioTitle CustomRadio Star_Trucker_c3sV4CQcQs
RadioFrequency Mod by: JariZ Star_Trucker_LXWq6FSQjh
RadioSongsDir [MusicFolder]\StarTruckCustomRadio\Songs The path to your songs directory.
RadioAdvertsDir [MusicFolder]\StarTruckCustomRadio\Adverts The path to your adverts directory.
RadioStingsDir [MusicFolder]\StarTruckCustomRadio\Stings The path to your stings directory.
RadioDisableCustomSongs false If set to true, the game's default songs will not be replaced with your own.
RadioDisableCustomStings false If set to true, the game's default stings will not be replaced with your own.
RadioDisableCustomAdverts false If set to true, the game's default adverts will not be replaced with your own.

Wishlist

This mod is feature complete and I'm personally done with it, but some fun ideas you reading this (if you have moderate c# experience) could implement (PR's are welcomed!):

  • Make it possible to have multiple radio stations (however, I'm sure the devs of the game will add this themselves at some point though through a DLC or something)
  • Web streams so you can listen to real radio from the game.
    Currently the files are already streamed from disk so streaming it from network should be fairly simple.

Inspired by the RadioExt mod for CP2077

Troubleshooting

Media foundation missing (Error while attempting to decode: CSCore.MediaFoundation.MediaFoundationException)

Most of the file formats should work out of the box, however, for some formats the encoding library we use (CSCore) might fall back to encoding libs on your system.
This requires the 'media feature pack' to be enabled in your system, you can find those instructions here.
If that doesn't work, you're probably better off just converting the file to a format we do support.

Radio stops playing songs!

The game's logic expects there to be at least 10 tracks, the mod will warn you for this (on screen!) if it isn't the case.
This is a problem that could probably be patched out, but not something I really personally care about fixing in the mod as the solution to end users is fairly straight forward.

It doesn't work on my non-windows platform!

For my personal goals for this project windows compat is enough, however, PR's are welcome!