wow-api-settings-system
WoW Settings System (CVars and Console)
Use this skill when you need to explain or work with console variables (CVars) and console commands in WoW Retail.
What CVars Are
- CVars are client configuration values that affect graphics, sound, UI, and gameplay behavior.
- Many settings in the in-game Interface options map directly to CVars.
- The authoritative, up-to-date list is on the wiki. Use it instead of copying large lists.
Reference: https://warcraft.wiki.gg/wiki/Console_variables
Reading and Setting CVars
API (AddOns or scripts)
- Read:
GetCVar(name)returns a string value. - Read default:
GetCVarDefault(name)returns the coded default value. - Inspect:
GetCVarInfo(name)can indicate if a CVar is secure. - Write:
SetCVar(name, value)sets a value as a string.
Example:
-- Enable UI error popups
SetCVar("scriptErrors", 1)
/console Command
- Use
/console <name> <value>in chat. - Example:
/console scriptErrors 1
Console Window
- Enable with
/console enableor start the client with-console. - Open the console window with the ` or ~ key.
Secure CVars and Combat Restrictions
- Secure CVars cannot be changed in combat.
- Secure CVars must be changed via
SetCVar(not/console). - Use
GetCVarInfoto determine if a CVar is secure before changing it.
CVar Scope (Account vs Character)
- Some CVars are account-wide, others are character-specific.
- Character or account specific values may sync to the server (when
synchronizeConfigis enabled). - Changing a character specific CVar only affects the current character.
Resetting CVars
- Reset one CVar to default:
SetCVar("autoSelfCast", GetCVarDefault("autoSelfCast"))
- Console reset:
/console cvar_default autoSelfCast
- Full reset:
/console cvar_default
Note: Account or character specific CVars that are synced may persist even after reinstalling or deleting the WTF folder.
Config Files (When the Game Is Not Running)
WTF/Config.wtfstores startup and global settings.WTF/Account/<AccountName>/config-cache.wtfand per-characterconfig-cache.wtfstore account or character scoped values.- Only edit these files while the game is closed or changes will be overwritten.
Discovering CVars and Console Commands
- The wiki list is the most complete, searchable source.
- The console command list is also on the same page.
- Some console APIs expose command lists (see the API docs for
C_Console).
Reference: https://warcraft.wiki.gg/wiki/Console_variables
Additional Notes
See references/CVARS-OVERVIEW.md for a short, curated set of workflow tips, pitfalls, and reset guidance.
When to Use This Skill
- You need to explain how to set or read CVars from an addon or script.
- You need to clarify CVar scope, secure restrictions, or reset behavior.
- You need guidance on console command usage or config file locations.
More from jburlison/wowaddonapiagents
wow-addon-structure
Verbose guide for WoW Retail AddOn structure, .toc metadata, loading order, SavedVariables, and C_AddOns metadata and load APIs. Use when planning addon folder layout, file order, or SavedVariables wiring.
23wow-api-encounters
Complete reference for WoW Retail Encounter Journal, Mythic+/Challenge Mode, Instance, Scenario, Raid Lock, and Season APIs. Covers EncounterJournal (dungeon/raid boss database, loot tables, section navigation), C_ChallengeMode (M+ keystones, affixes, timers, best times), C_MythicPlus (weekly runs, seasonal data, rating), ScenarioInfo (delves/scenarios objectives and stages), InstanceLeaverInfo (deserter), RaidLocks (saved instances), C_SeasonInfo (seasonal info), and related events. Use when working with dungeon/raid encounter data, M+ keystones, mythic plus scores, scenario stages, raid lockouts, or seasonal content.
11wow-api-reputation
Complete reference for WoW Retail Reputation, Faction, Major Factions, Paragon, and Neighborhood Initiative APIs. Covers C_Reputation (faction info, standings, watched faction, headers, friendship reps, paragon), C_MajorFactions (Dragonflight+ renown factions, renown levels, rewards), C_NeighborhoodInitiative (12.0.0 housing neighborhood reputation), faction expansion data, and reputation-related events. Use when working with reputation tracking, faction standings, renown systems, paragon rewards, friendship reputations, or neighborhood initiatives.
11wow-api-social-chat
Complete reference for WoW Retail Chat, Social, Club/Community, Friend List, Voice Chat, BattleNet, Ping, Social Queue, and Addon Messaging APIs. Covers C_ChatInfo, C_Club, C_ClubFinder, C_FriendList, C_BattleNet, C_VoiceChat, C_SocialRestrictions, C_SocialQueue, C_RecentAllies, C_PingManager, C_TTSSettings, ChatFrame functions, chat filters, addon message system, and 12.0.0 instance restrictions (SendAddonMessage blocked, chat messages may be secret). Use when working with chat output, chat channels, communities, friend lists, voice chat, BattleNet friends, addon communication, social features, or ping system.
9wow-api-housing
Complete reference for WoW Retail Player Housing APIs (new in Patch 12.0.0). Covers HousingUI (core housing system), C_HouseEditorUI (placement/editing modes), C_HousingCatalog (decoration catalog), HousingBasicModeUI, HousingCleanupModeUI, HousingCustomizeModeUI, HousingDecorUI, HousingExpertModeUI, C_HouseExteriorUI (exterior customization), HousingLayoutUI, C_HousingNeighborhood (neighborhoods/visiting), C_NeighborhoodInitiative (community goals), and CatalogShop. Use when working with player housing placement, decoration, editing modes, neighborhoods, housing catalogs, exterior customization, or neighborhood initiatives.
7wow-api-escape-sequences
Complete reference for World of Warcraft UI escape sequences — pipe-character sequences embedded in text strings to produce colors, inline textures, atlas icons, grammar inflections, word-wrap hints, Kstrings, and other special rendering. Use when formatting chat output, tooltip text, FontString content, or any UI text that needs color codes, inline icons, named colors, item-quality colors, texture markup, atlas markup, localized grammar forms, or escape-sequence utilities like WrapTextInColorCode, CreateTextureMarkup, CreateSimpleTextureMarkup, and CreateAtlasMarkup.
7