Sims 4 Toolkit - Models (@s4tk/models)

Overview

This project contains the models, enums, and other structures required for reading and writing Sims 4 package files and the resources they contain.

Installation

Install the package as a dependency from npm with the following command:

npm i @s4tk/models

Plugins

To use plugins, first import registerPlugin from @s4tk/models/plugins, then follow the directions in the README of the specific plugin you would like to use.

Disclaimers

Sims 4 Toolkit (S4TK) is a collection of creator-made modding tools for The Sims 4. "The Sims" is a registered trademark of Electronic Arts, Inc. (EA). Sims 4 Toolkit is not affiliated with or endorsed by EA.

All S4TK software is currently considered to be in its pre-release stage. Use at your own risk, knowing that breaking changes are likely to happen.

Documentation

Visit sims4toolkit.com/#/docs/models for the most up-to-date documentation.