The Item Shipment Framework is a simple and modular tool that allows mod authors to ship items to their users. On this Wiki, you'll learn about the ISF, what it can do, and how easy it is to integrate your mods into the framework. Whether you're developing a new mod or updating one with an existing user base, integrating it into the ISF follows the same process. For mods that already have an existing user base, integrating with ISF is user-friendly, as it ensures that players will not receive duplicates for items they already possess. This is achievable due to the series of checks that the ISF can perform.

The framework provides a JSON configuration example file for mod integration, with comments detailing each setting. Due to (harmless) linting errors with said comments in standard JSON, both JSON and JSONC formats are supported by the ISF and are parsed in the same way, with or without comments.

ISF doesn't force mods into a mandatory dependency with the Script Extender. The configuration file will be picked up in case users have ISF installed, but will simply remain inert otherwise. Therefore, if your mod is designed to function without the Script Extender, integrating with the ISF will not change this.

• read the quick-start guide to further speed up your mod integration using the bespoke ISF integration tool;
• learn about example mods to see different use cases for the framework;
• and review the configuration settings to customize the framework to your mod's needs.

Here are ISF commands that can be entered in the SE console:

!isf_ship_all will trigger the shipment of all items managed by the Item Shipment Framework (ISF) when requested. By default, this occurs during gameplay start, such as when loading a save or swapping regions. The !isf_ship_all true command will skip the usual checks performed by the framework and force the shipment of all items.

!isf_ship_mod <MOD_UUID> will trigger the shipment of items for the specified mod, identified by its unique mod UUID. You can also pass true at the end of the command to skip the framework's usual checks.

!isf_uninstall will uninstall the ISF. During the uninstallation process, any items managed by the framework, other than ISF items, may be moved to the camp chest based on a user confirmation after requesting the uninstallation process. The ISF container will then be deleted.

!isf_refill will refill the mailboxes with any missing items that the framework is responsible for managing.

!isf_tut_update will update the Tutorial Chests copies, ensuring that the items they contain are up-to-date.

All of this functionality is available through normal gameplay, such as using ISF scrolls.