SULFUR Content Lib

A library for SULFUR mods that add new items, enchantments and recipes. It does nothing by itself. Install it when another mod lists it as a requirement.

What it does for you

Mods that add items need ids for them, and two mods can easily pick the same one. This library hands the ids out, so mods built on it do not collide with each other or with Custom Item Framework.

It also looks after your save. Each save remembers which item every id stood for. If you add or remove a content mod and the ids move, your items are still the same items the next time you load.

If you remove a content mod

Keep the library installed and the items you owned from that mod are not deleted. Everything in your backpack, on your character, in any stash and in the Collection Box is put aside. Install the mod again and it all comes back into the main stash, unequipped, the next time you are at the church. If the stash is full, items wait until there is room.

An attachment from that mod is taken off the weapon and put aside with the rest. An enchantment from that mod is removed and comes back as the oil or scroll that applied it. You put them back on yourself.

The same happens when a content mod is still installed but one of its enchantments could not be set up: the enchantment is taken off your weapons and the oil or scroll that applied it goes to the main stash.

A few things do not come back: shop stock from the removed mod, the record of a weapon from it that you sacrificed, and a quest that asked for one of its items.

Before you remove this library

Removing the library loses the items of every content mod built on it. The game cannot load them without it. It drops them with the message "A rat took your item", and a weapon loses the attachments and enchantments those mods added. Once the game saves, they are gone for good. Installing the library again does not bring them back.

If you only want to drop one content mod, remove that mod and keep the library.

Two kinds of items are the exception: items of a content mod you removed earlier, which were already put aside, and items waiting in the Collection Box at the church. They stay in your save while the library is gone, and they are there again when the library is installed again.

If you see "this session is NOT being saved"

The library found something wrong and stopped the game from writing your save, so the save on disk stays as it was. Nothing you do in that session is kept. The BepInEx log says what went wrong.

Ammo

A content mod can add its own ammo pickup, but the game only stores how much ammo of each caliber you have. Once picked up it is ordinary ammo.

Playing with SULFUR Together

If your content mods differ from the host's, the connect page asks before you join, and you can cancel or join anyway. A host is told when a player with different content joins.

While your content differs, no item from any content mod is shown to the other player, including items you both have. An item you drop stays yours to pick up. A weapon the other player takes arrives without the attachments and enchantments that content mods added. Everything from the base game is shared as usual.

Two different versions of the same content mod are not detected. Keep them the same on every machine.

This needs a SULFUR Together release that checks content when you join. With an older one, play only with the same content mods on every machine.

Compatibility

• Custom Item Framework: works side by side. The two use different id ranges.
• SULFUR Together: optional. See above.

For mod authors

See the repository for how to declare items, enchantments and recipes.