Subscribe to download
Inventory Organizer

Huge shoutout and thanks to Rezecib for writing the “ModSettings” plugin/mini library. I used this to save the inventory configs to disk. It saved me a lot of time and energy (pun very much intended).

---

If you experience a crash that you believe is a result of this mod, please send me a message through the Klei Forums. Please include your client log and try to include as accurate of a description as you can of what was going on at the time of the crash. Doing this will make troubleshooting a lot easier and will help keep the comments section of this workshop page clean of messages like “Help plz. Mod is broken.”

For all other comments, concerns, suggestions, etc. feel free to use the comments section on the steam workshop page or reach out to me on YouTube, Discord, or Twitch.

---

The main purpose of this mod is to allow you to save up to 5 different inventory configurations and reload them at any time. The following is a tutorial on how to use the mod.


This mod has two key bindings. The “Cycle” button defaults to ‘b’ and the “Save/Load” button defaults to ‘n’. These can be reconfigured in the mod settings.

This mod has two modes: “group” and “inventory”. You always start out in inventory mode. In inventory mode you can save and load inventory configurations, and switch which inventory config you are currently using. In group mode you can save groups, and switch which group slot you are currently using. Press and hold the “Cycle” button to switch between these two modes.

Now, I will show you how to create an inventory configuration. While in inventory mode, simply organize your inventory however you like, then hold down the “Save/Load” button to save your configuration to the active config slot. Currently it will not save what is in your hand or head slot, but I can add that if enough people want it. These inventory configurations should work with modded items as well as vanilla items. If you create an inventory config with a modded item, then disable the mod that adds that item, then the Inventory Config mod should still work just fine. It will just ignore the modded item. If you then later reenable the modded item, then the inventory config with the modded item should automatically work correctly again.

To load the active configuration slot, just press and release the “Save/Load” button while you are in inventory mode. These configurations work with all backpack types or even no backpack at all. I would not recommend changing your inventory while loading a config as it can cause the mod to put things in the wrong place. One thing to note about loading is that the mod will never take items from your hand or head; however, if enough people think this is worth doing then I will consider it.

You can have up to 5 inventory configurations saved at once. Although if enough people request it, I can easily increase this limit. To switch which config gets saved or loaded, simply press and release the “Cycle” button, while you are in inventory mode.

But what if you have an inventory slot where you want the mod to choose from a variety of items when loading the inventory configuration? For example, what if you wanted the first 3 slots in your inventory to be filled with whatever tools you happen to have in your inventory? Well for that you need to use groups.

To create a group, you must first be in group mode. Then you need to pick a group label. A group label is an item that you will use in your inventory configuration to tell the mod that you are referencing a group rather than the item itself. This will make more sense later, for now just pick an item that you won’t be using in your inventory configurations. Next, put the group label into the first slot in your inventory (the left most slot of your player’s inventory). Next put all the items that you want to be in the group into your inventory and/or backpack. The item used for a group label is not actually in the group itself. When creating a group, you can use any type of backpack or none at all. Next hold down the “Save/Load” button to save your group to the current active group slot. You have now created a group, but you still need to use it. First you need to press and hold the “Cycle” button to go back into inventory mode. Once in inventory mode, organize your inventory how you want it. To use a group in your inventory configuration, simply put the group label into whatever slot or slots you want to use the group. Then press and hold the “Save/Load” button and the inventory config will save. Now when you load the inventory configuration, the mod will use the group.

Groups are not just a list of items but an ordered list of items. So, when the mod goes to put an item into a slot that used a group, the mod will search your inventory for the first item in the group, then the second item in the group, and so on. The second slot in the player’s inventory is the 1st item the mod looks for. The last slot in the player’s backpack is the last item in the ordered list and thus will only get taken if none of the other items in the group are present in the inventory. To see a visualization of these priority orders, check these timestamps in the tutorial video: 3:13 and 3:18.

You can have up to 5 groups saved at once. Although if enough people request it I can easily increase this limit. To switch which group slot gets saved, simply press and release the “Cycle” button, while you are in group mode.

If you need to create a larger group, you can combine different groups together. You can combine up to all 5 groups if you want to. To combine different groups together just save different group slots with the same group label. Then whenever you use that label, the mod will treat the multiple groups as one. Item priorities for these combined groups work like this: all the items in the smallest numbered group have their normal priorities, those items are then followed by all the items in the next highest numbered group (which have their normal priorities), and so on.

One last thing to note is how the mod saves. Your inventory configurations are saved to disk whenever you create them. The save data for these inventory configurations also contains any groups they use. This means that your inventory configs will work across servers, even if they contain groups. This also means that the group slots themselves are never saved, because the inventory configurations handle that. So, after you are done using a group in your inventory configurations, feel free to overwrite the group as it will get destroyed anyways. This can be useful if you are done using a group and decide you want to use that same group label for a different configuration or a different group.

---

• Have lower priority group items moved to make way for high priority items of the same group.
  
• Allow players to name inventory configurations.