https://github.com/sims4toolkit/models
Models for packages and the resources they contain.
https://github.com/sims4toolkit/models
nodejs npm s4tk-library sims4 sims4-tool typescript
Last synced: 24 days ago
JSON representation
Models for packages and the resources they contain.
- Host: GitHub
- URL: https://github.com/sims4toolkit/models
- Owner: sims4toolkit
- License: mit
- Created: 2021-11-15T01:13:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-10T22:00:40.000Z (about 1 year ago)
- Last Synced: 2025-05-09T12:18:44.735Z (about 1 month ago)
- Topics: nodejs, npm, s4tk-library, sims4, sims4-tool, typescript
- Language: TypeScript
- Homepage: https://sims4toolkit.com/#/docs/models
- Size: 2.29 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```sh
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](https://www.ea.com/games/the-sims). "The Sims" is a registered trademark of [Electronic Arts, Inc](https://www.ea.com/). (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](https://sims4toolkit.com/#/docs/models) for the most up-to-date documentation.