Cidan / BetterBags

A total replacement AddOn for World of Warcraft bag frames, inspired by AdiBags.
MIT License
88 stars 39 forks source link
# BetterBags [![Discord BetterBags](https://discordapp.com/api/guilds/1063213796845428876/widget.png?style=banner2)](https://discord.gg/a6DQuK8hV7) [![CurseForge BetterBags](https://img.shields.io/badge/CurseForge-BetterBags-F16436.svg?style=flat)](https://www.curseforge.com/wow/addons/better-bags) [![Wago BetterBags](https://img.shields.io/badge/Wago-BetterBags-C1272D.svg?style=flat)](https://addons.wago.io/addons/betterbags/versions?stability=stable) [![Package and release](https://github.com/Cidan/BetterBags/actions/workflows/release.yml/badge.svg)](https://github.com/Cidan/BetterBags/actions/workflows/release.yml) BetterBags Logo BetterBags is a bag replacement addon for World of Warcraft, inspired by AdiBags. It has a fresh, clean look, updated to the 2024 World of Warcraft art style. It currently includes most of the features of AdiBags and is being worked on daily. One of the last major features currently missing is user selectable themes. If you have any feedback, please let us know in the [Discord](https://discord.gg/a6DQuK8hV7). BetterBags currently supports the following versions of World of Warcraft: Retail (including WoW: Remix and The War Within Pre-Patch) Classic (Era, Cataclysm Classic, SoD, etc.) The War Within Beta

Screenshots

The Retail main player bag view with multiple custom categories. Currency selection in Retail.
The Retail main player bag view with multiple custom categories. Currency selection in Retail.
Configure Categories in Retail, allows you to pin and enable (highlighted) and disable a category. Extensive View options that can be fine-tuned by the user.
Configure Categories in Retail, allows you to pin and enable (highlighted) and disable a category. Extensive View options that can be fine-tuned by the user.

Summary

More additions are being added all the time.

Features

Bag & Bank View

BetterBags offers its users a powerful category-based view, which also carry over to the bank.

Section Grid

This view sorts your inventory into their own visually distinct categories, allowing you to categorize items at a basic level that is easier for humans to understand by grouping like items together.

The Section Grid offers:

Section Grid View in Retail. *Section Grid View in Retail.*

Navigation

Most options and other important information in BetterBags can be reached by left-clicking on the bag button in the top-left corner of the bag (or bank) and bringing up the menu. Hovering over the bag icon will bring up a list of mouse-clicks that can be done for various functions. Some of the important functions in the menu are described in the following sections. Any options not in the menu directly are instead in the options screen (access by choosing Open Options Screen in the menu or the slash command /bb).

Menu in Retail. *Menu in Retail.*

Show Bags

This temporary view allows you to see your bags and the items within them how they currently are. It also allows you to swap out which bags are equipped for both the backpack and the bank.

Show Bags in Retail. *Show Bags in Retail.*

Bag Anchor

By default, the bag and bank will grow from the bottom-left corner. Extending both up and right depending on the number of items per row and number of columns. A specific anchor can be turned on by left-clicking the bag icon in the top-left corner of the bag and bank. It will allow you to drag the anchor to a specific pixel and grow the bag from whichever corner the anchor is in. Selecting Enable will turn on the anchor. Selecting Show will allow you to manipulate the anchor and choose the location. Manual Anchor will allow you to choose which corner you want the bag to grow from. If you leave it on Automatic, the bag will grow away from the closest corner.
You can also enable and show the anchors with the slash command /bbanchor. To hide the anchor (but keep it enabled), simply right-click anywhere in the blue anchor.

Bag Anchor in Retail. *Bag Anchor in Retail.*

Free Spaces

The default view for free spaces is to have them in 1 icon with a number showing how many free spaces you have in each type of container equipped. Regular bag slots are on the right and special containers (like Reagent Bags) are on the left. If you would rather see all of the spaces with their own icon, there is a setting in the config window to display them in that manner. When free spaces are all shown, non-regular bag containers will have a border around them to denote what type of container they belong to (Green for Reagent Bag on Retail).

Free Space Icons in Retail. Show All Free Spaces in Retail.
Free Space Icons in Retail. Show All Free Spaces in Retail.

Extra Glowy Item Buttons

If you would like more glow on the action buttons (more like what AdiBags had), there is a setting to turn on Extra Glowy Action Buttons in the options screen.

Normal Icons in Retail. Extra Glowy Icons in Retail.
Normal Icons in Retail. Extra Glowy Icons in Retail.

Item Level Upgrade Arrow

Equipment in your bags that is an item level upgrade compared to the gear you are currently wearing will have a green upgrade arrow in the top corner of the item in your bags. This lets you easily see which pieces of gear in your bags might be an upgrade, such as when you're leveling and your item level is rapidly increasing.

Item Level Upgrade in Retail. *Item Level Upgrade in Retail.*

Show Currencies

Currencies can be tracked at the bottom of the bag window. Up to 7 currencies can be shown at a time and tracking them is as simple as clicking on the currencies in the Show Currencies side window. Any currency that is highlighted is currently tracked. If you attempt to track more than 7 currencies, only the first 7 in the list will be shown at the bottom of the bag.

Currencies Side Window in Retail. *Currencies Side Window in Retail.*
Tracked Currencies in Retail. *Tracked Currencies in Retail.*

Configure Categories

Categories have a few ways in which they can be configured. All categories can be pinned or hidden. Non-dynamic categories can also be enabled or disabled. Custom categories can be deleted. Hovering over a category will bring up a tooltip that describes the actions that can be taken for that category.

The Configure Categories Side Window in Retail. Category Options in Configure Categories in Retail.
The Configure Categories Side Window in Retail. Category Options in Configure Categories in Retail.
Configure Custom Categories in Retail. Configure Search Category in Retail.
Configure Custom Categories in Retail. Configure Search Category in Retail.

Bank

Bank Tabs

BetterBags displays the different types of bank as tabs along the bottom of the bank window. It also includes the option to purchase the Reagent Bank and any available Warband Bank tabs.
Tabs include:

Bank Tabs in Retail. *Bank Tabs in Retail.*

Bank Bags

To purchase bank bag slots, turn on Show Bags and click on any red bag slot.

Purchasing Bank Bag Slots in Retail. *Purchasing Bank Bag Slots in Retail.*

Warbank Tabs

To purchase Warbank tabs, click on the Purchase Warbank Tab button, then click purchase on the Blizzard pop-up.
Warbank tabs can be renamed and certain item types can be assigned to them by right-clicking on the tab at the bottom of the bank. This will bring up the Blizzard prompt to make any changes. Depositing items into the Warbank tabs will deposit them using Blizzard's rules for depositting items into the Warbank.

Editing Warbank Tab in Retail. *Editing Warbank Tab in Retail.*

To deposit or withdraw gold from the Warbank, hover over the gold amount at the bottom of the bank/warbank window and left or right click. This works from any tab in the bank window.

Manipulating Warbank Money in Retail. *Manipulating Warbank Money in Retail.*

Recent Items

BetterBags places items that have been flagged as new by the WoW client in a special category at the top of your bag so that you can quickly find these looted items.
Note: To clear recent items manually, right-click the bag icon. On Cataclysm and Classic, you must install the SortBags Addon to manually clear recent items.

These can be further fine-tuned by:

Recent Items in Retail *Recent Items in Retail.*

To disable recent items, uncheck the Recent Items category in the config window and set the New Item Duration to 0. After hovering over the item and changing anything in the bags, it will stop flashing.

Move Categories

Right-clicking on a category header in your bank or bags will move the entire contents of the category to whatever other window you currently have open. Supported windows include bags, all bank tabs, the mailbox, the trade window, and vendor windows. Selling items to vendors by right-clicking the header must be turned on in settings.

Move Category in Retail *Move Category in Retail.*

Search

BetterBags offers a comprehensive Search option that can be toggled with a keybinding (BetterBags > Search Bags).

When searching for bare words (eg. "Signet"), the search will match any item that has the word in the entire text of the default indices, which includes name, type, subtype, category, equipmentLocation, and binding. When searching in an index (eg. "name = Signet"), using the = operator will search in a prefix style, meaning the things you are searching for must start with what you type. To support full-text searching of each field, use the %= operator.
If you would like to exclude items in gear sets from your searches, the easiest way to do so is add and not category = "gear:" to the end of your search. (eg. slot = finger or slot = neck and not (category = 'gear:') will highlight all rings and necklaces that are NOT part of a gear set) Search allows you to find items by the following indices (based on the item below):

Example Item in Retail. *Example Item in Retail.*

Strings

Numbers

Booleans

Logical Operators

Comparison Operators

Note: These only work on numerical fields. Rarity names can be used with these operators.

Complex Search in Retail. *Complex Search in Retail.*

BetterBags also allows you to turn on a search bar near the top of the bag instead of the floating search box.

In-Bag Search Bar in Retail. *In-Bag Search Bar in Retail.*

Custom Categories

BetterBags allows items to be grouped into custom categories. These categories can be manually populated by the user, created by plugins, or created from a search.

Manual Custom Categories

To manually create custom categories that you can add items to, left-click on an item, then hover over the bag button in the top-left of the bag, and left-click again. You can also left-click and drag the item to the bag button, then drop it. Enter in a name for the new category and your item will be added to it. To add new items into categories, you can do the same procedure with any category name, but hold shift while dropping the item.

Create a New Category in Retail. Name a New Category in Retail. Add an Item to a Category in Retail.
Create a New Category in Retail. Name a New Category in Retail. Add an Item to a Category in Retail.

Search-based Custom Categories

Any search you complete has the option to be turned into a custom category. These categories will dynamically update as new items are added to the bag that match the search criteria.
To create a Search Category, type in a search, then press Enter. Fill out the required information in the dialogue box and save.

Creating a Search Category in Retail. Configure Search Category in Retail.
Creating a Search Category in Retail. Configure Search Category in Retail.

Themes

BetterBags offers a few built-in themes and an API to allow addon authors to create their own themes.
BetterBags will detect if you have ElvUI or GW2 UI installed and offer an addon specific theme.

Simple Dark Theme in Retail. GW2 UI Theme in Retail.
Simple Dark Theme in Retail. GW2 UI Theme in Retail.

Plugin System

BetterBags has a robust plugin system that allows developers to write custom categories.

Plugins have the following options:

Plugin System (BetterBags - Appearances) in Retail *Plugin System (BetterBags - Appearances) in Retail.*

Upcoming Updates

BetterBags is constantly getting new features and updates.
Github hosts both our Progress Board and means to report bugs and request new features.

The following features are under active development:

These features are planned for the long term: