API for package: romreader
Homepage: Github
-Variables
*valid-formats*: ("nes") variable
A list of ROM formats with implemented readers. Do not manually modify this.
-Classes
rom (standard-object) class
SLOTS
metadata reader: rom-metadata
UNDOCUMENTED
binary reader: rom-binary
UNDOCUMENTED
format reader: rom-format
UNDOCUMENTED
prg reader: rom-prg writer: rom-prg
UNDOCUMENTED
chr reader: rom-chr writer: rom-chr
UNDOCUMENTED
-Conditions
romreader-error (error) class
The base condition for all errors in ROMREADER.
-Functions
defreader format &body body function
Define a reader for FORMAT. FORMAT should be a pathname-type
(i.e. file extension). FORMAT will be added to *valid-formats* if needed.
BODY executes inside a WITH-OPEN-FILE binding 'in' to a binary-stream of
the ROM. The BODY should return a list like so: (rom-metadata rom-binary).
load-rom path function
Check to see if PATH exists and is a supported ROM format. If so, call the
appropriate reader and return a ROM instance, otherwise error.
rom-binary rom standard-generic-function
Return a bytevector of the ROM data.
rom-chr rom standard-generic-function
Return the character/sprite data from the ROM.
(setf rom-chr) new-value object standard-generic-function
:undocumented
rom-format rom standard-generic-function
Return the file extension of the ROM as a symbol.
rom-metadata rom standard-generic-function
Return a plist of the ROM metadata.
rom-prg rom standard-generic-function
Return the program data from the ROM.
(setf rom-prg) new-value object standard-generic-function
:undocumented
-Macros
defreader format &body body macro
Define a reader for FORMAT. FORMAT should be a pathname-type
(i.e. file extension). FORMAT will be added to *valid-formats* if needed.
BODY executes inside a WITH-OPEN-FILE binding 'in' to a binary-stream of
the ROM. The BODY should return a list like so: (rom-metadata rom-binary).