Support

If you like DeZog please consider supporting it.

DeZog - The Z80 Debugger

The goal of this project is to achieve a development environment for Z80 assembler programs much the same as for high-level programming languages. An experience similar to what you would expect from Eclipse, Visual Studio or XCode.

As this is a huge goal the focus is here on

• Easy navigating/stepping through assembler source files with step-over, step-into and step-out
• Data representation by viewing memory area, adding watches conversion between hex, decimal numbers and labels.
• Easy access to data: a lot of information is already available by simply hovering over it.
• Offering a unit test framework.
• Displaying ZX Next specific data like sprites.

DeZog lets you use Visual Studio Code (vscode) as development environment for debugging your Z80 assembler programs. It's primary intention is to support building new programs, i.e. programs with existing assembler source code. (It may also be used without source code to debug binaries but in that case the support is limited and you could probably better directly debug with ZEsarUX or CSpect.) The biggest help it offers is that you are able to step through your sources and that DeZog is aware of all labels and can give hints to what label a number resolves.

DeZog needs a Remote to execute the Z80 binaries. You can either use the built-in Z80/ZX simulator or connect to ZEsarUX or CSpect via a socket connection for more advanced projects.

Note: DeZog itself does not include any support for building from assembler sources. For this you need a build task and an assembler. For an example look here: https://github.com/maziac/z80-sample-program

Migration from DeZog 1.5 If you installed DeZog 1.5 before here are a few tips to migrate to 2.0.

Important note for Windows users: Some people encounter a crash (rainbow/kernel panic) of ZEsarUX at the start of a debug session. If that is true for you as well you can experiment with the "loadDelay" option which adds an additional delay at startup. This mitigates the problem. The default for Windows is 100 (ms). If you run into this problem you can try to increase the value to 400 or even 1000. (You can also try smaller values than 100).

Gallery

Sprites:

• Display of sprites with register indices and position
• Display of all patterns with indices

Execution time:

Unit tests:

Features

• supports ZEsarUX emulator (>= v9.1)
• supports CSpect emulator (>= v2.13.0)
• can be used with the internal simulator (does not require ZEsarUX or CSpect))
• reads .list and .sld files
  • supports stepping through source code
  • either in .list file or in .asm files
• step-over, step-in, step-out, continue, pause
• reverse debugging via step back and reverse continue
• code coverage visualization
• state save/restore
• breakpoints (and breakpoints with conditions)
• display of
  • disassembly
  • Z80 registers
  • stack
  • callstack
  • tbblue sprites and patterns
• changing of Z80 registers from vscode
• labels
  • number-label resolution, i.e. along with numbers also the corresponding label is displayed
• hovering
  • registers: reveals its contents and associated label
  • labels: reveals their value
• watches of labels
• formatting registers
  • customizable formatting for registers, e.g. format as hex and/or decimal and/or label etc.
  • different formatting for registers while hovering
• memory viewer / editor
• automatic display of memory that is pointed to by HL, DE, etc.
• change of program counter through menu
• display of ZXNext sprites and sprite patterns
• supports banking ('long addresses')
• support for Z80 unit tests
• custom extensions to the internal simulator to simulate peripherals.

Constraints

• supports ZEsarUX, CSpect, ZX Next HW and the internal simulator
• build output must
  • create a .list or SLD file (support for sjasmplus, Savannah's z80asm, z88dk).
  • create a .sna, .nex or object file containing the binary

Installation

Prerequisites

In order to use DeZog you need at least vscode (Linux, macOS or Windows).

If you are writing pure Z80 programs or simple ZX Spectrum 48K programs this might already be sufficient as you can use the internal Z80 Simulator.

For more demanding projects you have the choice to install a real emulator.

These are the options:

• the ZEsarUX ZX Spectrum emulator (https://github.com/chernandezba/zesarux). At least version 9.1 is required.
• the CSpect emulator. At least version v2.13.0 is required.

The different DeZog/emulator configurations have different advantages. But which one you choose mainly depends on your personal preference. The table here shows a comparison of the features.

DeZog

In Visual Studio Code simply install "DeZog" (maziac.dezog) from the Marketplace.

There are a few other extensions that are not required to work with DeZog but may help:

• ASM Code Lens:
  • Z80 assembler syntax highlighting
  • completions, references, jump to label, renaming
• Z80 Unit-Tests:
  • an extension to start/debug Z80 unit tests from a graphical UI
• Z80 Instruction Set:
  • shows the opcode, affected flags and a description on hovering over a Z80 instruction
• Hex Hover Converter:
  • converts numbers into their decimal, hexadecimal and binary format on hovering
• ZX SNA File Viewer:
  • A viewer for the ZX Spectrum snapshot (.sna) format (in marketplace search for "snafile")
• ZX NEX File Viewer:
  • A viewer for the ZX Spectrum Next (.nex) file format (in marketplace search for "nexfile")

All can be installed directly inside vscode from the market place.

Usage

Please look at the documentation 'Usage of DeZog'.

You can also access the documentation from within vscode/DeZog. Enter "dezog: Show the DeZog Help page" in the command palette (F1 key) or reveal the "DeZog Help" from the debugging sidebar.

Contribution

If you would like to help extending the DeZog functionality in one of the following areas you are very welcome:

• Add new assembler parsers: The process of writing a parser is described in detail here: AddingNewAssemblers.md Shouldn't be to hard.
• Add a MAME Remote for Z80: I'd like to have done it myself but I'm running out of time. The idea here is to connect to the MAME debugger via a socket. As DeZog is focused very much on Z80 it would make sense only for MAME Z80 targets, of course. See AddingNewRemotes.md. My current understanding in general is:
  • MAME uses lua to communicate with the MAME debugger
  • A socket connection between MAME lua and DeZog is required
  • i.e. on MAME side a lua script is required
  • On DeZog a new Remote is required to communicate with the lua script
• Adding other Remotes (emulators): See AddingNewRemotes.md. S0urceror has done so for OpenMSX, so it is doable.

You can create a pull request so I can add your sources to the official release. Most probably I will first move them to a new feature branch for testing. Please note that all your contributions/sources should be under MIT license.

If you would like to contact me beforehand you can create a new issue in github and we can discuss.

License

DeZog is licensed under the MIT license.

The source code is available on github.

DeZog also includes a Z80/48k ZX Spectrum simulator. For this the original 48/128k ROM code is included and here is the copyright notice: "Amstrad have kindly given their permission for the redistribution of their copyrighted material but retain that copyright". See Amstrad ROM permissions.

Furthermore DeZog includes slightly modified sources of the Z80.js simulator. It was taken from https://bitbucket.org/DrGoldfire/z80.js/src/master/ which is MIT licensed. Many thanks to Molly Howell.

For the "What's New" feature the vscode-whats-new project from Alessandro Fragnani aka alefragni has been incorporated. The project is MIT licensed.

Acknowledgements

I would like to thank a few people for their support

• Cesar Hernandez Bano for developing the great ZEsarUX emulator which very early offered the possibility to remotely connect to it. And for being patient with all my request for the ZRCP protocol. Without ZEsarUX I wouldn't have started DeZog at all. So, if you like DeZog thank Cesar.
• Mike Dailly for the wonderful CSpect emulator, for opening the debug interface to plugins and for giving support to use it properly.
• Molly Howell/DrGoldfire for the Z80 CPU simulation code.
• Kris Borowinski for his tireless efforts testing DeZog.
• Peter Ped Helcmanovsky for his support to get the display of the relative-sprites correct and for the changes he implemented for DeZog in sjasmplus in the SLD format.
• Cesar Wagener Moriana, Dean Belfield and Daren May for writing tutorials.

Tutorials

Please note that the tutorials listed here are normally not updated when a new DeZog version arrives. Especially for changes in the 'launch.json' it might be some properties (names) have changed/removed/added.

Unfortunately there is none for Dezog v2.0 yet. Any contributions are welcome.

CSpect/DeZog

Patricia Curtis

Date: Sep-2020, DeZog 1.4

A great tutorial by Patricia Curtis describing the setup with sjasmplus, CSpect and DeZog.

Daren May

Date: May-2020, DeZog v1.2

An excellent tutorial by Daren May which shows how to setup DeZog with CSpect on Windows. Although it was made for Windows you can easily apply it to macOS or Linux.

Please note: Daren creates an SD card image that is loaded when CSpect is started. For many projects this is not necessary as you can transfer .nex and .sna files directly from DeZog to CSpect.

ZEsarUX/DeZog

L BREAK into program, 0:1

Date: Aug-2020, DeZog 1.4

And here is another shorter tutorial by Dean Belfield (L BREAK into program, 0:1). For this one you don't need to compile ZEsarUX by yourself.

Cesar Wagener Moriana

Date: Dec-2019, DeZog 0.9 (Z80 Debug)

Here is an older (but still great) tutorial from Cesar Wagener Moriana. He documented how he put all things together. It describes how to setup an integrated development environment for ZEsarUX with DeZog. It deals with setting up

• sjasmplus
• ZEsarUX and the
• DeZog

and is available in English, Spain and German here.

Please note: The tutorial is a bit outdated, it uses 'z80-debug'. This was the former name of the project. It has been renamed to 'dezog'. This means especially that in the launch.json files you need to change 'z80-debug' to 'dezog'.

Nevertheless Cesar (W. M.) also shows how to setup the system under Windows and explains a few features of z80-debug/DeZog so that it is a great advice to get you started.