From 5d283909db15ab3e893f8921943616fbaab412c0 Mon Sep 17 00:00:00 2001 From: trunksbomb Date: Mon, 23 Mar 2026 05:01:55 -0400 Subject: [PATCH] first pass on README --- README.md | 109 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 90 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index b421122..af15c69 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,96 @@ +# Bag Tabs -Installation information -======= +Bag Tabs is a NeoForge mod for Minecraft 1.21.1 that adds a tab strip to inventory screens for bags and other portable storage items you are carrying. -This template repository can be directly cloned to get you started with a new -mod. Simply create a new repository cloned from this one, by following the -instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template). +The goal is simple: if you are carrying a bag, you should be able to open it directly from your inventory without moving it into your hand first. -Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse. +## What It Does -If at any point you are missing libraries in your IDE, or you've run into problems you can -run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything -{this does not affect your code} and then start the process again. +- Adds a tab bar to supported inventory screens. +- Shows one tab for each carried bag or portable storage item the mod recognizes. +- Lets you click a tab to open that bag directly. +- Keeps the tab bar visible while you move between supported bag screens. +- Highlights the currently open bag. +- Supports drag-and-drop insertion onto supported bag tabs when the bag can accept the carried stack. -Mapping Names: -============ -By default, the MDK is configured to use the official mapping names from Mojang for methods and fields -in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this -license. For the latest license text, refer to the mapping file itself, or the reference copy here: -https://github.com/NeoForged/NeoForm/blob/main/Mojang.md +## Included Content -Additional Resources: -========== -Community Documentation: https://docs.neoforged.net/ -NeoForged Discord: https://discord.neoforged.net/ +- A built-in Bag Tabs bag item. +- 27 inventory slots, like a single chest. +- Dyeable bag colors. +- Crafting recipe. +- Creative tab with the base bag, all dyed variants, and the Bag Namer tool. +- JEI entries for the dyed bag variants. + +## Tab Features + +- Bag tabs use the bag item icon for normal mode. +- Compact mode replaces the icon with the bag name. +- Dyed bags tint their tab background. +- Pinned tabs always appear first. +- Pinned tabs can be reordered by drag-and-drop. +- Tabs can be locked to disable pinning and reordering. +- Overflow arrows appear automatically when more tabs exist than can be shown. +- Mouse wheel scrolling works over the dock. +- Fullness indicators can be shown on tabs and toggled in dock settings. + +## Dock Features + +- Dock to the GUI bottom, top, left, or right. +- Dock to the screen bottom, top, left, or right. +- Floating horizontal and floating vertical modes. +- Per-player, per-world saved settings. +- Global default settings plus per-screen overrides. +- Remembered scroll position per screen. +- Adjustable X/Y offset. +- Adjustable max visible tabs. +- Optional compact layout. +- Optional fullness indicator. +- Draggable in-game dock settings popup with live preview. + +## Bag Opening Behavior + +Bag Tabs supports two kinds of bag opening: + +- Direct support for bags with native or compatibility-backed integration. +- A fallback hotbar method for unsupported portable storage items that still look like bags or containers. + +When a bag is not fully supported, the tooltip says: + +- `Mod not supported: uses hotbar method to open` + +If no warning is shown, the bag is using native or compatibility-backed support. + +## Current Compatibility + +Bag Tabs currently includes compatibility support for: + +- Bag Tabs bags +- Traveler's Backpack +- Sophisticated Backpacks +- Dank Storage + +Other portable storage items may still appear as tabs and may still open through the fallback hotbar method. + +## Bag Namer + +Bag Tabs includes a Bag Namer tool that can rename portable storage items. + +- Works on supported bags and inventory-like items. +- Uses an in-world style GUI with input and output slots. +- Does not close after each rename, so items can be renamed in batches. +- Drops its contents if you leave the screen. + +## Controls + +- Left-click tab: open bag +- Right-click tab: pin or unpin +- Drag pinned tab: reorder pinned tabs +- Mouse wheel over dock: scroll visible tabs +- `\` by default: open last bag + +## Notes + +- Bag Tabs is designed to stay attached to existing inventory screens rather than replacing them. +- Unsupported bags may behave differently depending on how their mod handles right-click opening. +- Some mods may still need dedicated compatibility if they do not expose normal item-use behavior.