Script Debugger

[covert_caedes]

Doom3 GPL contained most of the source of the script debugger that used to be part of Quake4.
Harrie van Ginneken fixed it for dhewm3 by implementing the missing parts and we further improved it together (I maintain dhewm3).

I ported that to TDM.

It allows you to set breakpoints in script functions (by clicking to the left of the line number, where that red dot appears then), so when those lines are executed the game is paused and you can inspect variables in the debugger, or continue running the script line-wise (with those little buttons with the arrows at the top, or F11/F10/Shift-F11, see also the "Debug" menu.

To continue running the game (until it hits the next breakpoint), click that ▶︎ button at the top.

You can download a testbuild and read some more information at https://github.com/stgatilov/darkmod_src/pull/6 - it should work with the latest 2.14 Beta gamedata.

 

Note that this is currently not officially part of The Dark Mod and I don't know when (or if) it will be merged. Might be after 2.14 if the changes are considered too risky or too much to review or whatever. 

[datiswous]

Just tested this on a Windows pc. Will check later on Linux.

Tdm has to be set in Window mode, otherwise the mouse will not be visible inside the debugger. So I guess for testing purposes maybe tdm can be started in windowed mode, without saving the configuration. Can you set this in a shortcut?

Edit: Adding this to the shortcut to the debugger starts it in windowed mode, but leaves the tdm-setting alone:

+set r_fullscreen 0

(if you set this to normal tdm startup it will set and save the setting to windowed mode)

So it becomes:

"path-of-tdm-install"\TheDarkModx64.exe +debugger +set r_fullscreen 0

When you start tdm in debug mode directly via shotcut (+debugger) it will state it is disconnected. When you click on the "Run" button, tdm starts and it connects. When you would start tdm seperate (via TheDarkModx64.exe), it will keep being disconnected, until you go to the console and type

com_enableDebuggerServer 1

(or you can set it through the sortcut via +set com_enableDebuggerServer 1), then the debugger connects automatically.

Edited February 11 by datiswous

[datiswous]

Quote

Maybe (on Linux) you could even run TheDarkModx64.exe +debugger in Wine and the native darkmod (on the same machine) with +set com_enableDebuggerServer 1 and they may find each other. Likely you need to start the native one with the server first, if anyone tries please let me know

com_enableDebuggerServer 1

Does not work with the current Linux version of TDM because you did not supply a modified thedarkmod.x64.

Can you also supply a thedarkmod.x64 that supports the server config?

 

Currently it only works through wine.

 

I did not test any functionality though. Purely if it starts and makes a successful connection.

[covert_caedes]

I thought the Linux users build it themselves

But I forgot that building TDM isn't as straightforward as building dhewm3 due to the dependencies..

Anyway, updated the Github post with a Link to a Linux build, created on (X)Ubuntu 24.04, hope it will work on your system as well

[datiswous]

2 hours ago, covert_caedes said:

Anyway, updated the Github post with a Link to a Linux build, created on (X)Ubuntu 24.04, hope it will work on your system as well

Yeah works. At least the Linux based tdm connected to the wine based client. I mean I don't know much about scripting, so I don't know how to test anything. 

What is also cool is that there's a build-in console in it which is basically the tdm console, so you can give it all the commands that you usually give inside the console in tdm.

Edited February 11 by datiswous