README.MiNT
author Sam Lantinga <slouken@libsdl.org>
Mon, 10 Jun 2002 20:42:53 +0000
changeset 398 d219b0e02f5f
parent 319 189a6a3416c7
child 557 0ce5a68278fd
permissions -rw-r--r--
Added Atari audio support (thanks Patrice!)
slouken@281
     1
slouken@281
     2
==============================================================================
slouken@281
     3
Using the Simple DirectMedia Layer on Atari
slouken@281
     4
==============================================================================
slouken@281
     5
slouken@281
     6
==============================================================================
slouken@281
     7
I.  Building the Simple DirectMedia Layer libraries:
slouken@281
     8
    (This step isn't necessary if you have the SDL binary distribution)
slouken@281
     9
slouken@281
    10
  Do the classic configure, with --disable-shared --enable-static and:
slouken@281
    11
slouken@281
    12
    Tos version (should run everywhere):
slouken@398
    13
      --disable-threads
slouken@398
    14
    Tos does not support threads.
slouken@281
    15
slouken@281
    16
    MiNT version (maybe Magic, only for multitasking OS):
slouken@281
    17
      --disable-pthreads --enable-pth
slouken@281
    18
    Mint and Magic may supports threads, so audio can be used with current
slouken@281
    19
    devices, like Sun audio, or disk-writing support. Like Tos, interrupt
slouken@281
    20
    audio without threads is more suited for Atari machines.
slouken@281
    21
slouken@281
    22
  Then you can make ; make install it.
slouken@281
    23
slouken@281
    24
==============================================================================
slouken@281
    25
II. Building the Simple DirectMedia Layer test programs:
slouken@281
    26
slouken@281
    27
  Do the classic configure, then make.
slouken@281
    28
slouken@281
    29
  Run them !
slouken@281
    30
slouken@281
    31
==============================================================================
slouken@281
    32
III.  Enjoy! :)
slouken@281
    33
slouken@281
    34
  If you have a project you'd like me to know about, or want to ask questions,
slouken@281
    35
  go ahead and join the SDL developer's mailing list by sending e-mail to:
slouken@281
    36
slouken@281
    37
	sdl-request@libsdl.org
slouken@281
    38
slouken@281
    39
  and put "subscribe" into the subject of the message. Or alternatively you
slouken@281
    40
  can use the web interface:
slouken@281
    41
slouken@281
    42
	http://www.libsdl.org/mailman/listinfo/sdl
slouken@281
    43
  
slouken@281
    44
==============================================================================
slouken@281
    45
IV.  What is supported:
slouken@281
    46
slouken@319
    47
Keyboard (GEMDOS, BIOS, GEM, Ikbd)
slouken@281
    48
Mouse (XBIOS, GEM, Ikbd)
slouken@281
    49
Video (XBIOS (Fullscreen), GEM (Windowed and Fullscreen))
slouken@281
    50
Timer (VBL vector)
slouken@302
    51
Joystick and joypad support (Ikbd, Hardware)
slouken@398
    52
Audio support (Hardware, XBIOS, GSXB, /dev/audio if threads enabled)
slouken@398
    53
Threads support (Multitasking OS only via GNU pth library)
slouken@281
    54
slouken@281
    55
- What is missing:
slouken@281
    56
CDROM support (Metados, /dev/cdrom)
slouken@281
    57
slouken@281
    58
- Driver combinations:
slouken@302
    59
Video	Kbd	Mouse	Timer	Jstick	Joypads
slouken@302
    60
xbios	ikbd	ikbd	vbl	ikbd	hardware
slouken@305
    61
xbios	gemdos	xbios	vbl	xbios	hardware
slouken@305
    62
xbios	bios	xbios	vbl	xbios	hardware
slouken@319
    63
gem	gem	gem(*)	vbl	xbios	hardware
slouken@319
    64
slouken@319
    65
(*) GEM does not report relative mouse motion, so xbios mouse driver is used
slouken@319
    66
to report this type event.
slouken@281
    67
slouken@281
    68
==============================================================================
slouken@281
    69
V.  Environment variables:
slouken@281
    70
slouken@398
    71
SDL_VIDEODRIVER:
slouken@398
    72
	Set to 'xbios' to force xbios video driver
slouken@398
    73
	Set to 'gem' to force gem video driver
slouken@398
    74
slouken@398
    75
SDL_AUDIODRIVER:
slouken@398
    76
	Set to 'mint' to force Atari audio driver
slouken@398
    77
	Set to 'audio' to force Sun /dev/audio audio driver
slouken@398
    78
	Set to 'disk' to force disk-writing audio driver
slouken@398
    79
slouken@281
    80
SDL_ATARI_EVENTSDRIVER
slouken@281
    81
	Set to 'ikbd' to force IKBD 6301 keyboard driver
slouken@281
    82
	Set to 'gemdos' to force gemdos keyboard driver
slouken@281
    83
	Set to 'bios' to force bios keyboard driver
slouken@281
    84
slouken@302
    85
SDL_JOYSTICK_ATARI:
slouken@302
    86
	Use any of these strings in the environment variable to enable or
slouken@302
    87
	disable a joystick:
slouken@302
    88
slouken@305
    89
	'ikbd-joy1-[on|off]' for IKBD joystick on port 1 (hardware access)
slouken@305
    90
	'xbios-joy1-[on|off]' for IKBD joystick on port 1 (xbios access)
slouken@302
    91
	'porta-pad-[on|off]' for joypad on port A
slouken@302
    92
	'porta-joy0-[on|off]' for joystick 0 on port A
slouken@302
    93
	'porta-joy1-[on|off]' for joystick 1 on port A
slouken@302
    94
	'porta-lp-[on|off]' for lightpen on port A
slouken@302
    95
	'porta-anpad-[on|off]' for analog paddle on port A
slouken@302
    96
	'portb-pad-[on|off]' for joypad on port B
slouken@302
    97
	'portb-joy0-[on|off]' for joystick 0 on port B
slouken@302
    98
	'portb-joy1-[on|off]' for joystick 1 on port B
slouken@302
    99
	'portb-anpad-[on|off]' for analog paddle on port B
slouken@302
   100
slouken@302
   101
	Default configuration is:
slouken@302
   102
		'ikbd-joy1-on' (if IKBD events driver enabled)
slouken@305
   103
		'xbios-joy1-on' (if gemdos/bios/gem events driver enabled)
slouken@302
   104
		'porta-pad-on portb-pad-on' (if available on the machine)
slouken@302
   105
slouken@302
   106
	port[a|b]-[pad|joy?|lp|anpad]-* strings are mutually exclusives.
slouken@302
   107
	On such a port, you can only use a joypad OR 1 or 2 joysticks OR
slouken@302
   108
	a lightpen OR an analog paddle. You must disable joypad before
slouken@302
   109
	setting another controller.
slouken@302
   110
slouken@302
   111
	The second joystick port on IKBD is used by the mouse, so not usable.
slouken@302
   112
slouken@302
   113
	Joypads are multibuttons controller (Atari Jaguar console-like).
slouken@302
   114
	Joysticks are 1 button, 2 axis controllers.
slouken@302
   115
	Lightpen and analog paddle are 2 buttons, 2 axis controllers. The 2
slouken@302
   116
	buttons are those affected to 1 button joysticks on the same port.
slouken@302
   117
slouken@319
   118
==============================================================================
slouken@319
   119
VI.  More informations about drivers:
slouken@319
   120
slouken@319
   121
Xbios video:
slouken@319
   122
	Video chip is detected using the _VDO cookie.
slouken@319
   123
	Screen enhancers are not supported, but could be if you know how to
slouken@319
   124
	use them.
slouken@319
   125
slouken@319
   126
	ST, STE, Mega ST, Mega STE:
slouken@319
   127
		320x200x4 bits, shades of grey, available only for the purpose
slouken@319
   128
		of testing SDL.
slouken@319
   129
	TT:
slouken@319
   130
		320x480x8 and 320x240x8 (software double-lined mode).
slouken@319
   131
	Falcon:
slouken@319
   132
		All modes supported by the current monitor (RVB or VGA).
slouken@319
   133
	Clones and any machine with monochrome monitor:
slouken@319
   134
		Not supported.
slouken@319
   135
slouken@319
   136
Gem video:
slouken@319
   137
	Automatically used if xbios not available.
slouken@319
   138
slouken@319
   139
	All machines:
slouken@319
   140
		Only the current resolution, if 8 bits or higher depth.
slouken@319
   141
slouken@319
   142
IKBD keyboard, mouse and joystick driver:
slouken@319
   143
	Available if _MCH cookie is ST, Mega ST, STE, Mega STE, TT or Falcon.
slouken@319
   144
slouken@319
   145
	Hades has an IKBD, but xbios is not available for video, so IKBD
slouken@319
   146
	driver is disabled.
slouken@319
   147
slouken@319
   148
Gemdos and bios keyboard driver:
slouken@319
   149
	Available on all machines.
slouken@319
   150
slouken@319
   151
Mouse and joystick xbios driver:
slouken@319
   152
	Available on all machines (I think).
slouken@319
   153
slouken@319
   154
Joypad driver:
slouken@319
   155
	Available if _MCH cookie is STE or Falcon.
slouken@319
   156
slouken@319
   157
VBL timer driver:
slouken@398
   158
	Available on all machines (I think).
slouken@398
   159
slouken@398
   160
Audio driver:
slouken@398
   161
	Cookie _SND is used to detect supported audio capabilities
slouken@398
   162
slouken@398
   163
	STE, Mega STE, TT:
slouken@398
   164
		8 bits DMA (hardware access)
slouken@398
   165
slouken@398
   166
	Falcon, machines with GSXB driver:
slouken@398
   167
		Xbios functions
slouken@398
   168
slouken@398
   169
	Other machines:
slouken@398
   170
		Not supported
slouken@319
   171
slouken@281
   172
-- 
slouken@281
   173
Patrice Mandin <pmandin@caramail.com>
slouken@314
   174
http://membres.lycos.fr/pmandin/