Skip to main content

SkoolKit

SkoolKit is a collection of utilities that can be used to disassemble a Spectrum game (or indeed any piece of Spectrum software written in machine code) into a format known as a skool file. Then, from this skool file, you can use SkoolKit to create a browsable disassembly in HTML format, or a re-assemblable disassembly in ASM format. So the skool file is - from start to finish as you develop it by organising and annotating the code - the common ‘source’ for both the reader-friendly HTML version of the disassembly, and the developer- and assembler-friendly ASM version of the disassembly.

Features

Besides disassembling a Spectrum game into a list of Z80 instructions, SkoolKit can also:

  • Build PNG or GIF images from graphic data in the game snapshot (using the #UDG, #UDGARRAY, #FONT and #SCR macros)

  • Create hyperlinks between routines and data blocks that refer to each other (by use of the #R macro in annotations, and automatically in the operands of CALL and JP instructions)

  • Neatly render lists of bugs, trivia and POKEs on separate pages (using [Bug], [Fact] and [Poke] sections in a ref file)

  • Produce ASM files that include bugfixes declared in the skool file (with @ofix, @bfix and other ASM directives)

  • Produce TAP files from assembled code (using bin2tap.py)

For a demonstration of SkoolKit’s capabilities, take a look at the complete disassemblies of Skool Daze, Back to Skool and Contact Sam Cruise.

Quick start guide

SkoolKit includes fairly detailed documentation, but if you want to get up and running quickly, here goes.

To convert a SNA, Z80 or SZX snapshot of a Spectrum game into a skool file (so that it can be converted into an HTML or ASM disassembly):

$ sna2skool.py game.z80 > game.skool

To split the disassembly up into code and data blocks, you’ll need a control file.

To turn this skool file into an HTML disassembly:

$ skool2html.py game.skool

To turn it into an ASM file that can be fed to an assembler:

$ skool2asm.py game.skool > game.asm

Metadata

Release files for skoolkit 3.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for skoolkit 3.6
File Size Uploaded Provenance Actions
skoolkit-3.6.tar.gz 505.7 kB Without provenance Details for skoolkit-3.6.tar.gz

Release files / skoolkit-3.6.tar.gz

Download URL skoolkit-3.6.tar.gz
Size 505.7 kB
Tags Source
SHA-256 checksum
How to use checksums
333f86cd55e1de73b72cc33fa88f92e2289be0eecb8568755fd71bc538d6bafb
BLAKE2b-256 checksum
How to use checksums
35e343edca268e208cc1f314517df7e2545f1c807bdd079e8e5ce0cbb1e21dd9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for skoolkit 3.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.6 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page