README.MiNT
author Sam Lantinga <slouken@libsdl.org>
Sun, 04 Jan 2004 16:49:27 +0000
changeset 769 b8d311d90021
parent 724 6b3dfe0198bb
child 963 92c247cec42d
permissions -rw-r--r--
Updated copyright information for 2004 (Happy New Year!)
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@557
    50
Timer (VBL vector, GNU pth library)
patmandin@724
    51
Joystick and joypad (Ikbd, Hardware)
patmandin@724
    52
Audio (Hardware, XBIOS, GSXB, MCSN, STFA, /dev/audio if threads enabled)
patmandin@724
    53
Threads (Multitasking OS only via GNU pth library)
patmandin@724
    54
Shared object loader (using LDG library from http://ldg.atari.org/)
patmandin@724
    55
Audio CD (MetaDOS)
slouken@281
    56
slouken@281
    57
- Driver combinations:
patmandin@644
    58
Video	Kbd	Mouse	Timer	Joystick
patmandin@644
    59
xbios	ikbd	ikbd	vbl(2)	ikbd
patmandin@644
    60
xbios	gemdos	xbios	vbl(2)	xbios
patmandin@644
    61
xbios	bios	xbios	vbl(2)	xbios
patmandin@644
    62
gem	gem	gem(1)	vbl(2)	xbios
slouken@319
    63
slouken@557
    64
(1) GEM does not report relative mouse motion, so xbios mouse driver is used
slouken@319
    65
to report this type event.
slouken@281
    66
slouken@557
    67
(2) If you build SDL with threads using the GNU pth library, timers are
slouken@557
    68
supported via the pth library.
slouken@557
    69
slouken@281
    70
==============================================================================
slouken@281
    71
V.  Environment variables:
slouken@281
    72
slouken@398
    73
SDL_VIDEODRIVER:
slouken@398
    74
	Set to 'xbios' to force xbios video driver
slouken@398
    75
	Set to 'gem' to force gem video driver
slouken@398
    76
slouken@398
    77
SDL_AUDIODRIVER:
patmandin@644
    78
	Set to 'mint_gsxb' to force Atari GSXB audio driver
patmandin@644
    79
	Set to 'mint_mcsn' to force Atari MCSN audio driver
patmandin@644
    80
	Set to 'mint_stfa' to force Atari STFA audio driver
patmandin@644
    81
	Set to 'mint_xbios' to force Atari Xbios audio driver
patmandin@644
    82
	Set to 'mint_dma8' to force Atari 8 bits DMA audio driver
slouken@398
    83
	Set to 'audio' to force Sun /dev/audio audio driver
slouken@398
    84
	Set to 'disk' to force disk-writing audio driver
slouken@398
    85
slouken@281
    86
SDL_ATARI_EVENTSDRIVER
slouken@281
    87
	Set to 'ikbd' to force IKBD 6301 keyboard driver
slouken@281
    88
	Set to 'gemdos' to force gemdos keyboard driver
slouken@281
    89
	Set to 'bios' to force bios keyboard driver
slouken@281
    90
slouken@302
    91
SDL_JOYSTICK_ATARI:
slouken@302
    92
	Use any of these strings in the environment variable to enable or
slouken@302
    93
	disable a joystick:
slouken@302
    94
slouken@305
    95
	'ikbd-joy1-[on|off]' for IKBD joystick on port 1 (hardware access)
slouken@305
    96
	'xbios-joy1-[on|off]' for IKBD joystick on port 1 (xbios access)
slouken@302
    97
	'porta-pad-[on|off]' for joypad on port A
slouken@302
    98
	'porta-joy0-[on|off]' for joystick 0 on port A
slouken@302
    99
	'porta-joy1-[on|off]' for joystick 1 on port A
slouken@302
   100
	'porta-lp-[on|off]' for lightpen on port A
slouken@302
   101
	'porta-anpad-[on|off]' for analog paddle on port A
slouken@302
   102
	'portb-pad-[on|off]' for joypad on port B
slouken@302
   103
	'portb-joy0-[on|off]' for joystick 0 on port B
slouken@302
   104
	'portb-joy1-[on|off]' for joystick 1 on port B
slouken@302
   105
	'portb-anpad-[on|off]' for analog paddle on port B
slouken@302
   106
slouken@302
   107
	Default configuration is:
slouken@302
   108
		'ikbd-joy1-on' (if IKBD events driver enabled)
slouken@305
   109
		'xbios-joy1-on' (if gemdos/bios/gem events driver enabled)
slouken@302
   110
		'porta-pad-on portb-pad-on' (if available on the machine)
slouken@302
   111
slouken@302
   112
	port[a|b]-[pad|joy?|lp|anpad]-* strings are mutually exclusives.
slouken@302
   113
	On such a port, you can only use a joypad OR 1 or 2 joysticks OR
slouken@302
   114
	a lightpen OR an analog paddle. You must disable joypad before
slouken@302
   115
	setting another controller.
slouken@302
   116
slouken@302
   117
	The second joystick port on IKBD is used by the mouse, so not usable.
slouken@302
   118
slouken@302
   119
	Joypads are multibuttons controller (Atari Jaguar console-like).
slouken@302
   120
	Joysticks are 1 button, 2 axis controllers.
slouken@302
   121
	Lightpen and analog paddle are 2 buttons, 2 axis controllers. The 2
slouken@302
   122
	buttons are those affected to 1 button joysticks on the same port.
slouken@302
   123
slouken@319
   124
==============================================================================
slouken@319
   125
VI.  More informations about drivers:
slouken@319
   126
slouken@319
   127
Xbios video:
slouken@319
   128
	Video chip is detected using the _VDO cookie.
slouken@319
   129
	Screen enhancers are not supported, but could be if you know how to
slouken@319
   130
	use them.
slouken@319
   131
slouken@319
   132
	ST, STE, Mega ST, Mega STE:
slouken@319
   133
		320x200x4 bits, shades of grey, available only for the purpose
slouken@319
   134
		of testing SDL.
slouken@319
   135
	TT:
slouken@319
   136
		320x480x8 and 320x240x8 (software double-lined mode).
slouken@319
   137
	Falcon:
slouken@319
   138
		All modes supported by the current monitor (RVB or VGA).
slouken@319
   139
	Clones and any machine with monochrome monitor:
slouken@319
   140
		Not supported.
slouken@319
   141
slouken@319
   142
Gem video:
slouken@319
   143
	Automatically used if xbios not available.
slouken@319
   144
slouken@319
   145
	All machines:
slouken@319
   146
		Only the current resolution, if 8 bits or higher depth.
slouken@319
   147
slouken@319
   148
IKBD keyboard, mouse and joystick driver:
slouken@319
   149
	Available if _MCH cookie is ST, Mega ST, STE, Mega STE, TT or Falcon.
slouken@319
   150
slouken@319
   151
	Hades has an IKBD, but xbios is not available for video, so IKBD
slouken@319
   152
	driver is disabled.
slouken@319
   153
slouken@319
   154
Gemdos and bios keyboard driver:
slouken@319
   155
	Available on all machines.
slouken@319
   156
slouken@319
   157
Mouse and joystick xbios driver:
slouken@319
   158
	Available on all machines (I think).
slouken@319
   159
slouken@319
   160
Joypad driver:
slouken@319
   161
	Available if _MCH cookie is STE or Falcon.
slouken@319
   162
slouken@557
   163
PTH timer driver:
slouken@557
   164
	Available with multitasking OS.
slouken@557
   165
slouken@319
   166
VBL timer driver:
slouken@398
   167
	Available on all machines (I think).
slouken@398
   168
patmandin@644
   169
Audio drivers:
patmandin@644
   170
	Cookies _SND, MCSN, STFA and GSXB used to detect supported audio
patmandin@644
   171
	capabilities.
slouken@398
   172
slouken@398
   173
	STE, Mega STE, TT:
slouken@398
   174
		8 bits DMA (hardware access)
patmandin@644
   175
		STFA, MCSN or GSXB driver if installed
patmandin@644
   176
	Falcon:
patmandin@644
   177
		8 bits DMA (hardware access)
patmandin@644
   178
		Xbios functions
patmandin@644
   179
		STFA, MCSN or GSXB driver if installed
patmandin@644
   180
	Other machines:
patmandin@644
   181
		STFA, MCSN or GSXB driver if installed
slouken@398
   182
patmandin@644
   183
	STFA driver:
patmandin@644
   184
		http://removers.free.fr/softs/stfa.html
patmandin@644
   185
	GSXB driver:
patmandin@644
   186
		http://assemsoft.atari.org/gsxb/
patmandin@644
   187
	MacSound driver:
patmandin@644
   188
		http://jf.omnis.ch/software/tos/
patmandin@644
   189
	MagicSound driver (MCSN,GSXB compatible):
patmandin@644
   190
		http://perso.wanadoo.fr/didierm/
patmandin@644
   191
	X-Sound driver (GSXB compatible):
patmandin@644
   192
		http://www.uni-ulm.de/~s_thuth/atari/xsound_e.html
slouken@319
   193
slouken@281
   194
-- 
slouken@281
   195
Patrice Mandin <pmandin@caramail.com>
slouken@314
   196
http://membres.lycos.fr/pmandin/