shougun

shougun

Take command of your media

What?

shougun is a programmable, extensible, embeddable, media management framework. That's a lot of adjectives, but it's intended for a lot of uses.

My primary use is integration with a voice assistant and a Chromecast, which looks like this:

// ShougunBuilder is a convenient, typesafe, fluent interface for building a
// Shougun instance with whatever features you desire.
const shougun = await ShougunBuilder.create()

    // play back on a specific chromecast device
    .playOnNamedChromecast("Family Room TV")

    // call this multiple times to scan multiple local folders
    .scanFolder("~/Movies")

    // adds support for querying configured Babbling apps and considering those
    // results in findMedia
    .includeBabblingMedia()

    // track episode watch progress in a sqlite db
    .trackInSqlite("shougun.db")

    // use a phonetic matcher for queries, suitable for use with voice assistants
    .matchByPhonetics()

    // allow Shougun to keep the Node process alive; since this is for
    // a long-running server, we ought to do this since it enables various
    // internal optimizations
    .allowProcessKeepalive()

    // construct the instance
    .build();

onPlaybackRequest(async (query: string) => {

    // find the best match to the query from all configured sources
    const found = await shougun.findMedia(query);
    if (!found) {
        throw new Error("no match");
    }

    // play the found media on the configured output surface (a Chromecast).
    // if `found` appears to be a TV series, Shougun will automatically resume
    // wherever you left off
    console.log("Playing", found);
    await shougun.play(found);
});