PCjs 2.0 disk images are JSON objects with the following properties:
For example, take a look at this PC DOS diskette.
Older (PCjs 1.0) disk images were basically just an Array of sector data (what is now called the diskData object), without any other information. Such disk images are still supported, but all the disk images now stored on PCjs disk servers, such as diskettes.pcjs.org, have been converted to the 2.0 format.
To build a PCjs disk image, such as this PC DOS 2.00 diskette, from an IMG file:
node modules/diskimage.js /diskettes/pcx86/sys/dos/2.00/PCDOS200-DISK1.img PCDOS200-DISK1.json
In addition to IMG files, DiskImage also includes (experimental) support for PSI (PCE Sector Image) files, which can in turn be built from Kryoflux RAW files. Here are the basic steps, using tools from PCE:
which translates to these commands (using a 360K PC diskette named “disk1” as an example):
pfi disk1.00.0.raw disk1.pfi pfi disk1.pfi -p double-step -r 600000 -p decode pri disk1.pri pri disk1.pri -c 40-99 -p delete disk1.pri pri disk1.pri -p decode mfm disk1.psi node modules/diskimage.js disk1.psi disk1.json
To build a VisiCalc diskette from a directory containing VC.COM, specify the name of the directory, including a trailing slash, like so:
node modules/diskimage.js /diskettes/pcx86/app/other/visicalc/1981/VISICALC-1981/ VISICALC-1981.json
By default, the diskette will be given an 11-character volume label derived from the directory name (eg, “VISICALC-19”);
however, you can use
--label to specify your own label (eg,
--label=VISICALC81), or use
--label=none to suppress
the volume label.
The smallest standard PC diskette format that can accomodate all the files will be automatically selected, but you can
specify a different target size (in Kb) using
--target=N, where N is 160, 180, 320, 360, 720, 1200, or 1440. For
example, if your diskette must work with PC DOS 1.0, use
Another useful option is
--normalize, which will transform the line-endings in all recognized text files from LF to CR/LF;
a recognized text file is any file ending with one of these extensions (.md, .me, .bas, .bat, .asm, .lrf, .mak, .txt, or .xml)
AND which contains only 7-bit ASCII characters – since some files, like .bas files, can contain either ASCII or non-ASCII
data. The list of recognized text file extensions is likely to grow over time.
Both local and remote diskette images can be examined. To examine a remote image, you must use the
with either an explicit URL, as in:
node modules/diskimage.js --disk https://diskettes.pcjs.org/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json
or with one of PCjs’ implicit diskette paths, such as
/diskettes, which currently maps to disk server
node modules/diskimage.js --disk /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json
If you happen to have a local file that exists in the same location as the implicit diskette path, use
--server to force
the server mapping. The list of implicit paths for PC diskettes currently includes:
To get a DOS-compatible directory listing of a disk image:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --list
To display all the unused bytes of a disk image:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --list=unused
NOTE: Unused bytes are a superset of free bytes. Free bytes are always measured in terms of unused clusters, multiplied by the cluster size, whereas unused bytes are the combination of all completely unused cluster space plus any partially unused cluster space. Being able to see all the unused bytes on a disk can be useful for studying disk image usage, or simply making sure that a disk is free of any unwanted data.
TODO: Update the unused byte report to include unused bytes, if any, in all FAT sectors and directory sectors.
To extract all the files from a disk image:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --extract
To extract a specific file from a disk image:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --extract=COMMAND.COM
To dump a specific (C:H:S) sector from a disk image:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --dump=0:0:1
To dump multiple (C:H:S) sectors from a disk image track, follow the C:H:S values with a sector count; eg:
node modules/diskimage.js /diskettes/pcx86/sys/dos/ibm/2.00/PCDOS200-DISK1.json --dump=0:0:1:4