WTF

From WoWDev

Revision as of 17:40, 27 July 2007 by Schlumpf (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This is the file format used in all of World of Warcraft's console scripting. If you run World of Warcraft with console mode enabled (using the "-console" command line parameter), using the console (press tilda or ~ to bring it up) you are able to create and run .wtf files. Upon running World of Warcraft, two .wtf files are executed, these are "realmlist.wtf", in your World of Warcraft directory, and also "Config.wtf", located in your WTF directory. The commands in these files are executed as if run by the RUN command in the console. Here is a list of the console commands available in World of Warcraft. Note that this list is incomplete, as certain commands are/were only available in certain versions of the game (example: the ShowWater command no longer works past World of Warcraft Beta 2) and that certain commands are not available to common users of the game, and only to game administraters or game masters (example : the WorldPort command no longer works for non-GMs). These GM-only files are not displayed in this list (nor can they be viewed without some command to view them, or a list of GM-commands):

   # Help commands
         o help - displays the help catagory menu
         o help debug - displays the debug commands help menu
         o help graphics - displays the graphics commands help menu
         o help console - displays the console commands help menu
         o help combat - displays the combat commands help menu
         o help game - displays the game commands help menu
         o help default - displays the default commands help menu
         o help net - displays the network commands help menu
         o help sound - displays the sound commands help menu 
   # Console commands
         o default - resets all the font and console settings
         o quit - exits World of Warcraft
         o ver - displays the current client version number
         o set - sets the value of a CVar (example: set gxColorBits 16)
         o cvar_reset - resets the value of a CVar to it's startup default (example: cvar_reset horizonfarclip)
         o cvar_default - resets the value of a CVar to it's default value (example: cvar_default horizonfarclip)
         o cvarlist - displays a list of all the CVars in use (syntax: cvarlist List cvars) 
   # Debugging commands
         o mem - writes a memory dump to your hard drive and also displays on screen how much of your total memory you are currently using
         o ErrorFileLog - it's a CVar - initally set to 0, I believe it logs all encountered errors to a file
         o Bug - submits a bug to the developers (syntax: Bug bug_message)
         o Suggestion - submits a suggestion to the developers (syntax: Suggestion sugg_string)
         o Note - submits a note to the developers (syntax: Note note_text)
         o FontPerf - I'm unsure what this one does - when used, it Alphas out all my console text and places colored bars below my screen
         o Errors - it's a CVar - initial value is 0 - unsure of use
         o ShowErrors - another CVar - initial value is 1 - it probably allows errors to be written to the errors logfile and/or to the screen when they occour
         o ErrorLevelMin - CVar - initially 1 - no idea
         o ErrorLevelMax - CVar - initially 3 - also no idea
         o ErrorFilter - CVar - initially set to "all" - probably shows "all" errors as they occour
         o showGUIDs - cvar - toggles debug GUID tooltips on and off with 0 and 1
         o enumTextures - dumps all the texturenames, filesizes, and other data to a file
         o enumTextureGxCache - it's the same as enumTextures, except it dumps the graphics cache instead of your system's memory 
   # Graphics Commands:
         o widescreen - displays the game screen in widescreen, rather than fullscreen mode
         o gxApi - sets the Graphics API between DirectX (Direct3d) and OpenGL
         o gxVSync - sets Vertical Sync on or off (meant to reduce screen tearing due to one buffer finishing its load before another)
         o gxWindow
         o gxCursor
         o gxMultisample - sets the number of screen multisampling that is calculated
         o gxOverride
         o gxRestart - this is a function commonly used to reload a UI - it basically logs you off, then back on without you having to reselct your character
         o doodadAnim - turns ADT(doodad) Model animations on or off
         o mapShadows
         o MaxLights - sets the maximum number of lighting effects calculated per frame (lower = less lag, higher = better lighting quality)
         o texLodBias - sets the Texutre Level of Detail bias
         o mapObjOverbright
         o mapObjLightLOD
         o waterLOD - sets the level of detail in water and water effects
         o baseMip - changes the base mip-mapping level on textures (0 = highest quality, higher numbers = lower quality, but faster texture processing)
         o textureLodDist - changes how the level of detail of textures decreases as they get farther away from the camera
         o horizonfarclip - sets the Far Clipping Plane of the horizon (this is the maximum you can ever see in WoW)
         o showfootprints - enables or disables leaving footprints in the ground
         o bspcache
         o triangleStrips - enables or disables stripifying of triangle chunks (I think)
         o footstepBias
         o occlusion
         o M2UseZFill
         o showCull
         o setShadow - i believe this sets the level of detail in shadowing effects
         o waterMaxLOD - changes the maximum level of detail in water and water effects
         o waterWaves - enables or disables water waves
         o waterSpecular - enables or disables water specular mapping (shinyness)
         o waterRipples - enables or disables water rippling
         o waterParticulates
         o showShadow - turns your character's shadow on and off
         o showLowDetail
         o showSimpleDoodads
         o detailDoodadAlpha - sets the doodad alpha edge-ing (0 -> 255) 
   # Console commands
         o run - the console runs a .wtf file of the name you specify (example: run MYWTF.wtf)
         o fontcolor, bgcolor, highlightcolor, fontsize, font, consolelines, clear, proportionaltext, spacing, settings, default, closeconsole, repeat 
   # Combat commands
         o NONE
         o This menu was used before World of Warcraft went to Open Beta. You used to be able to modify your maximum attack range, and toggle your collision sphere visibility and stuff. 
   # Game commands
         o HeapUsage - changes the amount of memory that an addon or UI can use
         o checkAddonVersion - checks the version of a World of Warcraft UI or addon - this is done in the Addons menu of the character selection screen 
   # Network commands
         o realmAddress - this command changes (or displays, depending on if you provide parameters or not) the realm server network address
         o realmList - this command changes or displays the realm list server that connects the game client to all the other servers 
   # Sounds commands
         o SoundBufferSize - sets the sound buffer size (in MB, I think)
         o SoundOutputSystem
         o SoundDriver
         o SoundMixer
         o SoundMinHardwareChannels - sets the minimum number of audio hardware output channels
         o SoundMaxHardwareChannels - sets the maximum number of audio hardware output channels
         o SoundMixRate - I *think* that this is the audio sampling rate
         o SoundInitFlags
         o SoundMemoryCache
         o SoundRolloffFactor
         o MasterSoundEffects - I think that this sets the master volume of WoW for all sound effects
         o EmoteSounds - allows sounds to be played when a character does an emote (or, if disabled, disallowes the prior)
         o SoundReverb - sets the sound reverberation value (i'm not an audio guy - so I've virtually no idea how changing this affects the sound)
Personal tools