Sims 4 Toolkit

Node.js Library for The Sims 4

Read and write package files and the resources they contain with a fluent API.

import { Package } from "@s4tk/models";

const pkg = Package.from(buffer);

pkg.entries.forEach(entry => {
  doStuff(entry.resource);
});

The Sims™ and its plumbob icon are registered trademarks of Electronic Arts, Inc. (EA). Sims 4 Toolkit is not affiliated with or endorsed by EA.

Great Performance

Read single packages in an instant, and enable filters and cacheing to speed up larger tasks.

Open Source

View the source code, open issues, make pull requests, or fork the project on GitHub.

Ever Growing

S4TK is in active development, and many more packages are planned to be added.

Fully Functional Tuning DOM

Whether you're reading, editing, or creating a tuning resource, S4TK's built-in XML DOM makes everything from batch fixes to file generation a breeze.

if (tuning.root.attributes.c === "Trait") {
  const ageList = tuning.root.findChild("ages");

  ageList.addChildren(
    E({ value: "ADULT" }),
    E({ value: "ELDER" })
  );
}

Easily Editable Binary Resources

Working with packages, string tables, and SimDatas is just as easy as plain-text XML, since they each come with their own fluent model. SimDatas can also be edited as XML, if that's what you're used to.

const mergedStbl = new StringTableResource();

listOfStbls.forEach(stbl => {
  mergedStbl.addAll(stbl.entries);
});

pkg.add(key, mergedStbl);

Simple, Efficient, and Versatile

Extracting files? Just read the ones you need, and skip over everything else. Merging packages? Cache their buffers to reduce runtime by more than 60%. Need something non-blocking? Just use one of the async methods.

Package.streamResourcesAsync(filename, {
  resourceFilter(type, group, instance) {
    return type === BinaryResourceType.SimData;
  }
}).then(simdataEntries => {
  simdataEntries.forEach(doStuff);
});

Created by Frankk

I create mods for players and tools for my peers, and I sincerely hope you find them useful. All of my mods and tools are available for free, but if you enjoy my work and are able to support me on Patreon or Ko-fi, I would be very appreciative. Thank you!

With special thanks to...

Andrew and Orangemittens for creating Sims 4 Studio, which was invaluable during S4TK's development.

The late Scumbumbo for his internal compression script, and the source code of his XML Extractor program.

The creators and contributors of Sims 4 Package Interface, a .NET codebase with similar goals to S4TK.

Lot51 and Simsonian Library, for giving me ideas, helping me test, and making their own tools with S4TK.

Sims 4 Toolkit would not have been possible without the work done before it. A very sincere and humble thank you goes out to all mentioned above.

Created with ♥ by Frankk

Website | Twitter | Patreon | Ko-fi | Discord

The Sims™ and its plumbob icon are registered trademarks of Electronic Arts, Inc. (EA). Sims 4 Toolkit is not affiliated with or endorsed by EA.

All icons on this website are supplied by Ionicons, and all files are hosted on GitHub.