1 |
|
|
2 |
< |
Basilisk II, Version 0.7 |
3 |
< |
A free, portable Mac II emulator |
2 |
> |
Basilisk II, Version 0.8 |
3 |
> |
A 68k Macintosh emulator |
4 |
|
|
5 |
< |
Copyright (C) 1997-1999 Christian Bauer et al. |
6 |
< |
Freely distributable |
5 |
> |
Copyright (C) 1997-2001 Christian Bauer et al. |
6 |
|
|
7 |
|
|
8 |
|
License |
15 |
|
Overview |
16 |
|
-------- |
17 |
|
|
18 |
< |
Basilisk II is a free, portable, Open Source 68k Mac emulator. It requires |
19 |
< |
a copy of a Mac ROM and a copy of MacOS to run. Basilisk II is freeware and |
20 |
< |
distributed under the GNU General Public License. |
18 |
> |
Basilisk II is an Open Source 68k Macintosh emulator. That is, it enables |
19 |
> |
you to run 68k MacOS software on you computer, even if you are using a |
20 |
> |
different operating system. However, you still need a copy of MacOS and |
21 |
> |
a Macintosh ROM image to use Basilisk II. |
22 |
|
|
23 |
|
Basilisk II has currently been ported to the following systems: |
24 |
|
- BeOS R4 (PowerPC and x86) |
25 |
< |
- Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x and IRIX 6.5) |
25 |
> |
- Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x, NetBSD 1.4.2 and |
26 |
> |
IRIX 6.5) |
27 |
|
- AmigaOS 3.x |
28 |
|
- Windows NT 4.0 (mostly works under Windows 95/98, too) |
29 |
|
|
36 |
|
- Floppy disk driver (only 1.44MB disks supported) |
37 |
|
- Driver for HFS partitions and hardfiles |
38 |
|
- CD-ROM driver with basic audio functions |
39 |
+ |
- Easy file exchange with the host OS via a "Host Directory Tree" icon |
40 |
+ |
on the Mac desktop |
41 |
|
- Ethernet driver |
42 |
|
- Serial drivers |
43 |
|
- SCSI Manager (old-style) emulation |
44 |
|
- Emulates extended ADB keyboard and 3-button mouse |
45 |
< |
- Uses UAE 68k emulation or (under AmigaOS) real 68k processor |
45 |
> |
- Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k |
46 |
> |
processor |
47 |
|
|
48 |
|
The emulator is not yet complete. See the file "TODO" for a list of |
49 |
|
unimplemented stuff. |
141 |
|
installed CD-ROM drives. The format of the "CD-ROM drive description" |
142 |
|
is the same as that of "disk" lines. |
143 |
|
|
144 |
+ |
extfs <direcory path> |
145 |
+ |
|
146 |
+ |
This item specifies the root directory for the "Host Directory Tree" |
147 |
+ |
file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop). |
148 |
+ |
All objects contained in that directory are accessible by Mac applications. |
149 |
+ |
This feature is only available when File System Manager V1.2 or later |
150 |
+ |
is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6 |
151 |
+ |
and can be installed as a system extension (downloadable from Apple, look |
152 |
+ |
for the FSM SDK in the developer section) for earlier MacOS versions. |
153 |
+ |
|
154 |
|
scsi0 <SCSI target> ... scsi6 <SCSI target> |
155 |
|
|
156 |
|
These items describe the SCSI target to be used for a given Mac SCSI |
180 |
|
"scsi.device/2"). |
181 |
|
|
182 |
|
Windows: |
183 |
< |
Ignored. Basilisk II scans for all SCSI devices and the first 6 found |
184 |
< |
devices are made visible to the MacOS. You cannot explicitly enable a |
171 |
< |
device, but you can disable a device (see the "disablescsi" command). |
183 |
> |
The "SCSI target" has the format <"Vendor"> <"Model"> (e.g. |
184 |
> |
scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes. |
185 |
|
|
186 |
|
screen <video mode> |
187 |
|
|
212 |
|
(8/15/24 bit) depends on the depth of the underlying X11 screen. |
213 |
|
This is the default. |
214 |
|
dga/<width>/<height> |
215 |
< |
Full-screen display using the X11 DGA extensions. The color depth |
215 |
> |
[if Basilisk II was configured with --enable-xf86-dga] |
216 |
> |
Full-screen display using the XFree86 DGA extension. The color depth |
217 |
|
(8/15/24 bit) depends on the depth of the underlying X11 screen. |
218 |
|
"width" and "height" specify the maximum width/height to use. |
219 |
< |
Saying "dga/0/0" means "complete screen". For DGA to work, Basilisk II |
220 |
< |
must be compiled with DGA support enabled (selectable in the configure |
221 |
< |
script). |
219 |
> |
Saying "dga/0/0" means "complete screen". |
220 |
> |
dga/<frame buffer name> |
221 |
> |
[if Basilisk II was configured with --enable-fbdev-dga] |
222 |
> |
Full-screen display using the frame buffer device /dev/fb. The color |
223 |
> |
depth (8/15/24 bit) depends on the depth of the underlying X11 screen. |
224 |
> |
The "frame buffer name" is looked up in the "fbdevices" file (whose |
225 |
> |
path can be specified with the "fbdevicefile" prefs item) to determine |
226 |
> |
certain characteristics of the device (doing a "ls -l /dev/fb" should |
227 |
> |
tell you what your frame buffer name is). |
228 |
|
|
229 |
|
AmigaOS: |
230 |
|
The "video mode" is one of the following: |
236 |
|
15-bit truecolor display in a Picasso96 PIP. This requires |
237 |
|
Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV). |
238 |
|
scr/<hexadecimal mode ID> |
239 |
< |
8/15/24-bit fullscreen display on a Picasso96 screen with the given |
240 |
< |
mode ID. This requires Picasso96. For 15 and 24 bit, the frame buffer |
241 |
< |
format must be QuickDraw-compatible (big-endian, xRGB 1:5:5:5 or |
242 |
< |
xRGB 8:8:8:8). The screen size will be the default size for that |
243 |
< |
mode ID. |
239 |
> |
8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with |
240 |
> |
the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and |
241 |
> |
24 bit, the frame buffer format must be QuickDraw-compatible |
242 |
> |
(big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be |
243 |
> |
the default size for that mode ID. |
244 |
|
|
245 |
|
Windows: |
246 |
|
The "video mode" is one of the following: |
334 |
|
Linux: |
335 |
|
The "ethernet card description" is the name of an Ethernet interface. |
336 |
|
There are two approaches to networking with Basilisk II: |
337 |
+ |
|
338 |
|
1. Direct access to an Ethernet card via the "sheep_net" driver. |
339 |
|
In this case, the "ethernet card description" must be the name |
340 |
|
of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net" |
344 |
|
networking. MacOS will only be able to talk to other machines on |
345 |
|
the Ethernet, but not to other networks that your Linux box routes |
346 |
|
(e.g. a second Ethernet or a PPP connection to the Internet). |
347 |
+ |
|
348 |
|
2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device. |
349 |
|
In this case, the "ethernet card description" must be the name |
350 |
|
of an ethertap interface, e.g. "tap0". It also requires that you |
351 |
|
configure your kernel to enable routing and the ethertap device: |
352 |
|
under "Networking options", enable "Kernel/User netlink socket" and |
353 |
|
"Netlink device emulation", under "Network device support", activate |
354 |
< |
"Ethertap network tap". Next, see /usr/src/linux/Documentation/ |
355 |
< |
networking/ethertap.txt for information on how to set up /dev/tap* |
356 |
< |
device nodes and activate the ethertap interface. Under MacOS, |
357 |
< |
select an IP address that is on the virtual network and set the |
358 |
< |
default gateway to the IP address of the ethertap interface. This |
359 |
< |
approach will let you access all networks that your Linux box has |
360 |
< |
access to (especially, if your Linux box has a dial-up Internet |
361 |
< |
connection and is configured for IP masquerading, you can access |
362 |
< |
the Internet from MacOS). The drawback is that you can only use |
363 |
< |
network protocols that Linux can route, so you have to install and |
364 |
< |
configure netatalk if you want to use AppleTalk. |
354 |
> |
"Ethertap network tap". You also have to modify drivers/net/ethertap.c |
355 |
> |
a bit before compiling the new kernel: |
356 |
> |
|
357 |
> |
- insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the |
358 |
> |
#include lines) |
359 |
> |
- comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe() |
360 |
> |
|
361 |
> |
Next, see /usr/src/linux/Documentation/networking/ethertap.txt for |
362 |
> |
information on how to set up /dev/tap* device nodes and activate the |
363 |
> |
ethertap interface. Under MacOS, select an IP address that is on the |
364 |
> |
virtual network and set the default gateway to the IP address of the |
365 |
> |
ethertap interface. This approach will let you access all networks |
366 |
> |
that your Linux box has access to (especially, if your Linux box has |
367 |
> |
a dial-up Internet connection and is configured for IP masquerading, |
368 |
> |
you can access the Internet from MacOS). The drawback is that you |
369 |
> |
can only use network protocols that Linux can route, so you have to |
370 |
> |
install and configure netatalk if you want to use AppleTalk. Here is |
371 |
> |
an example /etc/atalk/atalkd.conf for a LAN: |
372 |
> |
|
373 |
> |
eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet" |
374 |
> |
tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet" |
375 |
> |
|
376 |
> |
(the "47" is an arbitrary node number). This will set up a zone |
377 |
> |
"Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2) |
378 |
> |
for the internal network connection of the ethertap interface. |
379 |
> |
MacOS should automatically recognize the nets and zones upon startup. |
380 |
> |
If you are in an existing AppleTalk network, you should contact |
381 |
> |
your network administrator about the nets and zones you can use |
382 |
> |
(instead of the ones given in the example above). |
383 |
|
|
384 |
|
AmigaOS: |
385 |
|
You have to specify the name of the SANA-II Ethernet device and the device |
416 |
|
For refreshed graphics modes (usually window modes), this specifies |
417 |
|
how many frames to skip after drawing one frame. Higher values make |
418 |
|
the video display more responsive but require more processing power. |
419 |
< |
The default is "8". |
419 |
> |
The default is "8". Under Unix/X11, a value of "0" selects a "dynamic" |
420 |
> |
update mode that cuts the display into rectangles and updates each |
421 |
> |
rectangle individually, depending on display changes. |
422 |
|
|
423 |
|
modelid <MacOS model ID> |
424 |
|
|
457 |
|
Unix: |
458 |
|
|
459 |
|
keycodes <"true" or "false"> |
460 |
< |
keycodefile <Keycode file path> |
460 |
> |
keycodefile <keycodes file path> |
461 |
|
|
462 |
|
By default, the X11 event handler in Basilisk II uses KeySyms to |
463 |
|
translate keyboard event to Mac keycodes. While this method is very |
468 |
|
not on the selected keymap. Unfortunately it depends on the X server |
469 |
|
being used and possibly also on the type of keyboard attached. So |
470 |
|
Basilisk II needs a table to translate X keycodes to Mac keycodes. |
471 |
< |
This table is read by default from /usr/local/lib/basilisk_ii_keycodes |
471 |
> |
This table is read by default from /usr/local/share/BasiliskII/keycodes |
472 |
|
unless you specify a different file with the "keycodefile" item. |
473 |
< |
A sample keycode file ("basilisk_ii_keycodes") is included with |
474 |
< |
Basilisk II. |
473 |
> |
A sample keycode file is included with Basilisk II. |
474 |
> |
|
475 |
> |
fbdevicefile <fbdevices file path> |
476 |
> |
|
477 |
> |
This option specifies the file that contains frame buffer device |
478 |
> |
specifications for the fbdev-DGA video mode (when Basilisk II was |
479 |
> |
configured with --enable-fbdev-dga). The default location of the file |
480 |
> |
is /usr/local/share/BasiliskII/fbdevices. A sample file is included |
481 |
> |
with Basilisk II. |
482 |
> |
|
483 |
> |
mousewheelmode <mode> |
484 |
> |
|
485 |
> |
If you have a mouse with a wheel, this option specifies whether moving |
486 |
> |
the wheel will be reported to the MacOS as "Page up/down" (mode 0) or |
487 |
> |
"Cursor up/down" (mode 1) keys. |
488 |
> |
|
489 |
> |
mousewheellines <number of lines> |
490 |
> |
|
491 |
> |
If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets |
492 |
> |
the number of key events sent to MacOS for each wheel movement (the |
493 |
> |
number of lines to scroll). |
494 |
|
|
495 |
|
AmigaOS: |
496 |
|
|
531 |
|
|
532 |
|
Note the use of quotes. |
533 |
|
|
534 |
< |
disablescsi <"Vendor"> <"Model"> |
534 |
> |
rightmouse <0/1> |
535 |
|
|
536 |
< |
Disables this vendor/model combination. You may need this simply because |
537 |
< |
you have more than 6 SCSI devices, or the particular device has problems |
538 |
< |
under BasiliskII. E.g. |
536 |
> |
Defines what the right mouse button is used for. The default values of 0 |
537 |
> |
means that it is used to move windowed mode BasiliskII screen. |
538 |
> |
Value 1 sends a combination Control and mouse click to the MacOS. |
539 |
> |
This may be useful under OS versions 8 and above. |
540 |
|
|
541 |
< |
disablescsi "HP" "CD-Writer+ 7100" |
542 |
< |
|
543 |
< |
Again, note the use of quotes. |
541 |
> |
keyboardfile <path> |
542 |
> |
|
543 |
> |
Defines the path of the customized keyboard code file. |
544 |
> |
|
545 |
> |
pollmedia <"true" or "false"> |
546 |
> |
|
547 |
> |
If true (default), tries to automatically detect new media. |
548 |
> |
Applies to all "floppy", "cd" or "disk" removable media except |
549 |
> |
1.44 MB floppies. May cause modest slow down. If unchecked, |
550 |
> |
use Ctrl-Shift-F11 to manually mount new media. |
551 |
> |
If you have auto-insert notification (AIN) enabled, you may turn this |
552 |
> |
option off. Note that some CD related software require AIN, |
553 |
> |
and some other need it to be turned off. Consult the documentation |
554 |
> |
of your CD software to learn which one is optimal for you. |
555 |
> |
|
556 |
> |
framesleepticks <milliseconds> |
557 |
> |
|
558 |
> |
The amount of time between video frames. |
559 |
> |
|
560 |
> |
showfps <true/false> |
561 |
> |
|
562 |
> |
If true, the real frame rate is displayed. |
563 |
> |
|
564 |
> |
stickymenu <true/false> |
565 |
> |
|
566 |
> |
If true, the main menu bar is kept open even after the mouse button is released, |
567 |
> |
under all OS versions (OS 8 has this feature already). There are extensions to do |
568 |
> |
the same thing, but it's faster to handle this in native code. |
569 |
> |
Default is "true". |
570 |
|
|
571 |
|
ntdx5hack <"true" or "false"> |
572 |
|
|
658 |
|
Acknowledgements |
659 |
|
---------------- |
660 |
|
|
661 |
< |
Contributions by: |
574 |
< |
- Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation |
575 |
< |
- Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code |
576 |
< |
and networking |
577 |
< |
- Lauri Pesonen <lpesonen@nic.fi>: Windows NT port |
661 |
> |
Contributions by (in alphabetical order): |
662 |
|
- Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support |
663 |
< |
- Brian J. Johnson <bjohnson@sgi.com>: IRIX support |
663 |
> |
- Gwenole Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations and |
664 |
> |
fbdev video code |
665 |
|
- Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support |
666 |
+ |
- Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code |
667 |
+ |
and networking |
668 |
|
- Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11 |
669 |
|
window support |
670 |
+ |
- Brian J. Johnson <bjohnson@sgi.com>: IRIX support |
671 |
+ |
- Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support |
672 |
+ |
- Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code |
673 |
|
- David Lawrence <davidl@jlab.org>: incremental window refresh code |
674 |
+ |
- Lauri Pesonen <lpesonen@nic.fi>: Windows NT port |
675 |
+ |
- Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation |
676 |
+ |
- and others... |
677 |
|
|
678 |
|
Special thanks to: |
679 |
|
- Bernd Schmidt for letting me use his UAE 68k emulation |