Here is every settings in ShipInventory. The settings are separated in sections, where the settings only affects the section it is within.
This setting determines what language package the mod uses. Upon starting up, the mod will look for the file named lang-CODE, where CODE is the value of this parameter. This allows anyone to create or modify language packages for specific languages.
This setting determines who can store items into the chute. This is on top of the base item check. For example, if the setting is set to CLIENTS_ONLY, only clients will be able to store items inside the chute. The host itself won't be able.
If a player tries to store an item while not having the required permission, a special message will appear to notify them that they can't store items.
This setting determines when the chute can store items. If the setting is set to true, no one will be able to store items inside the chute while the ship is on a planet. The chute will be enabled only when the ship gets back into orbit.
If a player tries to store an item while the ship is not in orbit, a special message will appear to notify them that they can't store items.
This setting determines how long a player has to hold the interact button in order to store an item. If players usually store items in bulk, the setting can be set to a lower value, allowing the process to be done way faster.
This setting determines how fast each item takes to be retrieved. If players usually retrieve items in bulk, the setting can be set to a lower value, allowing the process to be done way faster.
This setting determines how many items can be in the chute itself at once before pausing the retrieve process. For example, if the setting is set to 5 but a player retrieve 20 items, the chute will spawn the 5 first items, but pause until an item is taken. This is to limit potential lag when retrieving items in bulk.
This setting determines which items are not allowed to be stored in the chute. The mod already blocks certain items due to not working with the system, but players can also block certain items that they feel like are overpowered.
Here are the different things you should know about it:
- It is case insensitive (
flashlightandFlASHLiGhtare the same); - It is space insensitive (spaces before and after an item are removed);
- It supports REGEX expression (
.*lightfor every items that ends withlight); - It only checks for the
itemName(it is the name shown in the terminal); - Each item is separated by a
,(item1,item2,item3,item4);
If a player tries to store an item that is blacklisted, a special message will appear to notify them that this item is not valid.
This setting determines who can retrieve items from the inventory. For example, if the setting is set to CLIENTS_ONLY, only clients will be able to retrieve items from the inventory. The host itself won't be able.
This setting determines if the inventory is cleared when all players die. This is useful if you want to use this mod as a safe, allowing you to keep some items in order to recover better from the lost.
This setting determines if the inventory is cleared when the crew gets fired. This is useful if you want to have an advantage when restarting a run, removing some of the grinding by allowing you to keep some items from previous runs.
This setting determines how many items can be stored in the inventory. For example, if the setting is set to 20, players will only be able to store 20 items in the inventory before needing to retrieve items.
If a player tries to store an item while the inventory is full, a special message will appear to notify them that the inventory is already full.
This setting determines how likely each item is to be kept when the inventory is cleared. For example, if the setting is set to 50, each item has a 50% chance to be kept or to be cleared.
This setting determines the command to type in order to access the inventory. Commands are something exclusive, so you might need to change the command to something else in order to be able to type it. For example, you can't put inventory as the command because of Inverse Teleporter, but you can put ship.
This setting determines if the cursor is placed on the yes option when retrieving an item. This is useful when you need to retrieve items in bulk, but you don't want to have to scroll down each time and you want to keep the confirmation.
This setting determines if the inventory shows a confirmation when retrieving an item. This is useful when you need to retrieve items in bulk, without worrying about the confirmation.
This setting determines if the inventory shows the trademark in the terminal. Even though the trademark is themed around Lethal Company (I could've put my own trademark), it takes unnecessary space on the screen.
This setting determines in which order the items are shown in the inventory. For example, if the setting is set to VALUE_DESC, the most valuable items are going to be on the first pages while the least ones are going to be on the last ones.
This setting determines if the retrieve all option is shown for every player. This is useful to stop players from simply dumping every item possible, with no way to stop them. While it's still possible for players to dump every item, it takes way longer.
This setting determines how often clients will update their copy of the inventory.
This was implemented due to past problems with desync between clients. However, this comes at a cost of an higher WIFI cost, sending a small request every time (the cost is actually very small, almost insignificant, but just wanted to let you know).
This setting determines if the mod logs each update in the console. The logs can be useful for developers to debug the mod.
If you decide to remove this, you are on your own for any desync problem
This setting determines if the client forces to update itself when the player stores an item.
This setting determines if the client forces to update itself when the player retrieves an item.
This setting determines if the chute is an unlockable upgrade. If you enter a lobby with the setting set to false, the chute will be permanently unlocked for this save.
This setting determines how expensive the upgrade is to buy. This is useful if you want to balance this mod.
This setting determines the command to type in order to buy the inventory. Commands are something exclusive, so you might need to change the command to something else in order to be able to type it. For example, you can't put inventory as the command because of Inverse Teleporter, but you can put ship.