Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.3 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.3 KB
Raw

Sims 4 Toolkit - BufferFromFile Plugin

Overview

This is a wrapper for BufferFromFile, so that it can optionally be included in @s4tk/models.

Installation

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

npm i @s4tk/plugin-bufferfromfile

Usage

To use this plugin, include the following at the beginning of your S4TK script. This only needed to be run once, but running it more than once will not cause any problems.

// ESM / TS
import { registerPlugin } from "@s4tk/models/plugins";
import BufferFromFile from "@s4tk/plugin-bufferfromfile";
registerPlugin(BufferFromFile);

// CJS
const { registerPlugin } = require("@s4tk/models/plugins");
const BufferFromFile = require("@s4tk/plugin-bufferfromfile").default;
registerPlugin(BufferFromFile);

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.