Krowi's Util

A comprehensive modular utility library for World of Warcraft addon development, built on the KROWI_LIBMAN architecture. Provides reusable modules for string manipulation, table operations, color management, metadata handling, localization, and more.

Features

LibMan Architecture

• Modular Design: Clean submodule system for better code organization
• Dependency Management: Automatic version tracking and compatibility checks
• Shared Library Support: Seamless integration with other Krowi libraries

Core Utilities Module

• Version Detection: Automatic detection of WoW version (Mainline, Midnight, Classic variants)
• Table Operations: Merge, copy, search, and manipulate tables
• Nested Key Operations: Safe access to deeply nested table values
• Delayed Execution: Timer-based function delays
• Type Checking: Complete set of type validation functions

String Utilities Module

• Variable Replacement: Template-based string formatting with {varName} syntax
• UI Helpers: Reload requirement and default value text generation
• String Extensions: Methods added directly to the string type with K_ prefix

Color Management Module

• Color Utilities: Apply and remove color codes from text
• RGB/Hex Conversion: Convert between RGB percentages and hex values
• Predefined Colors: Quest difficulty colors (Green, Grey, Red, Orange, Yellow)
• Item Quality Colors: Poor, Common, Uncommon, Rare, Epic
• Dynamic String Methods: Auto-generated SetColor* methods for convenient styling

Metadata Management Module

• Addon Information Extraction: Parse TOC file metadata with caching
• Link Generation: Automatic CurseForge and Wago link formatting
• Build Version Tracking: Combined build and version information

Localization Helper Module

• Simplified Setup: Easy initialization with InitLocalization
• Automatic Detection: Smart locale detection and fallback handling
• AceLocale Integration: Built on top of AceLocale-3.0 with improved API
• Multi-Language Support: English, German, French, Chinese (Simplified)

Credits System Module

• Contributor Recognition: Formatted lists for special thanks, donations, and localizations
• Class Coloring: Automatic character class color formatting

Additional Features

• Minimap Icon Support (Icon.lua): LibDBIcon integration with tooltip and click handling
• Options Framework (Options/): Profile management and AceConfig integration
• Complete Localization: Comprehensive translations for all supported languages

Usage Examples

Basic Setup (2.0)

-- Access via LibMan
local util = KROWI_LIBMAN:GetLibrary('Krowi_Util_2')

-- Or access submodules directly
local strings = KROWI_LIBMAN:GetLibrary('Krowi_Util_2'):GetSubmodule('Strings')

-- Or via parent
local util = KROWI_LIBMAN:GetLibrary('Krowi_Util_2')
local strings = util.Strings

Legacy LibStub Support (1.x)

-- Still supported for backward compatibility
local util = LibStub("Krowi_Util_2")

String Variable Replacement

-- Using module method
local text = util.Strings.ReplaceVars("Hello {name}, you have {count} items", {
    name = "Player",
    count = 5
})
-- Result: "Hello Player, you have 5 items"

-- Using string extension
local text = ("Hello {name}"):K_ReplaceVars({name = "World"})
-- Result: "Hello World"

Localization Setup (New in 2.0)

-- Initialize localization for your addon
util.LocalizationHelper.InitLocalization(MyAddon, "MyAddonName")

-- Create default locale (enUS)
local L = MyAddon.Localization.NewDefaultLocale()
L["Hello"] = "Hello"
L["Goodbye"] = "Goodbye"

-- Create other locales
local L = MyAddon.Localization.NewLocale('deDE')
if L then
    L["Hello"] = "Hallo"
    L["Goodbye"] = "Auf Wiedersehen"
end

-- Use localized strings
local greeting = MyAddon.Localization.GetLocale()["Hello"]

Color Management

local colors = util.Colors
local coloredText = colors.SetTextColor("Warning!", colors.Red)

-- Or use string method:
local epicText = ("Legendary Item"):SetColorEpic()
local greenText = ("Completed"):SetColorGreen()

Table Operations

-- Safe nested access
local data = {player = {stats = {health = 100}}}
local health = util.SafeGet(data, {"player", "stats", "health"}) -- Returns 100
local missing = util.SafeGet(data, {"player", "items", "sword"}) -- Returns nil safely

-- Deep copy
local original = {a = 1, b = {c = 2}}
local copy = {}
util.DeepCopyTable(original, copy)

-- Delayed function execution
util.DelayFunction("myDelay", 2, function(msg) print(msg) end, "Hello after 2 seconds")

Version Detection

if util.IsMainline then
    -- Retail-specific code (The War Within, Midnight)
elseif util.IsMistsClassic then
    -- Mists Classic-specific code
end

Metadata Extraction (Enhanced in 2.0)

local metadata = util.Metadata.GetAddOnMetadata("YourAddon")
print(metadata.Title, metadata.Version, metadata.Author)
print(metadata.CurseForge, metadata.Wago) -- Auto-formatted links
print(metadata.BuildVersion) -- Combined build and version

API Reference

Core Utility Functions

Type Checking Functions

String Utility Functions (Enhanced in 2.0)

Localization Helper Functions (New in 2.0)

Color Functions

Available Color Constants

Quest Difficulty Colors:

• AddonBlue, Green, LightGreen, Grey, LightGrey, Red, LightRed, Orange, LightOrange, Yellow, White

Item Quality Colors:

• Poor, Common, Uncommon, Rare, Epic

Each color is available as both RGB table (*RGB) and formatted string.

String Color Methods

All colors automatically extend the string type:

("text"):SetColorRed()
("text"):SetColorEpic()
("text"):SetColorGreen()
-- etc. for all color constants

Metadata Functions (Enhanced in 2.0)

Returned Metadata Fields:

• AddonName, Title, Prefix, Acronym
• Build, Version, BuildVersion (combined build + version)
• Author, Icon
• CurseForge (auto-formatted link), Wago (auto-formatted link)

Credits Functions

Version Detection Properties

Use Cases

• Modular Addon Development: Build addons using clean, reusable modules
• Dynamic Text Generation: Create tooltips, messages, and UI elements with template strings
• Safe Data Access: Navigate nested tables without nil reference errors
• Consistent Styling: Apply WoW-standard quest and item quality colors
• Multi-Version Support: Implement version-specific features across all WoW versions
• Localization: Easy setup and management of multi-language support
• Metadata Management: Centralized addon information with automatic link generation
• Profile Configuration: Built-in profile management and options framework

Requirements

• KROWI_LIBMAN (included)
• LibStub (included)
• AceLocale-3.0 (included)
• CallbackHandler-1.0 (included)
• AceConfig-3.0 (for options)
• AceConfigDialog-3.0 (for options UI)
• AceDB-3.0 (for options database)
• AceDBOptions-3.0 (for profile options)
• LibDBIcon-1.0 (for minimap icon)
• LibDataBroker-1.1 (included, for minimap icon)