Configuration Examples

Default Configuration

These are the actual default items and categories that ship with RCC, extracted from RaidConsumableChecker_Constants.lua.

Flask Example

Flasks are long-duration consumables with buff tracking:

RaidConsumableChecker_Constants.lua

{
  itemName = "Flask of Supreme Power",
  itemID = 13512,
  iconPath = "INV_Potion_41",
  requiredCount = 1,
  buffName = "Supreme Power",
  description = "Increases damage done by magical spells and effects by up to 150 for 2 hrs. You can only have the effect of one flask at a time. This effect persists through death.",
  category = "category1",
  entryType = "consumable"
}

Key Features:

✅ Tracks inventory count (requiredCount = 1)
✅ Monitors “Supreme Power” buff
✅ Click to use from bags
🟢 Green border when buff active >5 min
🟠 Orange border when buff <5 min
🔴 Red border when no buff

Weapon Enchant Example

Weapon enchants use the special EQUIPPED_WEAPON keyword:

RaidConsumableChecker_Constants.lua

{
  itemName = "Wizard Oil",
  itemID = 20750,
  iconPath = "INV_Potion_104",
  requiredCount = 4,
  buffName = "EQUIPPED_WEAPON",
  description = "While applied to target weapon it increases spell damage by up to 24. Lasts for 30 minutes.",
  category = "category1",
  entryType = "consumable"
}

Key Features:

✅ Uses EQUIPPED_WEAPON keyword
✅ Tracks main hand weapon enchant
✅ Shows inventory count
🟢 Green when weapon is enchanted
🔴 Red when no enchant detected

Works for all weapon enchants: Wizard Oil, Mana Oil, Sharpening Stones, Rogue Poisons, etc.

Raid Food Example

Food buffs with specific buff names:

RaidConsumableChecker_Constants.lua

{
  itemName = "Runn Tum Tuber Surprise",
  itemID = 18254,
  iconPath = "INV_Misc_Food_63",
  requiredCount = 12,
  buffName = "Well Fed",
  description = "Restores 1933 health over 27 sec. Must remain seated while eating. Also increases your Intellect by 10 for 10 min.",
  category = "category1",
  entryType = "consumable"
}

Key Features:

✅ Item name is “Runn Tum Tuber Surprise”
✅ Buff name is “Well Fed” (different from item)
✅ Requires 12 in inventory
🟢/🟠/🔴 Border tracks “Well Fed” buff status

Many consumables give buffs with different names than the item. Always check the actual buff name in-game.

Elixir Example

Standard elixir with buff tracking:

RaidConsumableChecker_Constants.lua

{
  itemName = "Greater Arcane Elixir",
  itemID = 13454,
  iconPath = "INV_Potion_25",
  requiredCount = 2,
  buffName = "Greater Arcane Elixir",
  description = "Increases spell damage by up to 35 for 1 hour.",
  category = "category2",
  entryType = "consumable"
}

Key Features:

✅ Item and buff have same name
✅ Tracks inventory and buff status
✅ Assigned to “Main Elixirs” category

Instant Potion Examples

Potions without buffs (instant effect):

{
  itemName = "Major Healing Potion",
  itemID = 13446,
  iconPath = "INV_Potion_54",
  requiredCount = 10,
  description = "Restores 1050 to 1750 health.",
  category = "category3",
  entryType = "consumable"
}

Key Features:

✅ NO buffName field (instant effect)
⚫ Black border (no buff to track)
✅ Inventory counter shows green/red
✅ Click to use from bags

Do not add buffName to instant potions! Healing and mana potions don’t give buffs. Leaving buffName empty shows a black border (correct behavior).

Class Buff Examples

Buffs without physical items:

{
  displayName = "Thorns",
  iconPath = "SPELL_Nature_Thorns",
  buffName = "Thorns",
  description = "Thorns sprout from the friendly target causing 18 Nature damage to attackers when hit. Lasts 10 min.",
  category = "category4",
  entryType = "buff"
}

Key Features:

✅ entryType = "buff"
✅ NO itemName (no physical item)
✅ NO requiredCount (no inventory)
✅ Uses displayName for label
🟢/🟠/🔴 Border tracks buff status

Multiple buff variants let you track both single-target (Arcane Intellect) and group versions (Arcane Brilliance) with one entry.

Complete Category Set

Here are all default categories:

RaidConsumableChecker_Constants.lua

RCC_Constants.DEFAULT_CATEGORIES = {
  {
    id = "category1",
    name = "Flasks / Oil / Food",
    dashes = 20
  },
  {
    id = "category2",
    name = "Main Elixirs",
    dashes = 24
  },
  {
    id = "category3",
    name = "Potions",
    dashes = 26
  },
  {
    id = "category4",
    name = "Buffs",
    dashes = 27
  }
}

Custom Configuration Examples

Here are some custom setups you might create:

Healer Configuration

{
  { id = "cat_prebuff", name = "Pre-Raid Buffs", dashes = 22 },
  { id = "cat_consumables", name = "Consumables", dashes = 24 },
  { id = "cat_potions", name = "Potions", dashes = 26 }
}

DPS Warrior Configuration

{
  { id = "cat_flasks", name = "Flasks & Food", dashes = 24 },
  { id = "cat_elixirs", name = "Elixirs", dashes = 27 },
  { id = "cat_combat", name = "Combat Items", dashes = 24 }
}

Rogue Configuration

Poisons with EQUIPPED_WEAPON

{
  itemName = "Instant Poison VI",
  iconPath = "Ability_Poisons",
  requiredCount = 5,
  buffName = "EQUIPPED_WEAPON",
  description = "Coats a weapon with poison that lasts for 30 minutes.",
  category = "cat_combat",
  entryType = "consumable"
}

For rogues, EQUIPPED_WEAPON tracks main hand poison only. If you need to track offhand separately, you’ll need to manually check it (RCC limitation).

Field Combinations

Here are valid field combinations:

Full-Featured Consumable

Everything enabled:

{
  entryType = "consumable",
  itemName = "Flask of Supreme Power",
  displayName = "Supreme Flask",        -- Custom label
  buffName = "Supreme Power",
  itemID = 13512,
  requiredCount = 1,
  iconPath = "INV_Potion_41",
  description = "...",
  category = "category1"
}

Minimal Consumable

Just the essentials:

{
  entryType = "consumable",
  itemName = "Major Healing Potion",
  requiredCount = 10,
  iconPath = "INV_Potion_54",
  category = "category3"
}

Buff with Multiple Variants

Track multiple buff names:

{
  entryType = "buff",
  displayName = "Mage Int",
  buffName = { "Arcane Intellect", "Arcane Brilliance" },
  iconPath = "SPELL_Holy_Magicalsentry",
  description = "...",
  category = "category4"
}

Weapon Enchant

Using EQUIPPED_WEAPON:

{
  entryType = "consumable",
  itemName = "Wizard Oil",
  buffName = "EQUIPPED_WEAPON",
  requiredCount = 4,
  iconPath = "INV_Potion_104",
  category = "category1"
}

Common Patterns

Pattern: Consumable with Buff

Most raid consumables follow this pattern:

Template

{
  itemName = "[Exact Item Name]",
  buffName = "[Exact Buff Name]",
  requiredCount = [number],
  iconPath = "[Icon Name]",
  category = "[category_id]",
  entryType = "consumable"
}

Pattern: Instant Item (No Buff)

Potions and instant-use items:

Template

{
  itemName = "[Exact Item Name]",
  requiredCount = [number],
  iconPath = "[Icon Name]",
  category = "[category_id]",
  entryType = "consumable"
  -- NO buffName field!
}

Pattern: Class Buff

Tracking buffs without items:

Template

{
  displayName = "[Display Label]",
  buffName = "[Buff Name]",  -- or { "Buff1", "Buff2" }
  iconPath = "[Icon Name]",
  category = "[category_id]",
  entryType = "buff"
  -- NO itemName or requiredCount!
}

Testing Your Configuration

After adding items, test them:

Check Icon

✅ Icon appears (not question mark)
❌ Question mark → Fix iconPath

Check Inventory Count

✅ Shows correct count (e.g., “5/10”)
❌ Shows “0/10” when you have items → Fix itemName (case-sensitive)

Check Buff Border

✅ Border changes color when you apply/remove buff
❌ Border stays red → Fix buffName (case-sensitive)
⚫ Border is black → Expected for items without buffs

Check Click-to-Use

✅ Left-click uses the item
❌ Nothing happens → Fix itemName or check if item is in bags

Get Started

User Guide

Configuration

Reference

Support

Default Configuration

Flask Example

Weapon Enchant Example

Raid Food Example

Elixir Example

Instant Potion Examples

Class Buff Examples

Complete Category Set

Custom Configuration Examples

Healer Configuration

DPS Warrior Configuration

Rogue Configuration

Field Combinations

Common Patterns

Pattern: Consumable with Buff

Pattern: Instant Item (No Buff)

Pattern: Class Buff

Testing Your Configuration

Next Steps

Item Configuration

Advanced Customization

Build docs developers (and LLMs) love

Get Started

User Guide

Configuration

Reference

Support

​Default Configuration

​Flask Example

​Weapon Enchant Example

​Raid Food Example

​Elixir Example

​Instant Potion Examples

​Class Buff Examples

​Complete Category Set

​Custom Configuration Examples

​Healer Configuration

​DPS Warrior Configuration

​Rogue Configuration

​Field Combinations

​Common Patterns

​Pattern: Consumable with Buff

​Pattern: Instant Item (No Buff)

​Pattern: Class Buff

​Testing Your Configuration

​Next Steps

Item Configuration

Advanced Customization

Build docs developers (and LLMs) love

Default Configuration

Flask Example

Weapon Enchant Example

Raid Food Example

Elixir Example

Instant Potion Examples

Class Buff Examples

Complete Category Set

Custom Configuration Examples

Healer Configuration

DPS Warrior Configuration

Rogue Configuration

Field Combinations

Common Patterns

Pattern: Consumable with Buff

Pattern: Instant Item (No Buff)

Pattern: Class Buff

Testing Your Configuration

Next Steps