Home

Aether & Volitio's Item Shipment Framework Wiki

General Information

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.