Initial commit (a clone of the jsmachines project as of v1.15.3)
This commit is contained in:
jeffpar
commit
a5e3e6a59d
714 changed files with 130602 additions and 0 deletions
124
apps/README.md
Normal file
124
apps/README.md
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
Application Archives
|
||||
---
|
||||
Browse classic [IBM PC](pc/) and [Challenger 1P](c1p/) software that you can run with [PCjs](/docs/about/pcjs/)
|
||||
and [C1Pjs](/docs/c1pjs/).
|
||||
|
||||
### Software Application Manifests
|
||||
|
||||
Every complete software package is stored in its own folder, either as a set of individual files
|
||||
(under [/apps](/apps/)) or as a set of disk images (under [/disks](/disks/)), along with a **manifest.xml**
|
||||
file that describes the software. The manifest format is still being developed, but at a minimum, it
|
||||
should contain the following information about the software:
|
||||
|
||||
- Title
|
||||
- Version
|
||||
- Type (eg, Application, Game, OS, Diagnostic, Utility, etc)
|
||||
- Category (eg, Productivity, Text Adventure, BASIC Compiler, etc)
|
||||
- Company (eg, IBM, Microsoft, etc)
|
||||
- Creation Date (of first version)
|
||||
- Release Date (of this version, if different from creation date)
|
||||
- Creator(s) (of first version)
|
||||
- Author(s) (of this version, if different from creator(s))
|
||||
- Contributors(s) (names of additional contributor(s) to this version)
|
||||
- Publisher (name of publisher, if different from company)
|
||||
- License (with link to current software license, if any)
|
||||
- Machine (reference to PCjs machine.xml file capable of loading/running the software)
|
||||
- Disk(s) (one or more entries describing sets of files and/or disk images)
|
||||
|
||||
The distinctions made by Type and Category are a bit aribitrary and likely to change. For now,
|
||||
Type is merely a reflection of how we initially filed the software (eg, under [/diags](/disks/pc/diags/),
|
||||
[/games](/disks/pc/games/), [/tools](/disks/pc/tools/), etc), while Category provides more detail.
|
||||
|
||||
### Example: VisiCalc
|
||||
|
||||
VisiCalc is stored in an [/apps folder](/apps/pc/1981/visicalc/), and two relevant files are
|
||||
described by <file> entries in its [manifest](/apps/pc/1981/visicalc/manifest.xml):
|
||||
|
||||
<manifest>
|
||||
<title>VisiCalc</title>
|
||||
<version>VC-176Y2-IBM-TEST</version>
|
||||
<type>Application</type>
|
||||
<category>Productivity</category>
|
||||
<company>Software Arts</company>
|
||||
<releaseDate>December 16, 1981</releaseDate>
|
||||
<machine href="/configs/pc/machines/5150/mda/64kb/machine.xml" state="/apps/pc/1981/visicalc/state.json"/>
|
||||
<disk id="disk" dir="/apps/pc/1981/visicalc/bin/">
|
||||
<file>VC.COM</file>
|
||||
<file dir="../">README.md</file>
|
||||
<link href="http://www.bricklin.com/history/vclicense.htm">VisiCalc License</link>
|
||||
</disk>
|
||||
</manifest>
|
||||
|
||||
Since this [manifest](/apps/pc/1981/visicalc/manifest.xml) also contains a <machine> entry,
|
||||
the default manifest stylesheet will automatically load and launch the associated
|
||||
[PCjs machine](/configs/pc/machines/5150/mda/64kb/machine.xml). The machine will boot or resume according
|
||||
to its own <[computer](/docs/pcjs/computer/)> settings, unless the manifest overrides the machine's
|
||||
default state with its own *state* setting; eg:
|
||||
|
||||
<machine href="/configs/pc/machines/5150/mda/64kb/machine.xml" state="/apps/pc/1981/visicalc/state.json"/>
|
||||
|
||||
The machine.xml file, in turn, refers to a [sample set](/configs/pc/disks/samples.xml) of disk images, one of which is:
|
||||
|
||||
<manifest ref="/apps/pc/1981/visicalc/manifest.xml" disk="*"/>
|
||||
|
||||
which refers to the <disk> entry in the VisiCalc manifest -- which brings us full circle.
|
||||
|
||||
Since that <disk> entry is just a reference to a folder, PCjs must first convert it to a disk image,
|
||||
using the following API request:
|
||||
|
||||
http://www.pcjs.org/api/v1/dump?path=/apps/pc/1981/visicalc/bin/VC.COM;../README.md&format=json
|
||||
|
||||
The PCjs `diskdump` module processes the dump request and generates a JSON-encoded DOS 2.x-compatible disk image
|
||||
containing all the specified files.
|
||||
|
||||
However, to avoid the PCjs web server re-generating the same disk image for every user-initiated disk load, we
|
||||
have saved that JSON-encoded image as static file on the server, and then added an *href* attribute to the manifest's
|
||||
<disk> entry:
|
||||
|
||||
<manifest>
|
||||
<disk id="disk01" dir="/apps/pc/1981/visicalc/private/" href="/apps/pc/1981/visicalc/disk.json">
|
||||
...
|
||||
</disk>
|
||||
</manifest>
|
||||
|
||||
PCjs always prefers a resource specified by *href*. While the <file> entries are now superfluous, they
|
||||
still serve to document the contents of the disk image, and are still necessary if the disk image ever needs to
|
||||
be re-generated.
|
||||
|
||||
### Example: CP/M-86
|
||||
|
||||
CPM-86 is stored as two disk images in a [/disks folder](/disks/pc/cpm/). The disk images are described in that
|
||||
folder's [manifest](/disks/pc/cpm/manifest.xml):
|
||||
|
||||
<manifest>
|
||||
<title>CP/M-86</title>
|
||||
<version>1.1B</version>
|
||||
<type>OS</type>
|
||||
<category>Operating System</category>
|
||||
<company href="http://en.wikipedia.org/wiki/Digital_Research">Digital Research</company>
|
||||
<publisher href="http://en.wikipedia.org/wiki/Eagle_Computer">Eagle Computer</publisher>
|
||||
<releaseDate>May 20, 1983</releaseDate>
|
||||
<machine href="/disks/pc/cpm/machine.xml"/>
|
||||
<disk id="disk01" href="/disks/pc/cpm/cpm86-disk1.json">
|
||||
<name>CP/M-86 (Disk 1)</name>
|
||||
</disk>
|
||||
<disk id="disk02" href="/disks/pc/cpm/cpm86-disk2.json">
|
||||
<name>CP/M-86 (Disk 2)</name>
|
||||
</disk>
|
||||
</manifest>
|
||||
|
||||
In this case, the software was "born" as disk images (non-DOS disk images at that), so we don't
|
||||
bother listing the contents of those images with <file> entries inside the <disk> entries.
|
||||
|
||||
We do, however, include optional <name> entries that help describe (or at least differentiate)
|
||||
the disk images.
|
||||
|
||||
If a machine file wanted to use only the first disk, then it would specify:
|
||||
|
||||
<manifest ref="/disks/pc/cpm/manifest.xml" disk="disk01"/>
|
||||
|
||||
and if it wanted to use all the disks listed in the manifest, it would specify:
|
||||
|
||||
<manifest ref="/disks/pc/cpm/manifest.xml" disk="*"/>
|
||||
|
||||
which is what our [CP/M Machine Configuration](/disks/pc/cpm/machine.xml) does.
|
||||
Loading…
Reference in a new issue