{"name":"kfn-to-ass","version":"1.0.13-SNAPSHOT.cbf9036.d41d8cd","description":"Convert karaoke files from KFN format (Karafun) to ASS files","main":"dist/index.js","bin":{"kfn-to-ass":"dist/index.js"},"types":"src/types.d.ts","scripts":{"build":"tsc --build","test":"node dist/index.js -i \"test/resource/test events progressifs.kfn\"","quickTest":"npm run-script build && npm run-script test","testPublish":"npm run-script build && npm publish --dry-run","publishWrap":"npm run-script build && if read -p 'Confirm? (y) ' ans && [[ $ans = y ]]; then npm publish; fi"},"repository":{"type":"git","url":"https://lab.shelter.moe/Dysp/kfn-to-ass.git"},"keywords":["karafun","karaoke","ass","kfn"],"author":{"name":"Dysp"},"license":"MIT","bugs":{"url":"https://lab.shelter.moe/Dysp/kfn-to-ass/issues"},"dependencies":{"ass-stringify":"^0.1.3","commander":"^3.0.1","kfn-utils":"^1.0.2","uuid":"^3.3.3"},"devDependencies":{"@types/node":"^12.7.5","@typescript-eslint/eslint-plugin":"^2.2.0","@typescript-eslint/parser":"^2.2.0","eslint":"^6.3.0","typescript":"^3.6.3"},"readme":"# kfn-to-ass\n\nConversion tool made to parse KFN files (https://www.karafun.fr) and rewrite their lyrics using ASS format\n\n## Usage\n\n### CLI\n\n```bash\n# Prints conversion on stdout\nkfn-to-ass -i <KFN file>\n\n# Prints conversion into specified file\nkfn-to-ass -i <KFN file> -o <ASS file>\n\n# Converts file and applies the specified offset (in cs)\nkfn-to-ass -i <KFN file> -c <offset>\n\n# Displays more help\nkfn-to-ass --help\n```\n\n### Module\n\n#### function parseKfn(fileContent: string, encodingIn?: BufferEncoding, encodingOut?: string): KfnData\n\nLoads a `KfnData` structure based on said `fileContent`\n\n`encodingIn` is the one you used to read your file (defaults as 'binary')\n\n`encodingOut` is the one you want your output to use (defaults as 'utf8')\n\nIt is recommended you read the fileContent with a 'binary' encoding so the header can be properly decoded\n\n#### function convertKfnToAss(kfn: KfnData, options: Options): string\n\nPrepares said `kfn` and returns it as a `string`\n\n#### interface Options (Upcoming in v1.1, [suggestions](https://lab.shelter.moe/Dysp/kfn-to-ass/issues/1))\n\nWraps all options that could be used during conversion. Its members are:\n- offset (number): offsets every line\n- useFileInstructions (boolean): allows conversion tweaks KFN authors could have written on a per file basis\n- TBD\n","readmeFilename":"README.md","gitHead":"cbf903621908284db47694f17d4b436a187cd3f3","_id":"kfn-to-ass@1.0.13-SNAPSHOT.cbf9036.d41d8cd","_nodeVersion":"14.18.0","_npmVersion":"6.14.15","dist":{"integrity":"sha512-fVn9kvwUdyexv7u+4vAxpw1dVGo8zusIbxs1cBZgpDL+F7f7tcLW1uSY3QQzjz2P2oDSY2jcFBV8FT4Y6Utisw==","shasum":"047b21f111bc8f0ddeade890409d3f1d9425400d","tarball":"https://registry.npmjs.org/kfn-to-ass/-/kfn-to-ass-1.0.13-SNAPSHOT.cbf9036.d41d8cd.tgz","fileCount":15,"unpackedSize":59221,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCx/hCWajwaw7XRxVQOlR7HF/ovT1t9CLOIdx1dS6l49AIhAOnhce7SN4MbQLP4bHeWo36jmRcVeYgD0s4bZC8vruIv"}]},"_npmUser":{"name":"dysp","email":"dysp.ob@gmail.com"},"directories":{},"maintainers":[{"name":"dysp","email":"dysp.ob@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/kfn-to-ass_1.0.13-SNAPSHOT.cbf9036.d41d8cd_1634063582421_0.48131491945011184"},"_hasShrinkwrap":false}