Difference between revisions of "Debug filter.cfg"
(Overhaul of this page, adding a lot more information and providing a structure to add more about the use of each debug filter argument.) |
(Added a couple missing debug filters.) |
||
Line 54: | Line 54: | ||
Debugs the CD volume to the log. | Debugs the CD volume to the log. | ||
+ | |||
+ | ===+CFileDebug=== | ||
+ | |||
+ | Outputs the full path where a requested file was found in cfile.cpp. | ||
===+collision=== | ===+collision=== | ||
Line 190: | Line 194: | ||
Engine wash output. | Engine wash output. | ||
+ | |||
+ | ===+Weapons=== | ||
+ | |||
+ | Debugs when a weapon is not being loaded in weapons.cpp. | ||
== Sample Complete debug_filter.cfg == | == Sample Complete debug_filter.cfg == | ||
Line 206: | Line 214: | ||
+BmpMan | +BmpMan | ||
+CD | +CD | ||
+ | +CFileDebug | ||
+Collision | +Collision | ||
+Error | +Error | ||
Line 239: | Line 248: | ||
+Warning | +Warning | ||
+Wash | +Wash | ||
+ | +Weapons | ||
</pre> | </pre> |
Revision as of 17:57, 25 July 2016
Revision information.....
- FSO Revision: GIT
Contents
- 1 Overview
- 2 Available Options
- 2.1 +AB TRAIL
- 2.2 +AI
- 2.3 +Alan
- 2.4 +allender
- 2.5 +Andsager
- 2.6 +BEAM
- 2.7 +BMP DEBUG
- 2.8 +BmpFastLoad
- 2.9 +BmpInfo
- 2.10 +BmpMan
- 2.11 +CD
- 2.12 +CFileDebug
- 2.13 +collision
- 2.14 +Error
- 2.15 +EVENTMUSIC
- 2.16 +Fred routing
- 2.17 +General
- 2.18 +Jim
- 2.19 +Joystick
- 2.20 +lethality
- 2.21 +lightning
- 2.22 +Maps
- 2.23 +messaging
- 2.24 +Mike
- 2.25 +missionlog
- 2.26 +MK
- 2.27 +Model
- 2.28 +ModelAnim
- 2.29 +MOVIE
- 2.30 +MVE
- 2.31 +Network
- 2.32 +OGGISH
- 2.33 +OpenAL
- 2.34 +OpenGL
- 2.35 +Paging
- 2.36 +parse
- 2.37 +Particles
- 2.38 +Physics
- 2.39 +Registry
- 2.40 +Sandeep
- 2.41 +SEXP
- 2.42 +SHADER-DEBUG
- 2.43 +Sound
- 2.44 +UI
- 2.45 +Warning
- 2.46 +wash
- 2.47 +Weapons
- 3 Sample Complete debug_filter.cfg
Overview
The following list is the possible options for putting into a debug_filter.cfg which should be located in your FreeSpace2 Data directory (Freespace2/data for 3.7.4 or earlier on Windows, %APPDATA%\HardLightProductions\Freespace2\data for everywhere else).
A '+' means that the item listed will have output generated to the fs2_open.log or Fred2_open.log. A '-' means to disregard those items and not print output from them.
Strings are not case-sensitive as they are checked with stricmp().
Available Options
+AB TRAIL
Debugs the creation of afterburner points on a given ship name.
+AI
Outputs a lot of information related to the AI code.
+Alan
Lots of information across various files including pre-mission screens, AI, and audio code.
+allender
Debugs for campaign advancement issues, arrival anchors, and some object cleanup code.
+Andsager
Currently unused in the code base.
+BEAM
Identifies bad shot_index values for type D beams, beams powering down for FOV reasons, and recycled beams.
+BMP DEBUG
Outputs data related to BMPMAN loads and locks, and memory usage.
+BmpFastLoad
Outputs when it found a bitmap.
+BmpInfo
Outputs when BMPMAN is loading all used bitmaps and when it completes.
+BmpMan
The rest of the BMPMAN specific debugging information.
+CD
Debugs the CD volume to the log.
+CFileDebug
Outputs the full path where a requested file was found in cfile.cpp.
+collision
Identifies when the game has run out of object pairs, potentially leading to failed collisions. See objcollide.cpp.
+Error
Error-level issues printed to the log by default. Can be disabled using debug_filter.cfg.
+EVENTMUSIC
Debugs music switching events in eventmusic.cpp.
+Fred routing
Debugs various dialog flows in FRED2.
+General
General-level issues printed to the log by default. Can be disabled using debug_filter.cfg.
+Jim
Debugs the frame a weapon is set to detonate in collideshipweapon.cpp.
+Joystick
Debugging related to joysticks.
+lethality
Debugs the player's lethality and the number of turrets targeting a player.
+lightning
Debugs when bolts are released and when out of lightning nodes.
+Maps
Identifies when an animation could not be found for a given dbg_name in modelinterp.cpp.
+messaging
Debugs things related to the player messages in missionmessage.cpp.
+Mike
Debugs laser and missile counts in a frame.
+missionlog
Debug various things in missionlog.cpp.
+MK
Currently unused in the code base.
+Model
Reports issues with models found in the modelread.cpp code.
+ModelAnim
Debugs info about model animations and when they are played.
+MOVIE
Writes log entries when memory allocation for movies fails for various reasons.
+MVE
Debugs a couple of things in the decoder16.cpp file.
+Network
Lots of debugging related to the networking code.
+OGGISH
Identifies an ogg error occurred in audiostr.cpp.
+OpenAL
Currently debugs detected capture and playback devices.
+OpenGL
Logs some OpenGL errors found in gropengl.cpp.
+Paging
Debugs when and for what ships during a mission assets are paged in.
+parse
This one can get noisy, outputs lots of debugging info related to parsing files and weapons.
+Particles
Outputs the Num_particles high water mark in particle.cpp.
+Physics
Numerous log entries related to the physics and collision detection code.
+Registry
Debugs things read from the registry (should be gone after 3.7.4).
+Sandeep
Debugs when a joystick effect is played in shiphit.cpp.
+SEXP
Some error-logging throughout the sexp.cpp codebase.
+SHADER-DEBUG
Additional warning logging for the shader compilation.
+Sound
Additional sound related warning logging throughout the codebase.
+UI
A warning about bad bitmap mask switching and info about the current UI state.
+Warning
Warning-level issues printed to the log by default. Can be disabled using debug_filter.cfg.
+wash
Engine wash output.
+Weapons
Debugs when a weapon is not being loaded in weapons.cpp.
Sample Complete debug_filter.cfg
I cannot recommend using this as-is as it will lead to a very noisy log, that will often be too large to distribute easily during troubleshooting. Disabling parsing errors alone helps immensely with that however.
+AB TRAIL +AI +Alan +Allender +Beam +BMP DEBUG +BmpFastLoad +BmpInfo +BmpMan +CD +CFileDebug +Collision +Error +EVENTMUSIC +Fred routing +General +Jim +JOYSTICK +Lethality +Lightning +Maps +Messaging +Mike +MissionLog +Model +ModelAnim +MOVIE +MVE +Network +OGGISH +OpenAL +OpenGL +Paging +Parse +Particles +Physics +Registry +Sandeep +SEXP +SHADER-DEBUG +Sound +UI +Warning +Wash +Weapons