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
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. There is also experimental support for MAME.
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).
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 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.
If you own a ZX Next you also have the option to debug your SW directly on the Next.
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:
All can be installed directly inside vscode from the market place.
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.
If you would like to help extending the DeZog functionality in one of the following areas you are very welcome:
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.
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.
I would like to thank a few people for their support
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 happen that some properties (names) have changed/removed/added.
Unfortunately all tutorials are a little bit outdated, i.e. there is none for Dezog v2.x yet only for the former 1.x versions. Any contributions are very welcome.
I listed the tutorials here by date.
Date: Sep-2020, DeZog 1.4, CSpect
Retro Coder TV
Date: Sep-2020, DeZog 1.4, Internal Z80 Simulator, ZEsarUX, CSpect
L BREAK into program, 0:1
Date: Aug-2020, DeZog 1.4 (with a few updates for 2.0), ZEsarUX
And here is another shorter tutorial by Dean Belfield (L BREAK into program, 0:1).
Date: May-2020, DeZog v1.2, CSpect
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.
Cesar Wagener Moriana
Date: Dec-2019, DeZog 0.9 (Z80 Debug), ZEsarUX
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
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.