diskii/README.md
2017-03-13 22:19:59 -04:00

4.7 KiB

diskii

Note: diskii is not stable yet! I don't expect to remove functionality, but I'm still experimenting with the command syntax and organization, so don't get too comfy with it.

diskii-the-tool is a commandline tool for working with Apple II disk images. Given that AppleCommander already does everything, it's not terribly necessary. It is, however, mine. Minor benefits (right now) are binaries you can copy around (no Java needed), support for Super-Mon symbol tables on NakedOS disks, and creation of "Standard Delivery" disk images.

diskii-the-library is probably more useful: a library of disk-image-manipulation code that can be used by other Go programs.

diskii's major disadvantage is that it mostly doesn't exist yet.

Build Status Report Card GoDoc

It rhymes with “whiskey”.

Discussion/support is in #apple2 on the retrocomputing Slack (invites here).

Goals

Eventually, it aims to be a comprehensive disk image manipulation tool, but for now only the applesoft decode command works.

The library code aims (a) to support the commandline tool operations, and (b) to replace the "read and write disk images" code of the goapple2 emulator.

Current disk operations supported:

Feature DOS 3.3 ProDOS NakedOS/Super-Mon
basic structures
ls
dump
put
dumptext
delete
rename
put
puttext
extract (all)
lock/unlock
init
defrag

Installing/updating

Assuming you have Go installed, run go get -u github.com/zellyn/diskii

You can also download automatically-built binaries from the latest release page. If you need binaries for a different architecture, please send a pull request or open an issue.

Short-term TODOs/roadmap/easy ways to contribute

My rough TODO list (apart from anything marked () in the disk operations matrix is listed below. Anything that an actual user needs will be likely to get priority.

  • Build per-platform binaries for Linux, MacOS, Windows.
  • Implement GetFile for DOS 3.3
  • Add and implement the -l flag for ls
  • Add Delete to the disk.Operator interface
    • Implement it for Super-Mon
    • Implement it for DOS 3.3
  • Make 13-sector DOS disks work
  • Read/write nybble formats
  • Read/write gzipped files
  • Add ProDOS support (add lib/prodos/prodos.go and register a ProDOS operator factory)