sarc-extractor
Version:
Extract file(s) from SARC file.
29 lines (23 loc) • 830 B
Markdown
# sarc-extractor
`sarc-extractor` is an npm package that extracts file(s) from [SARC](http://mk8.tockdom.com/wiki/SARC_(File_Format)) file.
## Installation
[](https://badge.fury.io/js/sarc-extractor)
``` sh
npm i sarc-extractor
```
## Usage
The file(s) extracted from the SARC file will be output to to the same directory as the SARC file.
``` js
const sarcExtractor = require('sarc-extractor');
const extractedFileList = sarcExtractor.extract('<SARC file path>');
```
### Example
``` js
const sarcExtractor = require('sarc-extractor');
const extractedFileList = sarcExtractor.extract('/home/foo/bar.sarc');
// --> output ["/home/foo/bar/baz.msbt", "/home/foo/bar/qux.msbt"]
```
### npm run
``` sh
npm run extract -- <SARC file path>
```