Opened 4 months ago

Closed 5 weeks ago

Last modified 2 weeks ago

#11436 closed enhancement (worksforme)

Officially mention the SCI debug console shortcut of Ctrl-Shift-D

Reported by: lwcorp Owned by: sluicebox
Priority: normal Component: Web
Keywords: debug, debugger Cc:
Game:

Description

https://bugs.scummvm.org/ticket/9294 seems to be the only official "documentation" about how to activate the general SCI debugger.

Can you please mention this shortcut at the top of https://wiki.scummvm.org/index.php/SCI/Debug_Modes as well as the official Readme page/file (which section 5.4 mentions shortcuts of other debuggers)?

Change History (2)

comment:1 by sluicebox, 5 weeks ago

Owner: set to sluicebox
Resolution: worksforme
Status: newclosed

You've confused two different debuggers, which is easy to do. But the readme does have the hotkey and in the 5.4 section you mentioned under AGI/SCI. Maybe it was added recently? There are also already wiki pages about the debugger.

The wiki page you've linked is about Sierra's built-in debuggers, which games include them, and how to activate them. It's fun trivia, and it's sometimes helpful to developers, but it's not about ScummVM. They happen to work in ScummVM because they're part of the games.

The ScummVM debugger on the other hand is part of ScummVM and available to all SCI games and any other games where the engine authors have implemented commands. It is documented:
https://wiki.scummvm.org/index.php/Debugging_ScummVM
https://wiki.scummvm.org/index.php?title=SCI/FreeSCI/Debugger/Debugger_commands

A recent development: the debug hotkey is now configurable and it's the fourth hotkey (at least, for me) in the list under Options.

Version 1, edited 5 weeks ago by sluicebox (previous) (next) (diff)

in reply to:  1 comment:2 by lwcorp, 2 weeks ago

You've confused two different debuggers, which is easy to do.

Actually, I realize it's two different debuggers yet both deal with AGI/SCI. I don't think there's any downside to writing just 1 line at the the top of https://wiki.scummvm.org/index.php/SCI/Debug_Modes mentioning ScummVM also has its own debugger for AGI/SCI.

But the readme does have the hotkey and in the 5.4 section you mentioned under AGI/SCI. Maybe it was added recently?

Actually, I managed to find it was added back in January...and yet the latest binary, which was released 11 days later, doesn't have it. Neither does the latest stable build have it. Only the latest development build has it. Why should January's changes not appear in a version that was released later? Well, I guess they unfortunately already prepared a different branch by this point.

The ScummVM debugger on the other hand is part of ScummVM and available to all SCI games and any other games where the engine authors have implemented commands.

True, but as can be seen in January's code change above, this specific shortcut is only available for AGI/SCI games.

Last edited 2 weeks ago by lwcorp (previous) (diff)
Note: See TracTickets for help on using tickets.