5 JPC-RR is licenced under GNU GPL v2. See file “LICENSE”
11 To get started, you need BIOS image, VGABIOS image and DOS boot
12 floppy and JDK for Java 6 standard edition (later versions should
13 they appear should also work). Note: JRE is not enough.
15 Note that to play back recorded movies, you need exact same
16 version of BIOS image, VGABIOS image and DOS boot floppy as was
17 used when making the movie (in addition to exact same versions of
22 See compile.sh or compile.bat. The streamtools stuff is only
23 needed for dumping videos.
27 First you need to get and make some important images. Obtain BIOS
28 image, VGABIOS image and DOS boot floppy from somewhere. After
29 starting the emulator, use Drives -> Import Image to import the
30 images (ignore the error about no BIOS images being found).
34 There is premade autoexec script called assemble.jpcrrinit that
35 has fairly reasonable defaults. To use it:
37 java JPCApplication -library library -autoexec assemble.jpcrrinit
39 The “-library library” specifies that contents of directory
40 'library' are to be used as library. The script pops up settings
41 for new emulated PC (if you want to load savestate, click
42 cancel). Select BIOS and VGABIOS for BIOS and VGABIOS image (they
43 should be already selected), DOSfloppy for fda (boot device
44 should be set to fda) and game image as some HD drive
48 • Putting the game as hdd (the fourth hard disk slot) causes boot
51 • Some BIOS versions have “press F12 to select boot device”. Hit
52 <enter> from emulated keyboard and that prompt will go away in
53 about half emulated second (it stays several emulated seconds
56 • If game doesn't need lots of memory, hitting F5 to skip
57 intialization files is fastest. If it does need more memory,
58 run config.sys commands but not autoexec.bat.
60 • Some DOS disks have DOSIDLE with them, don't use it as it
61 messes badly with emulator.
63 3 Making JPC-RR format images from raw images
65 Due to various factors, JPC-RR can't use raw image files directly
66 but requires its own image format.
68 3.1 Importing images from GUI:
70 Use Drives -> Import Image to import existing directories or
71 image files. Dialog prompting parameters will be displayed. When
72 importing floppy images, check “standard geometry” if possible,
73 that enables geometry autodetection, which is reasonable
74 virtually all of the time it is offered.
78 • If making image from directory, the names of the files must
79 conform to FAT naming restrictions (8+3 character names, no
80 spaces, etc). Avoid filenames with non-ASCII characters.
82 • The DOS limit of 112 or 224 files for floppies does not apply
83 to images created from directory trees. The minimum limit value
84 used is 512. If even that isn't enough, the limit is
85 automatically increased to fit all the needed directory
88 • Making boot disks from tree does NOT work. Even if you got
89 system boot files there, it still won't work.
91 • Only floppy disks and hard drives can be made from directory
92 trees. BIOS images and CDROM images require image file.
94 • Avoid floppies with custom geometry (floppy geometry does
95 affect disk ID). Disks with over 63 sectors per track don't
96 work with DOS. Wheither disks with over 127 tracks per side
97 work with DOS is unknown. Also avoid 1024-tracks per side HDDs.
99 • The geometry limits are: 2-1024 tracks per side for HDD, 1-256
100 tracks per side for floppy. 1-63 sectors per track for HDD,
101 1-255 sectors per track for floppy. 1-16 sides for HDD, 1 or 2
102 sides for floppy. This gives size limit of 65280KiB for floppy
103 disks (but note the DOS limit!) and 516096KiB for HDDs.
105 • There are multiple image file contents that represent the same
106 image. The one with smallest size is picked when creating
109 • Note: Although the IDs are 128 bits long, they are not MD5
112 3.3 Importing from command line
114 There is tool called ImageMaker that can make JPC-RR images from
115 raw images. Each image has format, ID an name. Format and name
116 are specified when making image. ID is automatically calculated
117 from format and contents. Name does not affect the ID but is
118 purely for convience so one doesn't have to specify long image
123 The syntax for ImageMaker when making images is:
125 $ java ImageMaker <format> [<options>...] <destination> <source>
128 <destination> is file name for JPC-RR format image to write.
129 <source> is either name of regular file (raw image file) or name
130 of directory tree with files (supported for making floppy or hard
131 disk images only). In case of directory tree, the files are
132 layout deterministically to disk, so the ID will always be the
133 same for given geometry and type. <name> is name to give to disk.
136 --BIOS BIOS image (note: VGABIOS is also of this type).
138 --CDROM CD-ROM image.
140 --HDD=cylinders,sectors,heads Hard disk with specified geometry.
142 --floppy=tracks,sectors,sides Floppy disk with specified
145 --floppy160 160KiB floppy (40 tracks, 8 sectors, Single sided).
147 --floppy180 180KiB floppy (40 tracks, 9 sectors, Single sided).
149 --floppy320 320KiB floppy (40 tracks, 8 sectors, Double sided).
151 --floppy360 360KiB floppy (40 tracks, 9 sectors, Double sided).
153 --floppy410 410KiB floppy (41 tracks, 10 sectors, Double sided).
155 --floppy420 420KiB floppy (42 tracks, 10 sectors, Double sided).
157 --floppy720 720KiB floppy (80 tracks, 9 sectors, Double sided).
159 --floppy800 800KiB floppy (80 tracks, 10 sectors, Double sided).
161 --floppy820 820KiB floppy (82 tracks, 10 sectors, Double sided).
163 --floppy830 830KiB floppy (83 tracks, 10 sectors, Double sided).
165 --floppy880 880KiB floppy (80 tracks, 11 sectors, Double sided).
167 --floppy1040 1040KiB floppy (80 tracks, 13 sectors, Double
170 --floppy1120 1120KiB floppy (80 tracks, 14 sectors, Double
173 --floppy1200 1200KiB floppy (80 tracks, 15 sectors, Double
176 --floppy1440 1440KiB floppy (80 tracks, 18 sectors, Double
179 --floppy1476 1476KiB floppy (82 tracks, 18 sectors, Double
182 --floppy1494 1494KiB floppy (83 tracks, 18 sectors, Double
185 --floppy1600 1600KiB floppy (80 tracks, 20 sectors, Double
188 --floppy1680 1680KiB floppy (80 tracks, 21 sectors, Double
191 --floppy1722 1722KiB floppy (82 tracks, 21 sectors, Double
194 --floppy1743 1743KiB floppy (83 tracks, 21 sectors, Double
197 --floppy1760 1760KiB floppy (80 tracks, 22 sectors, Double
200 --floppy1840 1840KiB floppy (80 tracks, 23 sectors, Double
203 --floppy1920 1920KiB floppy (80 tracks, 24 sectors, Double
206 --floppy2880 2880KiB floppy (80 tracks, 36 sectors, Double
209 --floppy3120 3120KiB floppy (80 tracks, 39 sectors, Double
212 --floppy3200 3200KiB floppy (80 tracks, 40 sectors, Double
215 --floppy3520 3520KiB floppy (80 tracks, 44 sectors, Double
218 --floppy3840 3840KiB floppy (80 tracks, 48 sectors, Double
223 --volumelabel=label Give specified volume label (affects ID).
224 Only meaningful when making image out of directory tree. Default
227 --timestamp=YYYYMMDDHHMMSS Give specified timestamp for files
228 (affects ID). Only meaningful when making image out of directory
229 tree. The default timestamp is 19900101T000000Z.
231 3.3.3 Image information
235 $ java ImageMaker <imagefile>
237 Variety of information about image is displayed (especially for
238 floppies/HDDs). Two important fields are calculated and claimed
239 disk ID. They should be the same. If they are not, then the image
240 file is corrupt (sadly, imagemaker has bugs and bugs that cause
241 it to write corrupt images have been seen).
243 3.4 Advanced: The disk ID algorithm
245 The disk ID is calculated as:
247 Skein-256-128-deprecated(<typecode>|<geometry>|<image>)
249 Where Skein-256-128-deprecated is Skein hash function with
250 256-bit internal state and 128-bit output using the deprecated
251 rotation constants (as specified in Skein hash function reference
252 documentation versions 1.0 and 1.1). The <image> is the whole
253 image, including parts not stored in image file. The reason for
254 keeping using the deprecated constants are:
256 • Changing the constants would change the IDs, which would
257 invalidate existing images
259 • This is not about cryptographic security
261 • The new constants don't improve security that much anyway.
263 3.4.1 Floppies and HDDs
265 Floppies have <typecode> value 0 (single byte) and HDDs have 1
266 (single byte). <geometry> is as follows (this is exactly the same
267 form as it appears in image header):
269 Byte 0 bits 0-1: Bits 8-9 of track count per side - 1.
271 Byte 0 bits 2-5: Head count - 1.
273 Byte 0 bits 6-7: Reserved, must be 0.
275 Byte 1: Bits 0-7 of track count per side - 1.
277 Byte 2: Sector count per track - 1.
279 3.4.2 CD-ROM and BIOS images
281 CD-ROMs have <typecode> value 2 (single byte) and BIOS images
282 have 3 (single byte). <geometry> is blank.
284 3.5 Advanced: Disk Image format
286 The disk image consists of following parts, concatenated in this
287 order without padding:
299 • type-specific geometry/size data
307 Magic in disk image files is following 5 bytes: “IMAGE”
311 Disk ID is given as 16 bytes, encoding the 128-bit disk ID.
315 Type code is single byte. 0 for floppies, 1 for HDDs, 2 for
316 CD-ROMs and 3 for BIOS images. Other values are reserved.
318 3.5.4 Disk name length
320 Obsolete. Disk name length is given as two-byte big-endian value.
321 New images should have 0 here.
325 Ignored. Name field is there for backward compatiblity. Disk name
326 length gives length of this field in bytes.
328 3.5.6 Type-specific geometry/size data (floppies and HDDs)
330 Floppies and HDDs have 3-byte geometry data:
332 Byte 0 bits 0-1: Bits 8-9 of track count per side - 1.
334 Byte 0 bits 2-5: Head count - 1.
336 Byte 0 bits 6-7: Reserved, must be 0.
338 Byte 1: Bits 0-7 of track count per side - 1.
340 Byte 2: Sector count per track - 1.
342 3.5.7 Type specific-geometry/size data (CD-ROMs)
344 CD-ROMs have 4-byte big-endian sector (512 bytes!) count.
346 3.5.8 Type specific-geometry/size data (BIOS images)
348 BIOS images have 4-byte big-endian byte (not sector or block)
351 3.5.9 Actual image data (floppy/HDD)
353 Floppy or HDD imagedata consists of following subparts:
363 Storage method is single byte. Sectors present gives number of
364 last nonzero sector + 1 (zero if image is all zeroes)
366 3.5.10 Floppy/HDD storage method 0: Raw storage
368 This storage method has empty header. Image data is raw dump of
369 first sectors present sectors.
371 3.5.11 Floppy/HDD storage method 1: Sectormap
373 Image data header contains bitfield with just enough bytes to
374 have one bit per present sector. The order of bits is such that
375 number of bit corresponding to each sector in byte is sector
376 number modulo 8 and byte number is floor of sector number divided
377 by 8 when sector numbers are counted from zero. If bit
378 corresponding to sector is set, then the sector is present in
379 image data, otherwise it is absent and assumed to be all-zeroes.
381 Image data contains dumps of all present sectors in order of
382 increasing sector number.
384 3.5.12 Floppy/HDD storage method 2: Extent first sector zero
386 Image data is empty as storage-specific data is mangled with
387 image data. The image data alternates between blocks encoding
388 zero sectors and blocks encoding nonzero sectors. The first block
389 encodes zero sectors.
391 Block encoding zero sectors consist of single 1-4 byte
392 little-endian value encoding number of sectors in block - 1.
393 Number of bytes is determined by sectors present value. It is 1
394 for 1-256 sectors, 2 for 257-65536, 3 for 65537-16777216 and 4
395 for more than 16777216. All sectors in block are filled with
396 zeroes and are not stored.
398 Block encoding nonzero sectors has same block count as zero
399 sector block but is followed by the sectors stored raw.
401 3.5.13 Floppy/HDD storage method 3: Extent first sector nonzero
403 Same as storage method 2 but first block is nonzero sector block.
405 3.5.14 Actual image data (CD-ROMs and BIOS images)
407 These store image data raw. The amount of data is specified by
412 Comments are given as list of strings, with UTF-8 encoded strings
413 following 2-octet big-endian length. Comment list is terminated
414 by entry with length 0 (0x00 0x00). Comments are optional and may
417 4 The actual emulator
419 The actual emulator is invoked as:
421 $ java JPCApplication <options>...
423 The valid options are:
425 -library <library> Use the specified directory when searching for
426 images (can only be specified once).
428 -autoexec <script> Execute contents of specified file as commands
431 -norenames Copy&Delete files instead of renaming. Mainly meant
432 for debugging copy&delte code.
436 When emulator is started, command line comes up. Following
439 • 'exit': exit immediately
441 • 'load <plugin>': Load plugin (no arguments)
443 • 'load <plugin>(<arguments>)': load plugin with arguments.
445 • 'command <command> [<arguments>...]': Invoke command via
446 external command interface.
448 • 'call<command> [<arguments>...]': Invoke command via external
449 command interface and print return values.
451 When one gets command line, its useful to load some plugins. See
452 section about plugins. Note: Load runner plugin
453 (PCControl/PCRunner and so) last, as some runners like to start
456 4.2 PC settings dialog notes
458 • CPU divider base frequency before division is 1GHz.
460 • Images can be specified by name or by ID. Name is relative to
461 library directory. If the image is in subdirectory of image
462 directory, the directory separator is is '/' regardless of what
465 • CD-ROM and hdc are mutually exclusive
467 • Modules is comma-seperated list of modules to load. To pass
468 arguments to some modules, enclose the arguments in (). Same
469 module can be specified twice only if parameters differ.
471 • Setting boot device doesn't work with some BIOS versions. Those
472 versions prompt the boot device anyway.
474 4.3 Audio output channels
476 PC can have one or more audio output channels. The name of audio
477 output associated with PC speaker is:
478 'org.jpc.emulator.peripheral.PCSpeaker-0'. Modules that have
479 audio outputs get channel names of form <classname>-<sequential>,
480 where <classname> is name of main module class and sequential is
481 number starting from zero. Note that same module can have
482 multiple output channels. If multiple modules of same class
483 request audio outputs, the <sequential> values of subsequent
484 module start where previous left off.
488 Plugins actually execute the tasks of the emulator. They can be
489 loaded using “load <plugin>” or 'load <plugin>(<arguments>)” from
492 Different Plugins using the same output (like running PCMonitor
493 and RAWVideoDumper) should not conflict because connector output
494 hold locking is desinged to handle multiple readers.
496 If no plugin used requires GUI, then the emulator can be run
497 without having GUI available.
499 4.4.1 plugin: org.jpc.plugins.PCControl
501 Takes optionally 'extramenu=<file>' and 'uncompressedsave=1',
502 requires and uses GUI.
504 Runs the PC emulator core. Has capability to start/stop
505 emulation, breakpoint after certain time or start/end of VGA
506 vertical retrace. Also can create, savestate and loadstate PC
507 emulation. Memory dumping is supported.
509 'extramenu=<file>' causes Plugin to load extra menu entries from
510 <file>. 'uncompressedsave=1' causes savestates to be written
511 uncompressed (useful if they are stored in VCS supporting delta
514 4.4.2 plugin: org.jpc.plugins.PCRunner
516 Takes 'movie=<file>' as argument and optionally 'stoptime=<time>'
517 Does not require nor use GUI.
519 Loads PC from savestate and just runs it. CTRL+C to quit. Also
520 automatically quits once stoptime is reached.
522 4.4.3 plugin: org.jpc.plugins.PCMonitor
524 No arguments, requires and uses GUI.
526 VGA monitor for emulated PC.
528 4.4.4 plugin: org.jpc.plugins.VirtualKeyboard
530 No arguments, requires and uses GUI.
532 On-screen keyboard for emulated PC.
534 4.4.5 plugin: org.jpc.plugins.PCStartStopTest
536 No arguments, requires and uses GUI.
538 Small plugin testing remote PC start/stop. Also supports sending
539 some common keypresses.
541 4.4.6 plugin: org.jpc.plugins.RAWVideoDumper
543 Takes 'rawoutput=<file>' as argument. Does not require nor use
546 Dumps all generated frames to RAW file <file>. Rawoutput is
547 required. The raw file consists of concatenation of zlib streams.
548 The uncompressed stream is concatenation of time skips (FFh FFh
549 FFh FFh), each acting as time offset of 2^32-1 nanoseconds and
550 saved frames. The saved frame has time offset in nanoseconds (big
551 endian) as first four bytes (must be at most 2^32-2, as 2^32-1 is
552 reserved for time skip). The next two bytes are big-endian width,
553 next two big-endian height. Finally frame has 4 * width * height
554 bytes of data that encodes pixels using 4 bytes per pixel, in
555 left-to-right, up-to-down order. Byte 0 of each pixel is
556 reserved, byte 1 is the red channel, byte 2 is green channel and
557 byte 3 is blue channel.
559 Dumping to pipe is supported.
561 4.4.7 plugin: org.jpc.plugins.RAWAudioDumper
563 Takes 'src=<name of audio output channel>',
564 'file=<output-filename>' and 'offset=<offset>' as arguments,
565 separated by ','. Does not require nor use GUI.
567 Dumps output from specified audio output channel (src, mandatory)
568 to RAW-format file (file, mandatory). The resulting file consists
569 of records, 4 or 8 bytes each. 4 byte record consists of 0xFF
570 0xFF 0xFF 0xFF and means to increase next time delta by 2^{32}-1
571 ns. Otherwise record is 8 bytes. Each 8 byte record has three
572 fields. First 4 byte unsinged big endian timedelta value (in
573 nanoseconds, must be smaller than 2^{32}-1), then 2 byte signed
574 big endian new left channel volume, then 2 byte signed big endian
575 new right channel volume. Optionally 'offset' can be set to
576 positive value (in nanoseconds) to delay the audio by.
578 4.4.8 plugin: org.jpc.plugins.LuaPlugin
580 Takes 'kernel=<name of lua kernel file>', other parameters are
581 passed to kernel, requires and uses GUI.
583 Lua VM for executing scripts.
585 4.4.9 plugin: org.jpc.plugins.JoystickInput
587 No parameters. Displays window for sending joystick input.
591 5.1 org.jpc.modules.Joystick:
595 • Resources: I/O port 0x201
597 Emulates joystick game port.
599 5.2 org.jpc.modules.SoundCard
601 • Arguments: Optional resources specification
603 • Resources (defaults): I/O port 0x220-0x22F, IRQ 5, DMA 1, DMA 5
607 5.3 org.jpc.modules.FMCard
609 • Arguments: Optional resources specification
611 • Resources (defaults): I/O port 0x338-0x33B
615 5.4 org.jpc.modules.BasicFPU:
621 Crude FPU (x87) emulator.
625 Hacks are saved to savestates but not movies.
629 Force bit 1 of physical address 0x0410 to zero, signaling that
630 the system has no FPU. BIOS assumes system has FPU but some games
631 use that bit to detect FPU, trying to use it if it is “present”.
632 Try this if game startup hangs with lots of trying to use FPU but
633 not present errors. Don't use if there is FPU present. Needed to
634 get games like Blake Stone / Wolfenstein 3-D to work (FPU
635 emulator allows it to start but causes graphical glitches).
639 Update basic VGA parameters before vretrace, not after it. Some
640 games (e.g. Commander Keen 4) don't like if this isn't done and
641 some games (e.g. Mario & Luigi) don't like if it is done. Wrong
642 value manifests as jerky scrolling (scrolling back and forth and
643 fixed statusbars move).
645 7 Some error messages and explanations
647 • <filename> is Not a valid image file
649 • <filename> is not image file
651 • <filename> claims to be floppy with illegal geometry: <x>
652 tracks, <y> sides and <z> sectors.
654 • <filename> claims to be HDD with illegal geometry: <x> tracks,
655 <y> sides and <z> sectors.
657 • Can't read disk image sector map.
659 • Can't read disk image extent.
661 Code expects <filename> to be valid JPC-RR format image, but it
662 isn't JPC-RR image at all or its corrupt.
664 • <filename> is image of unknown type.
666 • <filename> has unrecognized geometry <x> <y> <z>
668 Possibly corrupt image, not JPC-RR image, or JPC-RR image from
669 future version containing something current version can't
672 • Invalid format specifier <something>.
674 • Invalid syntax of --floppy= or --HDD= option.
676 • Invalid format specifier/option <something>.
678 Invalid option or format specifier was given. Check for typos.
680 • java ImageMaker [<options>...] <format> <destination> <source>
683 Check syntax of command. Especially that diskname is present!
685 • The image has <nnn> sectors while it should have <yyy>
686 according to selected geometry.
688 • Raw image file length not divisible by 512.
690 • Trying to read sector out of range.
692 The selected geometry is wrong or raw image is incomplete.
694 • Invalid disk name (Should not happen!).
696 • Invalid geometry to be written.
698 This is a very likely a bug in program.
700 • What the heck <filename> is? It's not regular file nor
703 That sort of file can't be used as input for image making, or the
704 file just doesn't exist.
706 • BIOS images can only be made out of regular files.
708 • CD images can only be made out of regular files.
710 Source image specified is not regular file, but image of that
711 type can't be made of anything else.
713 • Can't read raw bios image file.
715 • Can't read sector <nnn> from image.
717 Reading the raw image file failed for some reason.
719 • Bad library line: "<something>". Ignored.
721 Syntax error in image library.
723 • Removing image <something> a.k.a. "<something>" as it no longer
726 The image file no longer exists so it gets removed from library.
728 • Removing image <something> a.k.a. "<something>" due to <some>
731 Image library code killed some image from library due to some
732 kind of conflict with image being added.
734 • Too much data to fit into given space.
736 The tree you gave contains takes just too much space to fit into
739 8 Advanced: Savestate/movie format
741 8.1 Special character classes
745 Following Unicode codepoints (encoded as UTF-8) are interpretted
748 • Codepoints 0x20, and 0x09.
750 • Codepoints 0x1680, 0x180E, 0x2028, 0x205F and 0x3000
752 • Codepoints 0x2000-0x200A.
756 Following byte sequences are interpretted as linefeeds (line
759 • Byte 0x0A (UTF-8 encoded codepoint 0x0A)
761 • Byte 0x0D (UTF-8 encoded codepoint 0x0D)
763 • Byte 0x1C (UTF-8 encoded codepoint 0x1C)
765 • Byte 0x1D (UTF-8 encoded codepoint 0x1D)
767 • Byte 0x1E (UTF-8 encoded codepoint 0x1E)
769 • Bytes 0xC2 0x85 (UTF-8 for unicode control character NL,
772 • Bytes 0xE2 0x80 0xA9 (UTF-8 encoded codepoint 0x2029)
776 JRSR archive format packs multiple text archive members to text
777 archive. It does not support binary members. JRSR archives have
778 first five or six bytes form the magic. It is “JRSR” followed by
779 LINEFEED character There are four kinds of lines after that
780 (lines are terminated by LINEFEED byte/bytes):
790 Sequencing rules are as follows: Start member is allowed anywhere
791 (after magic). Member line is allowed only inside member (member
792 started but not ended). End member is only allowed inside member.
793 End of file is only allowed outside member. Blank line is allowed
794 anywhere after magic.
798 Start member line is given as “!BEGIN” <SPACE>+ <membername>
799 <LINEFEED>. <SPACE>+ any number of SPACE characters at least one
800 and <LINEFEED> is LINEFEED chacter. The member name is UTF-8
801 encoded and maximum allowed line length is 2048 bytes (including
802 LINEFEED, which means name is limited to 509-2040 codepoints
803 depending on characters used). Starting member inside another
804 implicitly ends the previous member.
808 Member line is given as “+”<content><LINEFEED>. It gives another
809 line for member contents. <content> is passed raw to layers above
810 (followed by line termination)
814 End member line is given as “!END”<LINEFEED>. It ends the current
815 member. The following line can only be start member line or file
820 Blank line is given as <LINEFEED>. Lines like that are ignored.
822 8.3 Four-to-Five encoding
824 Binary members are encoded into text by so-called four-to-five
825 encoding. This encoding can encode single byte to two, two bytes
826 to three, three bytes to four and four bytes to five.
827 Four-to-five encoding has five kinds of blocks. All SPACE and
828 LINEFEED characters are completely ignored, even in middle of
831 8.3.1 End stream block
833 End stream block is encoded as '!'. It ends the stream instantly.
834 There is also implicit end of stream at end of input to decoding.
836 8.3.2 Other four block types
838 Other four block types take the value to be encoded, read it as
839 big-endian value. Then they write it as base-93 big-endian value.
840 Then length specific constants are added to digits of that number
841 to yield ASCII values for characters (those are stored in order):
844 +------------+------------+------------+------------+------------+-----------+
845 | To encode | 1st char. | 2nd char. | 3rd char. | 4th char. | 5th char. |
846 +------------+------------+------------+------------+------------+-----------+
847 +------------+------------+------------+------------+------------+-----------+
848 | 1 byte | 34 | 34 | - | - | - |
849 +------------+------------+------------+------------+------------+-----------+
850 | 2 bytes | 37 | 34 | 34 | - | - |
851 +------------+------------+------------+------------+------------+-----------+
852 | 3 bytes | 45 | 34 | 34 | 34 | - |
853 +------------+------------+------------+------------+------------+-----------+
854 | 4 bytes | 66 | 34 | 34 | 34 | 34 |
855 +------------+------------+------------+------------+------------+-----------+
858 Blocks which encode values greater than what is possible for
859 value of that length are fatal errors.
861 8.4 Line component encoing
863 Line component encoding sits on top of UTF-8 encoding. Line
864 component encoding encodes non-empty 1-D array of non-empty
865 strings into line, and thus array of those into member. Empty
866 lines or lines that don't contain any components are ignored.
867 Line starts with depth value of 0 and must end with depth value
870 Components are seperated by component separators. Empty
871 components are ignored. Following codepoints are separators on
872 depth 0 if not escaped:
874 • Codepoint of '('. The depth is read pre-increment.
876 • Codepoint of ')'. The depth is read post-decrement.
878 • Any SPACE character
880 The following characters are special:
882 • '('. Increments depth by 1 if not escaped (and appears in
885 • ')'. Decrements depth by 1 if not escaped (and appears in
886 component). Depth going negative is an error.
888 • '\'. Next character is interpretted as literal. Error if at end
891 Otherwise, characters are interpretted as literals and appear in
892 components. Depth must be zero at end of line.
896 Header section is in archive member "header". It uses line
897 component encoding. The first component of each line is name of
898 header, and subsequent ones are arguments. How many parameters
899 are expected is dependent on what header it is:
901 8.5.1 PROJECTID header:
903 • Header name: "PROJECTID"
907 • Argument #1: <project-id-string>
911 Gives project ID. Project ID is generated when PC is assembled
912 and is then preserved in save states. It is used for computing
913 rerecord counts. Emulator treats it as opaque string, the IDs it
914 generates are formed by 48 random hexadecimal digits.
916 8.5.2 SAVESTATEID header:
918 • Header name: "SAVESTATEID"
922 • Argument #1: <savestate-id-string>
926 Gives save state ID. Each save state has its own save state ID.
927 Treated as opaque string, but generated as 48 random hexadecimal
928 digits. The presence of this header signals whether there is save
929 state to be loaded. If this header is present, save state load
930 will be attempted. If absent, save state is not to be loaded even
931 if present (and correct savestate load would be technically
934 The value is used to prevent loading incompatible save states in
935 preserve event stream mode and also to find the point in event
936 stream where one left off.
938 8.5.3 RERECORDS header:
940 • Header name: "RERECORDS"
944 • Argument #1: <rerecords>
948 Gives rerecord count. PC assembly (except when loading save
949 state) initializes current rerecord count to zero. Must be
950 non-negative and decimal number using ASCII digit characters.
952 On loading save state:
954 1) If project ID matches with previous:
956 1a) If loaded rerecord count is larger or equal to current
959 1a-a) Current rerecord count is loaded rerecord count + 1.
963 1b-a) Current rerecord count increments by 1.
967 2a) Current rerecord count is loaded rerecord count + 1.
969 The current rerecord count at time of save is saved to save
972 8.5.4 AUTHORS header:
974 • Header name: "AUTHORS"
976 • Components: 2 or more
978 • Arguments: free form
982 Gives authors of run. Each argument gives one author. May be
983 present multiple times.
985 8.5.5 COMMENT header:
987 • Header name: "COMMENT"
989 • Components: 2 or more
991 • Arguments: free form
995 Various kinds of free form data. Not parsed further by emulator.
997 8.6 Initialization segment:
999 If SAVESTATEID header isn't present (not a save state), member
1000 "initialization" gives PC initialization parameters for
1001 assembling the PC. It is present anyway even if SAVESTATEID is
1002 present (savestate).
1004 Following parameters are used (space separates components):
1008 Gives Image ID of main system BIOS (mandatory)
1012 Gives Image ID of VGA BIOS (mandatory).
1016 Gives Image ID of hda. Present only if system has hard disk hda.
1020 Gives Image ID of hdb. Present only if system has hard disk hdb.
1024 Gives Image ID of hdc. Present only if system has hard disk hdc.
1028 Gives Image ID of hdd. Present only if system has hard disk hdd.
1032 Gives Image ID of disk in slot <num>. Slot number must be
1035 “DISKNAME” <num> <name>
1037 kGives image name of disk in slot <num>. Slot number must be
1038 non-negative. The slot must be previously declared using “DISK”.
1042 Gives Image slot to initially put into floppy drive fda. Disk
1043 must be of floppy type. If none present, no disk is initially put
1048 Gives Image slot to initially put into floppy drive fdb. Disk
1049 must be of floppy type. If none present, no disk is initially put
1054 Gives Image slot to initially put into CD-ROM drive hdc. Not
1055 allowed if hard disk hdc is present. Disk must be of CD-ROM type.
1056 If none present no disk is initially put there.
1058 "INITIALTIME" <time>
1060 Number of milliseconds since Unix epoch to system start up time.
1063 0-4102444799999. Mandatory.
1065 "CPUDIVIDER" <divider>
1067 Set CPU frequency divider (dividing the 1GHz master clock).
1068 Allowed range is 1-256. Mandatory.
1070 "MEMORYSIZE" <pages>
1072 Number of 4KiB pages of RAM memory. Allowed range 256-262144.
1077 Set boot device. Valid devices are "FLOPPY" (boot from fda),
1078 "HDD" (boot from hda) and "CDROM" (boot from CD).
1080 "LOADMODULEA" <module> <parameters>
1082 Load module <module> with parameters <parameters>.
1084 "LOADMODULE" <module>
1086 Load module <module> with no parameters
1090 Use class <fpu> as FPU emulator.
1094 Use I/O port delay emulation (each I/O port read/write takes
1099 Emulate VGA horizontal retrace.
1101 8.7 Event record format:
1103 Event record is in archive member "events". It uses line
1104 component encoding. Each line gives an event. First component of
1105 each line gives time stamp. These timestamps MUST be in
1106 increasing order and all MUST be non-negative. Time stamp time
1107 unit is exactly 1 nanosecond of emulated time.
1109 The second component of each line is name of class to dispatch
1110 to. Further components are passed as-is to event handlers.
1111 Classes with names consisting only of uppercase A-Z and 0-9 are
1112 special and reserved. It is error to encounter unknown such
1115 8.7.1 Savestate event
1117 • Dispatch to: SAVESTATE
1119 • Argument #1: Savestate id
1121 • Argument #2 (optional): Rerecord count at time of saving
1124 Signals that savestate has occured here. The save state IDs MUST
1125 be unique in entire event stream. The second argument to
1126 savestate (if present) is rerecord count at time of saving that
1127 savestate (useful for calulating rerecord count of movie starting
1128 from savestate). No time restrictions
1132 • Dispatch to: OPTION
1134 • Argument #1: “ABSOLUTE” or “RELATIVE”
1136 Controls various options. “ABSOLUTE” turns on absolute mode
1137 (default) where event timestamps are absolute. “RELATIVE” turns
1138 on relative mode where event timestamps are relative to last
1139 event in stream. The OPTION event itself is not affected by
1140 timing change. No time restrictions. Unknown arguments are
1143 8.7.3 Keyboard keypress/keyrelease event:
1145 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1147 • Argument #1: Fixed: "KEYEDGE"
1149 • Argument #2: Key number. Valid values are 1-83, 85-95, 129-197
1152 Send key press or key release. Keys work in toggle button manner.
1153 The event time must be multiple of 66 666, and must not be less
1154 than 60 * 66 666 TUs after last PAUSE event, 20 * 66 666 TUs
1155 after last KEYEDGE on key >128 and 10 * 66 666 TUs after last
1156 KEYEDGE on key <128.
1160 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1162 • Argument #1: Fixed: "PAUSE"
1164 Send pause key event. The time restrictions are identical to
1167 8.7.5 Mouse button event:
1169 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1171 • Argument #1: Fixed: "MOUSEBUTTON"
1173 • Argument #2: Number of button to release or press (0-4)
1175 Presses or releases the designated mouse button.
1177 8.7.6 X mouse motion event:
1179 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1181 • Argument #1: Fixed: "XMOUSEMOTION"
1183 • Argument #2: Number of units to move (-255 - 255)
1185 Move the mouse in X direction by specified amount. Positive is
1188 8.7.7 Y mouse motion event:
1190 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1192 • Argument #1: Fixed: "YMOUSEMOTION"
1194 • Argument #2: Number of units to move (-255 - 255)
1196 Move the mouse in Y direction by specified amount. Positive is
1199 8.7.8 Z mouse motion event:
1201 • Dispatch to: org.jpc.emulator.peripheral.Keyboard
1203 • Argument #1: Fixed: "ZMOUSEMOTION"
1205 • Argument #2: Number of units to move (-7 - 7)
1207 Move the mouse in Z direction (scrollwheel) by specified amount.
1209 8.7.9 Joystick button event:
1211 • Dispatch to: org.jpc.modules.Joystick
1213 • Argument #1: “BUTTONA”, “BUTTONB”, “BUTTONC” or “BUTTOND”
1215 • Argument #2: “0” if released, “1” if pressed
1217 Send button down/up event. No time restrictions.
1219 8.7.10 Joystick axis event:
1221 • Dispatch to: org.jpc.modules.Joystick
1223 • Argument #1: “AXISA”, “AXISB”, “AXISC” or “AXISD”
1225 • Argument #2: Multivibrator unstable state length in ns.
1227 Set amount of time multivibrator remains in unstable state. No
1232 • Dispatch to: org.jpc.emulator.PC$ResetButton
1238 8.7.12 Fda disk change:
1240 • Dispatch to: org.jpc.emulator.PC$DiskChanger
1242 • Argument #1: Fixed: "FDA"
1244 • Argument #2: Number of image slot to put there.
1246 The disk number MUST be -1 or valid disk number. -1 MUST NOT be
1247 used if there is no disk in floppy drive A. This event causes
1248 specified disk to be placed to FDA or FDA disk to be ejected with
1249 no replacement if disk number is -1. The specified disk if not -1
1250 must be of floppy type. The specified disk if valid must not be
1253 8.7.13 Fdb disk change:
1255 • Dispatch to: org.jpc.emulator.PC$DiskChanger
1257 • Argument #1: Fixed: "FDB"
1259 • Argument #2: Number of image slot to put there.
1261 The disk number MUST be -1 or valid disk number. -1 MUST NOT be
1262 used if there is no disk in floppy drive B. This event causes
1263 specified disk to be placed to FDB or FDB disk to be ejected with
1264 no replacement if disk number is -1. The specified disk if not -1
1265 must be of floppy type. The specified disk if valid must not be
1268 8.7.14 Change CDROM:
1270 • Dispatch to: org.jpc.emulator.PC$DiskChanger
1272 • Argument #1: Fixed: "CDROM"
1274 • Argument #2: Number of image slot to put there.
1276 The disk number MUST be -1 or valid disk number. -1 MUST NOT be
1277 used if there is no disk in CD-ROM. This event causes specified
1278 disk to be placed to CD-ROM or CD-ROM disk to be ejected with no
1279 replacement if disk number is -1. The specified disk if not -1
1280 must be of CD-ROM type.
1282 This event has no effect if CD-ROM is locked.
1284 8.7.15 Write protect floppy:
1286 • Dispatch to: org.jpc.emulator.PC$DiskChanger
1288 • Argument #1: Fixed: "WRITEPROTECT"
1290 • Argument #2: Number of image slot to manipulate
1292 Write protects specified disk. The disk MUST NOT be in any drive
1293 and MUST be valid floppy-type disk.
1295 8.7.16 Write unprotect floppy:
1297 • Dispatch to: org.jpc.emulator.PC$DiskChanger
1299 • Argument #1: Fixed: "WRITEUNPROTECT"
1301 • Argument #2: Number of image slot to manipulate
1303 Disables write protection specified disk. The disk MUST NOT be in
1304 any drive and MUST be valid floppy-type disk.
1306 8.8 Diskinfo sections
1308 Diskinfo sections are named “diskinfo-”<id of disk>. They use
1309 line component encoding, fieldtype being first component on each
1310 line (value being the second). Following fields are defined:
1314 Gives type of image. Possible values are
1316 • “FLOPPY” (floppy disk)
1322 • “BIOS” (BIOS/VGABIOS image)
1324 • “UNKNOWN” (what the heck is this???)
1332 (BIOS images only) Gives length of BIOS image
1336 MD5 of raw disk/BIOS image without any headers or trailers.
1340 (FLOPPY/HDD/CDROM images only) Number of total sectors on disk.
1344 (FLOPPY/HDD images only) Number of tracks on disk per side (1-256
1345 for floppy, 1-1024 for HDD).
1349 (FLOPPY/HDD images only) Number of sides on disk (1 or 2 for
1350 floppy, 1-16 for HDD).
1354 (FLOPPY/HDD images only) Number of sectors per track (1-255 for
1355 floppy, 1-63 for HDD).
1359 Line from image comment block. Usually give data about files
1360 image has. May or may not be present (multiple times)
1364 Output info is stored in section “output-info”. Its relatively
1365 new, so it might not be present (then the contents have to be
1366 guessed based on modules present). Each line gives information
1367 about one output, first field being the type of output.
1371 For video output, there are no parameters so line is just “VIDEO”
1376 For audio output, the only parameter is name of output, so first
1377 component is “AUDIO” and second component is name of audio
1382 Actual savestate format is not documented here. It is close to
1383 impossible to comprehend without access to emulator source
1386 9 Advanced: Making class dumpable
1388 Class is made dumpable by implementing interface
1389 org.jpc.emulator.SRDumpable and implementing method
1390 dumpSRPartial(org.jpc.emulator.SRDumper) and constructor
1391 <init>(org.jpc.emulator.SRLoader). Non-static inner classes can
1392 not be dumpable (make them static using tricks similar to what
1395 If dumped class has dumpable superclass, the first thing dumping
1396 function needs to do is to call dumper function of superclass and
1397 first thing loading constructor needs to do is to call loading
1398 constructor of superclass. If class has no dumpable superclass,
1399 dumper doesn't need to do anything special, while loader needs to
1400 call objectCreated(this) on SRLoader object passed as parameter.
1402 Following these fixed parts, dump all members that are part of
1403 mutable state in emulator core.
1405 9.1 Member dumping/loading functions
1407 There is dumping/loading function for following (all functions
1408 dumping/loading reference types can handle null):
1410 • boolean: SRDumper.dumpBoolean, SRLoader.loadBoolean
1412 • byte: SRDumper.dumpByte, SRLoader.loadByte
1414 • short: SRDumper.dumpShort, SRLoader.loadShort
1416 • int: SRDumper.dumpInt, SRLoader.loadInt
1418 • long: SRDumper.dumpLong, SRLoader.loadLong
1420 • String: SRDumper.dumpString, SRLoader.loadString
1422 • boolean[]: SRDumper.dumpArray, SRLoader.loadArrayBoolean
1424 • byte[]: SRDumper.dumpArray, SRLoader.loadArrayByte
1426 • short[]: SRDumper.dumpArray, SRLoader.loadArrayShort
1428 • int[]: SRDumper.dumpArray, SRLoader.loadArrayInt
1430 • long[]: SRDumper.dumpArray, SRLoader.loadArrayLong
1432 • double[]: SRDumper.dumpArray, SRLoader.loadArrayDouble
1434 • <dumpable type>: SRDumper.dumpObject, SRLoader.loadObject
1436 • special object: SRDumper.specialObject, SRLoader.specialObject
1440 • Dumpable objects come out as type of
1441 org.jpc.emulator.SRDumpable.
1443 • Special objects are various static objects that don't need to
1444 be stored because they don't have mutable fields.
1446 • Don't dump fields related to event state feedback.
1448 • Don't dump temporary flags that are only used while PC is
1449 running. Savestate when PC is running isn't possible anyway.
1451 • Some connectors dump fields related to connector output, some
1454 10 Advanced: Making output connectors
1456 Implementing interface org.jpc.emulator.DisplayController signals
1457 that this is display controller, inhibiting loading of the
1458 standard VGA display controller if loaded as module.
1460 10.1 Interface org.jpc.emulator.OutputConnector
1462 Class is made to be output connector by implementing this
1463 interface. This interface specifies the methods used for output
1464 hold locking. Class org.jpc.emulator.OutputConnectorLocking has
1465 implementations of these that are suitable for calling.
1467 10.1.1 Method subscribeOutput(Object)
1469 Subscribes the output, with specified object as handle.
1471 10.1.2 Method unsubscribeOutput(Object)
1473 Unsubscribe the specified handle object from output.
1475 10.1.3 Method waitOutput(Object)
1477 Wait for output on specified connector using specified handle
1478 object. Returns true on success, false if wait was interrupted by
1479 thread interrupt. Blocking.
1481 10.1.4 Method releaseOutput(Object)
1483 Release connector from p.o.v. of given handle. Does not block.
1485 10.1.5 Method holdOutput()
1487 Release threads waiting on waitOutput() and block until all
1488 subscribers have returned from waitOutput() and enteired
1491 10.1.6 Method releaseOutputWaitAll(object)
1493 Like releaseOutput(), but waits until all handles have released
1496 10.2 Class org.jpc.emulator.VGADigtalOut
1498 Class org.jpc.emulator.VGADigtalOut (already implements
1499 OutputConnector) implements VGA output connector. If module
1500 provodes output connector, it needs to implement
1501 org.jpc.emulator.DisplayController.
1503 10.2.1 Method getWidth()
1505 Get width of display (watch out, can return 0).
1507 10.2.2 Method getHeight()
1509 Get height of display (watch out, can return 0).
1511 10.2.3 Methods getDirtyXMin(), getDirtyXMax(), getDirtyYMin(),
1514 Returns the dirty region (region modified since last output).
1516 10.2.4 Method getBuffer()
1518 Get buffer of ints, at least width * height elements
1519 (left-to-right, top-down, one value per pixel) giving pixel data.
1520 Value for each pixel is 65536 * <red-component> + 256 *
1521 <green-component> + <blue-component>.
1523 10.2.5 Method resizeDisplay(int _width, int _height)
1525 Resize the display to be of specified size.
1527 10.2.6 Method dirtyDisplayRegion(int x, int y, int w, int h)
1529 Mark the specified region as dirty.
1531 10.2.7 Method resetDirtyRegion()
1533 Resets the dirty region to be empty.
1535 10.3 Class org.jpc.emulator.PC method getVideoOutput()
1537 Get VGA output connector for PC.
1539 10.4 Interface org.jpc.emulator.DisplayController.
1541 Implementing this class signals that module is VGA controller.
1542 There can be only one such module active at time and presence of
1543 such module prevents loading builtin VGA controller emulation
1546 10.4.1 Method getOutputDevice()
1548 Get VGA output connector for this VGA device.
1550 10.5 Class org.jpc.emulator.SoundDigitalOut
1552 Class org.jpc.emulator.SoundDigitalOut provodes output connector
1553 for sound. Each connector can transfer stereo signal at arbitiary
1554 sampling rate. Modules that have audio connectors need to
1555 implement interface org.jpc.emulator.SoundOutputDevice, as this
1556 signals that output connectors should be created.
1558 10.5.1 Method addSample(long, short, short)
1560 Add stereo sample at time given by first argument. The second and
1561 third arguments give volume on left and right channels.
1563 10.5.2 Method addSample(long, short)
1565 Add mono sample at time given by first argument. The second
1566 argument give volume on both channels.
1568 10.5.3 Method readBlock(Block)
1570 Reads block of output (atomic versus addSample). Block structure
1571 has following fields which are filled:
1573 • timeBase: Time base for block.
1575 • baseLeft: Left volume at time base.
1577 • baseRight: Right volume at time base
1579 • blockNo: Sequence number of block filled.
1581 • samples: Number of samples in block
1583 • sampleTiming: Number of nanoseconds since last sample
1585 • sampleLeft: Left channel samples
1587 • sampleRight: Right channel samples
1589 10.6 Interface org.jpc.emulator.SoundOutputDevice
1591 Implementing this interface signals that module has audio output
1595 org.jpc.emulator.SoundOutputDevice.requestedSoundChannels()
1597 Return the number of sound channels module has.
1600 org.jpc.emulator.SoundOutputDevice.soundChannelCallback(SoundDigitalOut)
1602 This is called once per sound channel requested giving precreated
1605 10.7 Class org.jpc.emulator.PC method getSoundOut(String)
1607 Get sound output with specified name.
1609 11 Advanced: Writing event targets
1611 Whereas output connectors are the way output is dispatched, input
1612 is dispatched via event targets. Event targets need to implement
1613 interface org.jpc.emulator.EventDispatchTarget.
1615 Event targets also provode methods which then encode events and
1616 dispatch them forward (without doing anything else) to event
1617 recorder. Also, event targets may have methods for obtaining
1620 11.1 Interface org.jpc.emulator.EventDispatchTarget
1622 Interface that marks class capable of receiving events.
1624 11.1.1 Method setEventRecorder(EventRecorder)
1626 Set the event recorder input events are sent to.
1628 11.1.2 Method startEventCheck()
1630 Signals target to reset all state related to event checking and
1631 state feedback. This may be called at any time in order to
1632 reinitialialize event checking/feedback state.
1634 11.1.3 Method doEvent(long, String[], int) throws IOException
1636 Event dispatch handler. The first argument is event time, second
1637 is parameters and third is what to do with it. If target doesn't
1638 like the event, throw IOException. Following types (the integer
1639 parameter) are used:
1641 0 (EventRecorder.EVENT_TIMED): Time has been assigned for event.
1643 1 (EventRecorder.EVENT_STATE_EFFECT_FUTURE): Future event in
1644 event replay for reinitialization
1646 2 (EventRecorder.EVENT_STATE_EFFECT): Past event in event replay
1649 3 (EventRecorder.EVENT_EXECUTE): This event occurs now. Execute
1652 11.1.4 Method endEventCheock()
1654 End event reinitialization. Usually unused.
1656 11.1.5 Method getEventTimeLowBound(long, String[]) throws
1659 Return the time value that's the earliest possiblity for this
1660 event to occur. Returning any time in past (including -1) causes
1661 event to fire as soon as possible. The long parameter gives the
1662 current scheduled time for event.
1666 Modules are various extensions that run inside emulator core. As
1667 such, they affect sync. Modules must implement interface
1668 org.jpc.emulator.HardwareComponent (they are hardware components)
1669 and must be dumpable. Additionally, they need either constructor
1670 <init>() or <init>(String). The first is if no parameters are
1671 passed, the second is for case where parameters are passed.
1673 Aside of the constructors, modules need to obey the ordinary
1674 conventions for hardware components. No code outside modules
1675 needs to know that module exists.
1679 Plugins handle various UI tasks. They need to implement interface
1682 13.1 Interface org.jpc.pluginsbase.Plugin
1684 13.1.1 Method systemShutdown()
1686 Called when emulator shuts down. Either called in dedicated
1687 thread or in thread that called emulatorShutdown(). These
1688 handlers should do the bare minimum to get files on disk to
1689 consistent state. After these calls from all plugins have
1690 finished, emulator exits. Do not try to manipulate UI from these
1691 methods, as doing that easily leads into deadlock.
1693 13.1.2 Method reconnect(PC)
1695 Gives new PC to connect to. Null is passed if plugin should
1698 13.1.3 Method main()
1700 Called in dedicated thread after plugin is initialized.
1702 13.1.4 Method pcStopping()
1704 Called after PC has stopped.
1706 13.1.5 Method pcStarting()
1708 Called before PC starts.
1710 13.1.6 Method notifyArguments(String[])
1712 Pass arguments from command line.
1714 13.1.7 Constructor <init>(Plugins)
1716 This constructor is used to initialize plugins that don't take
1719 13.1.8 Constructor <init>(Plugins, String)
1721 This constructor is used to initialize plugins that take
1724 13.2 Class org.jpc.pluginsbase.Plugins
1726 This class provodes various methods for manipulating plugins.
1728 13.2.1 Method isShuttingDown()
1730 Returns true if Plugins.shutdownEmulator() has been called
1731 somehow, either via VM exit, CTRL+C or explicitly. Useful to skip
1732 cleanups involving GUI, as these are too deadlock-prone.
1734 13.2.2 Method shutdownEmulator()
1736 Shut down and exit the emulator. All plugin shutdown functions
1737 are called in this thread.
1739 13.2.3 Method reconnectPC(PC)
1741 Signal reconnectPC event to all plugins.
1743 13.2.4 Method pcStarted()
1745 Signal pcStarting() event to all plugins.
1747 13.2.5 Method pcStopped()
1749 Signal pcStopping() event to all plugins.
1751 14 Inter-plugin communication
1753 14.1 Receiving communications
1755 To receive invocation/call by name 'foo-bar', declare public
1756 method named 'eci_foo_bar'. Arguments to this method can
1757 currently be String, Integer (int) or Long (long). Last argument
1758 may be array over these types to get variable number of
1759 arguments. On call, each argument gets value from call. If last
1760 argument is array, it gets all overflowing arguments. If return
1761 type is void or method returns boolean false, call is assumed to
1762 have completed. If return value is boolean true, it is assumed
1763 that there is more processing.
1766 org.jpc.pluginsbase.Plugins.invokeExternalCommand(String cmd,
1769 Invoke command asynchronously, broadcasting to all plugins. Does
1770 not wait for slow commands to complete. cmd is the name to send
1771 and args are the arguments to pass.
1774 org.jpc.pluginsbase.Plugins.invokeExternalCommandSynchronous(String
1777 Same as invokeExternalCommand, but waits for slow commands to
1781 org.jpc.pluginsbase.Plugins.invokeExternalCommandReturn(String
1784 Similar to invokeExternalCommandSynchornous, but:
1786 • Quits calling more plugins when it gets successful reply.
1788 • Returns said reply
1790 14.5 void org.jpc.pluginsbase.Plugins.returnValue(Object... ret)
1792 Gives return value to return from call and signals that command
1795 14.6 void org.jpc.pluginsbase.Plugins.signalCommandCompletion()
1797 Signals that command has completed. Only needed if there is no
1798 return value and eci_ method returned false (not done yet).
1800 15 Lua kernel programming
1802 At startup, kernel gets its arguments in 'args' table and the
1803 script name to run in 'scriptname' string. It should enter the
1804 named script in protected mode.
1806 The Lua VM exports numerious callbacks to kernel. The kernel can
1807 then choose to omit, wrap or re-export these to Lua scripts.
1809 • Always grab any functions used into local variables so nobody
1812 • Don't use global variables in kernel (except for those passed).