dave/barotrauma-localmods
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add readme, such as it is

Browse Source
This commit is contained in:
PhatPhuckDave
2025-03-31 13:13:29 +02:00
parent 11be034c8f
commit 2d9f3cabe4
1 changed files with 56 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
QuickStackToBag/README.md
View File

@@ -4,12 +4,25 @@ A Barotrauma mod that allows you to quickly stack items from your inventory into
## Features
- Press F to quickly stack items from your inventory into containers
- Supports stacking into multiple containers in your inventory (backpacks, pouches, toolbelts, etc.)
- Prioritizes the main backpack in the bag slot
- Items are stacked with matching items in containers when possible
- Automatically skips hand slots and diving gear
- Provides feedback messages in chat
- **Quick Stack:** Press F to quickly stack items from your inventory into containers.
- Supports stacking into multiple containers in your inventory (backpacks, pouches, toolbelts, etc.).
- Prioritizes the main backpack in the bag slot.
- Items are stacked with matching items in containers when possible.
- Automatically skips hand slots and diving gear.
- Provides feedback messages in chat.
- **Fabricator Stack:** Press V to quickly stack items from your inventory into the fabricator.
- **Quick Buy:** Press B to quickly buy items from the store.
- **Hotkey Repair:** Press R to quickly repair items.
- **Cursor Macroer (Stack to Cursor):** Hold ALT and click to stack items to the item under the cursor. Mouse4 to set target inventory.
- **Quick Unload:** Press E to quickly unload items from the cursor.
- **Quick Reload:** Press R to quickly reload items. Hold SHIFT to reload all items.
- **Quick Loot:** Press L to quickly loot items.
- **Sonar Pinger:** Press X to quickly ping the sonar.
- **AOE Pickup:** Press Y to quickly pickup items in an area.
- **Quick Access:**
- Press K to quickly access the fabricator.
- Press J to quickly access the deconstructor.
- Press M to quickly access the medical fabricator.
## Installation
@@ -18,28 +31,44 @@ A Barotrauma mod that allows you to quickly stack items from your inventory into
## Configuration
You can modify the following settings in the `QuickStackToBag.lua` file:
You can modify the following settings in the `Lua/Autorun/init.lua` file:
- `TRIGGER_KEY`: The key to press for quick stacking (default: F)
- `BAG_TAGS`: Tags that identify bags/containers
- `MAX_ITEMS_TO_PROCESS`: Safety limit to prevent infinite loops
- `PREFER_EXISTING_STACKS`: Whether to prefer stacking into existing item stacks
- `CHECK_ALL_CONTAINERS`: Check all containers in inventory, not just primary bag slot
- `PRIMARY_BAG_SLOT`: Slot number for the primary bag (typically slot 8)
- `SKIP_HAND_SLOTS`: Skip hand slots when processing items
- `HAND_SLOTS`: Slot numbers for hands (typically slots 6 and 7)
- `SKIP_DIVING_GEAR`: Skip diving gear when processing items
- `DIVING_GEAR_TAGS`: Tags for diving gear to skip
- `QUICKSTACK_KEYS`: The key to press for quick stacking (default: F)
- `FABRICATOR_KEY`: The key to press for quick stacking into the fabricator (default: V)
- `MAX_BUY`: The key to press for quick buying items from the store (default: B)
- `FIX`: The key to press for quick repairing items (default: R)
- `UNLOAD`: The key to press for quick unloading items from the cursor (default: E)
- `RELOAD`: The key to press for quick reloading items (default: R)
- `STACK_TO_CURSOR`: The key to press for stacking items to the cursor (default: G)
- `LOOT`: The key to press for quick looting items (default: L)
- `SONAR`: The key to press for quick pinging the sonar (default: X)
- `AOEPICKUP`: The key to press for quick picking up items in an area (default: Y)
- `QICK_FABRICATOR`: The key to press for quick accessing the fabricator (default: K)
- `QICK_DECONSTRUCTOR`: The key to press for quick accessing the deconstructor (default: J)
- `QICK_MEDICAL_FABRICATOR`: The key to press for quick accessing the medical fabricator (default: M)
- `NESTED_CONTAINERS`: Whether to check nested containers for stacking (default: true)
- `DEBUG_MODE`: Whether to enable debug mode (default: true)
- `BAG_SLOT`: The slot number for the primary bag (default: 8)
## How It Works
When you press F:
1. The mod identifies all containers in your inventory
2. It then checks each item in your inventory (except those in your hands or diving gear)
3. For each item, it tries to stack it into a matching stack in a container
4. If no matching stack is found, it tries to place it in any valid slot
5. Items are moved in order of container priority (main backpack first, then other containers)
## Credits
Based on the "Press R to Reload" mod structure.
- **Quick Stack:** When you press F:
1. The mod identifies all containers in your inventory
2. It then checks each item in your inventory (except those in your hands or diving gear)
3. For each item, it tries to stack it into a matching stack in a container
4. If no matching stack is found, it tries to place it in any valid slot
5. Items are moved in order of container priority (main backpack first, then other containers)
- **Fabricator Stack:** When you press V, the mod attempts to stack items from your inventory (and then the entire submarine) into the connected fabricator to match the recipe.
- **Quick Buy:** When you press B, the mod attempts to buy the maximum amount of the item under the cursor from the store.
- **Hotkey Repair:** When you press R, the mod attempts to repair the item under the cursor mimicking clicking the repair button once.
- **Cursor Macroer (Stack to Cursor):** When you hold ALT and mouse over items, the mod attempts to move each item under the cursor to the target inventory.
- Press mouse4 over an inventory to set it as the target.
- **Quick Unload:** When you press E, the mod attempts to unload the item under the cursor.
- **Quick Reload:** When you press R, the mod attempts to reload the item under the cursor.
- **Quick Loot:** When you press L, the mod attempts to loot items from dead creatures from the entire map.
- **Sonar Pinger:** When you press X, the mod attempts to ping the sonar while you are the captain.
- **AOE Pickup:** When you press Y, the mod attempts to pickup items in an area.
- **Quick Access:**
- When you press K, the mod attempts to open the submarine's fabricator.
- When you press J, the mod attempts to open the submarine's deconstructor.
- When you press M, the mod attempts to open the submarine's medical fabricator.