Skip to content

A library for parsing scene release names into human readable data.

Notifications You must be signed in to change notification settings

pr0pz/scene-release-parser

Repository files navigation

Scene Release Parser

Made with JavaScript npm package version: v1.0.3 Minified npm package size: 9.09 kB

A library for parsing scene release names into simpler, reusable data.

Like it? I'd appreciate the support :)

Follow on Twitter Watch on Twitch Join on Discord Donate on Ko-Fi

Description

This library parses scene release names and splits the data into smaller, simpler, human readable and therefore more reusable data.

The applied rules are mostly based on studying the existing collection of Scene rules and other release examples from a PreDB, since a lot of releases are not named correctly (specially older ones).

The approach was to implement an algorithm that can really parse a variety of scene releases from all decades. The main test file covers some more complex names.

Instructions

I suppose you already know some JavaScript and Node is already installed on your computer. The next steps are:

› Install the library via npm OR download the latest release;

$ npm install release-parser

› Import the library into your project;
› Use the function ReleaseParser and pass the release name and (optionally) the release section (for better type parsing);
› The function will return an object with all the successfully parsed informations.

Example:

import ReleaseParser from 'release-parser'

const release = ReleaseParser( '24.S02E02.9.00.Uhr.bis.10.00.Uhr.German.DL.TV.Dubbed.DVDRip.SVCD.READ.NFO-c0nFuSed', 'tv' )

=> {
    release: '24.S02E02.9.00.Uhr.bis.10.00.Uhr.German.DL.TV.Dubbed.DVDRip.SVCD.READ.NFO-c0nFuSed',
    title: '24',
    titleExtra: '9 00 Uhr bis 10 00 Uhr',
    group: 'c0nFuSed',
    year: null,
    date: null,
    season: 2,
    episode: 2,
    disc: null,
    flags: [ 'READNFO', 'TV Dubbed' ],
    source: 'DVDRip',
    format: 'SVCD',
    resolution: null,
    audio: null,
    device: null,
    os: null,
    version: null,
    language: { de: 'German' },
    type: 'TV'
}

CLI

You're also able to use the script via the command line.

› For that, you'll nee to install the script globally;

$ npm install -g release-parser

› Just pass the release name as first argument after calling the script with 'release-parser'.
› If you get errors, try enclosing the release name in parenthesis: "Artist--Title-(Bla)-2000-Group". Some shells have issues with some characters (like brackets).

Example:

$ release-parser 24.S02E02.9.00.Uhr.bis.10.00.Uhr.German.DL.TV.Dubbed.DVDRip.SVCD.READ.NFO-c0nFuSed

    => {
        release: '24.S02E02.9.00.Uhr.bis.10.00.Uhr.German.DL.TV.Dubbed.DVDRip.SVCD.READ.NFO-c0nFuSed',
        title: '24',
        titleExtra: '9 00 Uhr bis 10 00 Uhr',
        group: 'c0nFuSed',
        year: null,
        date: null,
        season: 2,
        episode: 2,
        disc: null,
        flags: [ 'READNFO', 'TV Dubbed' ],
        source: 'DVDRip',
        format: 'SVCD',
        resolution: null,
        audio: null,
        device: null,
        os: null,
        version: null,
        language: { de: 'German' },
        type: 'TV'
    }

That's it!

Found any Bugs?

If you find any bugs/errors, feel free to post an issue.

Similar projects and inspirations

License

License: MIT

That's it!

Be excellent to each other. And, Party on, dudes!