npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@majesticfudgie/img-reader

v1.0.0

Published

Pretty straight forward, you include the reader class from this library. Create an instance the raw data from the IMG file you wish to read.

Downloads

4

Readme

How do I use it?

Pretty straight forward, you include the reader class from this library. Create an instance the raw data from the IMG file you wish to read.

It's up to you to acquire a Buffer containing the raw IMG data.

The IMG reader will automatically parse the data and read the directory list. Only "VER2" IMG archives are supported!

When you want to read file call readFile(filename) where filename is a file within the archive such as "beer_girla.dff". The raw data is returned as a buffer which you can manipulate as you wish.

Does it hog RAM?

Yes, the raw data is kept in memory along with the file list.

This is due to the readers intention of being able to read the data into memory once for future manipulation such as in environments where streaming a file off disk isn't possible, such as in the browser.

A streaming variation may be the next stage.

Code sample, please!

const rawData = fs.readFileSync(path.join(__dirname, "..", "cutscene.img"));
const reader = new IMGReader(rawData);

console.log("Read archive into memory.");
const entry = reader.readFile("beer_girla.dff");
fs.writeFileSync("beer_girla.dff", entry);

Typescript?

Yup, it's in typescript. Typings are included.

Pull Requests?

Sure, if theres a bug and you have the fix or would like to add a feature open a PR. Please keep it to IMG file manipulation only!

I'm definitely open to someone putting the effort in to write files into .img archives. But as its currently outside of my usecase I've not bothered.