nyalib

This is a library used for handling Nyafiles in Quarky.

Usage

Loading a Nyafile

import NyaFile from "nyalib";
const nyafile = new NyaFile();
await nyafile.load((await fetch("https://quarky.nineplus.sh/quarky.nya")).arrayBuffer(), true);

Here we use nyalib to load an external Nyafile. Notice that we are passing a boolean to load(). This indicates that the Nyafile we are loading will be our default Nyafile. You can omit that for it to be a skin Nyafile. Assets are loaded in the order of skin -> default -> error.

If you use load() again while already having a default/skin Nyafile, the respective cache will get overwritten with the new one and any old blob URLs will be released.

Blob URLs

nyalib v3 is very easy to use if you just want blob URLs. With the NyaFile instance you created, pass an asset's name without the file extension to getFileURL(name). There's your blob URL, use it wherever you throw your media.

Why no file extension? Let's say your original asset was a jpg and the skin has a png instead. This wouldn't work normally. Therefore file extensions are ignored in nyalib. You can use getFileType to see what the MIME type was, but keep in mind this is just based on the extension, and doesn't guarantee that the file isn't a pipe bomb in disguise.

<img src={nyafile.getFileURL("img/hakase_pfp")} />

Alternative formats

Of course, you can read your assets in other ways as well. Like getFileURL you just pass the asset name, BUT unlike it these will all be asynchronous, excluding getFileBlob.

• getFileText is the asset's raw text content.
• getFileJSON is getFileText but it does JSON.parse() for you.
• getFileBuffer is the asset as an ArrayBuffer.
• getFileBlob is the asset's blob, in case you need to do some interesting thing with it...

It's important to note that since nyalib v3 was revamped to have blob URLs as the main focus, these alternative formats are a bit neglected at the moment. There is no caching for alternative formats. I am sorry.

Bonus features

You can use listFiles to get an array of all loaded asset names. This lets you check if a file exists before doing anything with it, as nyalib throws an error if the file is not in either Nyafile.