User Tools

Site Tools


debugging:debugconfig

Debug Config

The 'Debug Config' system is a method for getting extra information from the game client or server to help find and resolve problems with the game or script.

To activate debug config on the client

Create a file called debugconfig.txt in the same location as TheUniversal.exe. Inside the .txt file you add lines of the form [LogName]=[mode], each on a new line.

e.g
LogTest=2

The name on the left indicates the config system to be activated. The mode determines how it is used.

Mode 0 = Debug off
Mode 1 (and above) = Print to the system debug output stream
Mode 2 = Print to a file called 'DevLog.txt'
Mode 3 = Print to the game chat window

To see the output for log mode 1 you will need to access the debug output stream.. if you have Visual Studio or other IDE and can attach it to the game process, the logged text should appear in the output debug channel).

Activating mode 2 can affect game performance so its probably not wise to leave that set all the time.

As well as LogTest, there are a few different logging categories which may be useful..

LogScriptTrace
LogLogin
LogCurlVerbose
LogDownloadableAssets
LogVehicleAssets

so, if your client's debugconfig.txt included

LogTest=1
LogScriptTrace=2

.. you would get LogTest messages output to the debug console and ScriptTrace message written to the DevLog.txt file. (See Debugging Scripts for more info on the ScripTrace functionality).

DebugConfig on server

You can also add DebugConfig.txt to the server and get logging info from that too. Put the DebugConfig.txt in the root of the folder your world is running from. (Alongside ServerConfig.txt)

In both cases, note that the DebugConfig.txt is only loaded on boot, so if you change the config settings you will need to restart your client or server to get the new configuration.

debugging/debugconfig.txt · Last modified: 2023/04/24 03:54 by mit

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki