bin2tap.py converts a binary file produced by an assembler (see Supported assemblers) into a TAP file that can be loaded into an emulator. For example:
$ bin2tap.py game.bin
will create a file called game.tap. By default, the origin address (the address of the first byte of code or data) and the start address (the first byte of code to run) are set to 65536 minus the length of game.bin. These defaults can be changed by passing options to bin2tap.py. Run it with no arguments to see the list of available options:
Usage: bin2tap.py [options] FILE.bin
Convert a binary snapshot file into a TAP file.
Options:
-o ORG Set the origin (default: 65536 - length of FILE.bin)
-s START Set the start address to JP to (default: ORG)
-t TAPFILE Set the TAP filename (default: FILE.tap)
skool2asm.py converts a skool file into an ASM file that can be fed to an assembler (see Supported assemblers). For example, to create an ASM file for Skool Daze, open a terminal window, change to the directory containing SkoolKit, and enter this command:
$ skool2asm.py src/sd.skool > sd.asm
A few seconds later, an ASM file for Skool Daze will be ready: sd.asm.
To create an ASM file for Back to Skool:
$ skool2asm.py src/bts.skool > bts.asm
skool2asm.py supports many options; run it with no arguments to see a list:
Usage: skool2asm.py [options] FILE
Convert a skool file into an ASM file, written to standard output. FILE may
be a regular file, or '-' for standard input.
Options:
-q Be quiet (don't show timings)
-v Be verbose (show instruction substitutions)
-w Suppress warnings
-e Write processed lines to stderr (implies -w)
-d Use CR+LF to end lines
-t Use tab to indent instructions (default indentation is 2 spaces)
-l Write disassembly in lower case
-u Write disassembly in upper case
-D Write disassembly in decimal
-H Write disassembly in hexadecimal
-iN Set instruction field width to N (default=23)
-fN Apply fixes:
N=0: None (default)
N=1: @ofix only
N=2: @ofix and @bfix
N=3: @ofix, @bfix and @rfix (implies -r)
-c Create default labels for unlabelled instructions
-s Use safe substitutions (@ssub)
-r Use relocatability substitutions too (@rsub) (implies -f1)
See ASM modes and directives for a description of the @ssub and @rsub substitution modes, and the @ofix, @bfix and @rfix bugfix modes.
skool2ctl.py converts a skool file into a control file. For example:
$ skool2ctl.py src/sd.skool > sd.ctl
In addition to block types and addresses, sd.ctl will contain block titles, block descriptions, registers, mid-block comments, block end comments, sub-block types and addresses, and instruction-level comments. However, note that ASM directives are lost in the conversion.
To list the options supported by skool2ctl.py, run it with no arguments:
Usage: skool2ctl.py [options] FILE
Convert a skool file into a control file, written to standard output. FILE
may be a regular file, or '-' for standard input.
Options:
-wX Write only these elements, where X is one or more of:
b = block types and addresses
t = block titles
d = block descriptions
r = registers
m = mid-block comments and block end comments
s = sub-block types and addresses
c = instruction-level comments
-h Write addresses in hexadecimal format
skool2html.py converts a skool file (and its associated ref file, if one exists) into a browsable disassembly in HTML format.
For example:
$ skool2html.py game.skool
will convert the file game.skool into a bunch of HTML files. If game.ref also exists, that will be used to provide further information to the conversion process.
skool2html.py can operate directly on ref files, too. For example:
$ skool2html.py game.ref
In this case, the skool file declared in the [Config] section of game.ref will be used; if no skool file is declared in game.ref, game.skool will be used if it exists.
skool2html.py supports several options; run it with no arguments to see a list:
Usage: skool2html.py [options] FILE [FILE...]
Convert skool files and ref files to HTML. FILE may be a regular file, or '-'
for standard input.
Options:
-V Show SkoolKit version number and exit
-q Be quiet
-d DIR Write files in this directory (default is '.')
-o Overwrite existing image files
-i LIB Use this image library ('gd' or 'PIL'; default is 'gd')
-l Write disassembly in lower case
-u Write disassembly in upper case
-D Write disassembly in decimal
-H Write disassembly in hexadecimal
-P LIST Write only these custom pages (when '-wP' is specified)
-wX Write only these files, where X is one or more of:
B = Graphic glitches
b = Bugs
d = Disassembly files
G = Game status buffer
g = Graphics
i = Disassembly index
m = Memory maps
o = Other code
P = Pages defined in the ref file
p = Pokes
t = Trivia
y = Glossary
The -P option takes a comma-separated list of page IDs; page IDs are declared in the names of the [PageContent:*] sections in the ref file.
For example, to write only the disassembly files, memory maps, and ‘Play area’ and ‘Animatory states’ pages for Skool Daze:
$ skool2html.py -wdmP -P PlayArea,AnimatoryStates sd.ref
sna2skool.py converts a binary (raw memory) file or a 48K SNA or Z80 snapshot into a skool file. For example:
$ sna2skool.py game.z80 > game.skool
Now game.skool can be converted into a browsable HTML disassembly using skool2html.py, or into an assembler-ready ASM file using skool2asm.py.
sna2skool.py supports several options; run it with no arguments to see a list:
Usage: sna2skool.py [options] FILE
Convert a binary (raw memory) file or a 48K SNA or Z80 snapshot into a skool
file.
Options:
-c FILE Use FILE as the control file (default is file.ctl)
-g FILE Generate a control file in FILE
-h Write hexadecimal addresses in the generated control file
-H Write hexadecimal addresses and operands in the disassembly
-L Write the disassembly in lower case
-s ADDR Specify the address at which to start disassembling (default=16384)
-o ADDR Specify the origin address of file.bin (default: 65536 - length)
-t Show ASCII text in the comment fields
-r Suppress addition of comments listing entry point referrers
-n N Set the max number of bytes per DEFB statement to N (default=8)
-m M Group DEFB blocks by addresses that divide M
-z Write bytes with leading zeroes in DEFB statements
-l L Set the max number of characters per DEFM statement to L (default=66)
To convert a snapshot into an assembler-ready ASM file without producing an intermediate skool file, the output of sna2skool.py can be fed directly into skool2asm.py thus:
$ sna2skool.py game.z80 | skool2asm.py - > game.asm