Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
cubicibo committed May 17, 2023
1 parent 7e941fd commit 6981e8e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ For example, this tool can convert custom SUP or IGS files so they can be import
- Only Scenarist MUI for graphic props are allowed (PGS, TextST, IGS…) but chances are other MUI assets (audio, video) can be converted too with some tweaks.

## Usage:
`python3 scenaristream.py PARAMETERS -o output_file`
If you would just like the client without thinking:
`python3 client.py PARAMETERS -o output_file`<br>

You can also install the small package and import the internal classes with `from scenaristream import EsMuiStream, StreamFile`.<br>
`EsMuiStream` parses a xES+MUI stream. `StreamFile` parses a raw stream like PG (SUP) or IG (MNU).

### Parameters
`-s --stream <file>` – Input raw stream file (SUP-PGS or MNU-IGS).<br>
Expand All @@ -27,5 +31,5 @@ The user is responsible for using the proper extension when converting to Scenar

### Example usage
The command below converts a .SUP file to a PES+MUI Scenarist project.<br>
`python3 scenaristream.py -s subtitles.sup -o ./project/subtitles.pes`<br>
`python3 client.py -s subtitles.sup -o ./project/subtitles.pes`<br>
In the project folder, subtitles.pes and subtitles.pes.mui will be created.

0 comments on commit 6981e8e

Please sign in to comment.