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.

Console Commands

!isf_ship_all will trigger shipment when requested (default is with gameplay start), !isf_ship_all true will skip checks.

!isf_ship_mod <MOD_UUID> will trigger shipments for the specified mod, and you can also skip checks.

!isf_uninstall will uninstall ISF. Items other than ISF may be moved to the camp chest based on prompt. The ISF container will be deleted.

!isf_refill will refill the mailboxes with missing items.

!isf_tut_update will update tutorial chests.

Item Shipment Framework Config Settings

Quantity

Here, you can specify the amount of the item which you would like to spawn in.

To

This section features two main settings, CampChest, and Host. These settings determine where you would like to send users your items.

CampChest, and its associated keys, determine which of the four camp chests you would like to send your items to. If these keys are set to True, the ISF will spawn your items into the associated chest. You may choose to send your items to all four of the chests if you would like to support multi-player, or none at all, if you would prefer to use the next option.

Host, if set to True, will tell the ISF to spawn items directly into the host player's inventory. This is useful if your items are required to be inside this player's inventory, however we encourage authors to only use this setting if absolutely necessary, as spawning items directly into player inventories could quickly cause them to become cluttered.

On

Here, you can specify

Example Mods

All Camp Clothes in the Camp Chest

Single Container and UUID, the simplest possible ISF integration.

Debug Book in the Host's Inventory

uses host, spawns during the tutorial

Infinite Health Potions

uses host, infinitely spawning items, no framework check, checks inventories

Infinite Supply Packs

doesn't use host, Infinitely spawning items, no framework check, checks inventories