README.MiNT
author Sam Lantinga <slouken@libsdl.org>
Wed, 15 Dec 2004 01:02:20 +0000
changeset 1014 cfcb2e1c36eb
parent 1007 335d9376a2cd
child 1042 0e7218843cfb
permissions -rw-r--r--
Added change log notes
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@963
    51
Joysticks and joypads (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)
patmandin@978
    56
OpenGL (using Mesa offscreen rendering driver)
slouken@281
    57
slouken@281
    58
- Driver combinations:
patmandin@978
    59
Video   Kbd     Mouse   Timer   Joysticks Joypads	OpenGL
patmandin@978
    60
xbios   ikbd    ikbd    vbl(2)  ikbd      hardware	OSMesa
patmandin@978
    61
xbios   gemdos  xbios   vbl(2)  xbios     hardware	OSMesa
patmandin@978
    62
xbios   bios    xbios   vbl(2)  xbios     hardware	OSMesa
patmandin@984
    63
gem     gem     gem(1)  vbl(2)  xbios     hardware	OSMesa
slouken@319
    64
slouken@557
    65
(1) 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@557
    68
(2) If you build SDL with threads using the GNU pth library, timers are
slouken@557
    69
supported via the pth library.
slouken@557
    70
slouken@281
    71
==============================================================================
slouken@281
    72
V.  Environment variables:
slouken@281
    73
slouken@398
    74
SDL_VIDEODRIVER:
slouken@398
    75
	Set to 'xbios' to force xbios video driver
slouken@398
    76
	Set to 'gem' to force gem video driver
slouken@398
    77
patmandin@1007
    78
SDL_VIDEO_GL_DRIVER:
patmandin@1007
    79
	Set to filename to load as OpenGL library, if you use SDL_GL_LoadLibrary()
patmandin@1007
    80
slouken@398
    81
SDL_AUDIODRIVER:
patmandin@644
    82
	Set to 'mint_gsxb' to force Atari GSXB audio driver
patmandin@644
    83
	Set to 'mint_mcsn' to force Atari MCSN audio driver
patmandin@644
    84
	Set to 'mint_stfa' to force Atari STFA audio driver
patmandin@644
    85
	Set to 'mint_xbios' to force Atari Xbios audio driver
patmandin@644
    86
	Set to 'mint_dma8' to force Atari 8 bits DMA audio driver
slouken@398
    87
	Set to 'audio' to force Sun /dev/audio audio driver
slouken@398
    88
	Set to 'disk' to force disk-writing audio driver
slouken@398
    89
slouken@281
    90
SDL_ATARI_EVENTSDRIVER
slouken@281
    91
	Set to 'ikbd' to force IKBD 6301 keyboard driver
slouken@281
    92
	Set to 'gemdos' to force gemdos keyboard driver
slouken@281
    93
	Set to 'bios' to force bios keyboard driver
slouken@281
    94
slouken@302
    95
SDL_JOYSTICK_ATARI:
slouken@302
    96
	Use any of these strings in the environment variable to enable or
slouken@302
    97
	disable a joystick:
slouken@302
    98
slouken@305
    99
	'ikbd-joy1-[on|off]' for IKBD joystick on port 1 (hardware access)
slouken@305
   100
	'xbios-joy1-[on|off]' for IKBD joystick on port 1 (xbios access)
slouken@302
   101
	'porta-pad-[on|off]' for joypad on port A
slouken@302
   102
	'porta-joy0-[on|off]' for joystick 0 on port A
slouken@302
   103
	'porta-joy1-[on|off]' for joystick 1 on port A
slouken@302
   104
	'porta-lp-[on|off]' for lightpen on port A
slouken@302
   105
	'porta-anpad-[on|off]' for analog paddle on port A
slouken@302
   106
	'portb-pad-[on|off]' for joypad on port B
slouken@302
   107
	'portb-joy0-[on|off]' for joystick 0 on port B
slouken@302
   108
	'portb-joy1-[on|off]' for joystick 1 on port B
slouken@302
   109
	'portb-anpad-[on|off]' for analog paddle on port B
slouken@302
   110
slouken@302
   111
	Default configuration is:
slouken@302
   112
		'ikbd-joy1-on' (if IKBD events driver enabled)
slouken@305
   113
		'xbios-joy1-on' (if gemdos/bios/gem events driver enabled)
slouken@302
   114
		'porta-pad-on portb-pad-on' (if available on the machine)
slouken@302
   115
slouken@302
   116
	port[a|b]-[pad|joy?|lp|anpad]-* strings are mutually exclusives.
slouken@302
   117
	On such a port, you can only use a joypad OR 1 or 2 joysticks OR
slouken@302
   118
	a lightpen OR an analog paddle. You must disable joypad before
slouken@302
   119
	setting another controller.
slouken@302
   120
slouken@302
   121
	The second joystick port on IKBD is used by the mouse, so not usable.
slouken@302
   122
patmandin@963
   123
	Descriptions of joysticks/joypads:
patmandin@963
   124
	- Joypads: 1 hat, 17 buttons (Atari Jaguar console-like).
patmandin@963
   125
	- Joysticks: 1 hat, 1 button.
patmandin@963
   126
	- Lightpen, analog paddles: 2 axis, 2 buttons. The 2 buttons are those
patmandin@963
   127
	  affected to 1 button joysticks on the same port.
slouken@302
   128
slouken@319
   129
==============================================================================
slouken@319
   130
VI.  More informations about drivers:
slouken@319
   131
patmandin@1007
   132
OpenGL:
patmandin@1007
   133
	The default is to use the Mesa offscreen driver (osmesa.ldg). If you want
patmandin@1007
   134
	to use an older OpenGL implementation, like mesa_gl.ldg or tiny_gl.ldg,
patmandin@1007
   135
	your program must use SDL_GL_LoadLibrary() to do so, and retrieve the
patmandin@1007
   136
	needed function pointers with SDL_LoadFunction(). In all cases, the OpenGL
patmandin@1007
   137
	context is taken care of by SDL itself, you just have to use gl* functions.
patmandin@1007
   138
patmandin@1007
   139
	However, there is one OpenGL call that has a different prototype in the old
patmandin@1007
   140
	implementations: glOrtho(). In the old implementations, it has 6 float as
patmandin@1007
   141
	parameters, in the standard one, it has 6 double parameters. If you want
patmandin@1007
   142
	to compile testdyngl, or any other SDL program that loads its OpenGL
patmandin@1007
   143
	library, you must change the glOrtho() prototype used in this program. In
patmandin@1007
   144
	osmesa.ldg, you can retrieve a glOrtho() with double parameters, by searching
patmandin@1007
   145
	for the function "glOrtho6d".
patmandin@1007
   146
slouken@319
   147
Xbios video:
slouken@319
   148
	Video chip is detected using the _VDO cookie.
slouken@319
   149
	Screen enhancers are not supported, but could be if you know how to
slouken@319
   150
	use them.
slouken@319
   151
slouken@319
   152
	ST, STE, Mega ST, Mega STE:
slouken@319
   153
		320x200x4 bits, shades of grey, available only for the purpose
slouken@319
   154
		of testing SDL.
slouken@319
   155
	TT:
slouken@319
   156
		320x480x8 and 320x240x8 (software double-lined mode).
slouken@319
   157
	Falcon:
slouken@319
   158
		All modes supported by the current monitor (RVB or VGA).
slouken@319
   159
	Clones and any machine with monochrome monitor:
slouken@319
   160
		Not supported.
slouken@319
   161
slouken@319
   162
Gem video:
slouken@319
   163
	Automatically used if xbios not available.
slouken@319
   164
slouken@319
   165
	All machines:
slouken@319
   166
		Only the current resolution, if 8 bits or higher depth.
slouken@319
   167
slouken@319
   168
IKBD keyboard, mouse and joystick driver:
slouken@319
   169
	Available if _MCH cookie is ST, Mega ST, STE, Mega STE, TT or Falcon.
slouken@319
   170
slouken@319
   171
	Hades has an IKBD, but xbios is not available for video, so IKBD
slouken@319
   172
	driver is disabled.
slouken@319
   173
slouken@319
   174
Gemdos and bios keyboard driver:
slouken@319
   175
	Available on all machines.
slouken@319
   176
slouken@319
   177
Mouse and joystick xbios driver:
slouken@319
   178
	Available on all machines (I think).
slouken@319
   179
slouken@319
   180
Joypad driver:
slouken@319
   181
	Available if _MCH cookie is STE or Falcon.
slouken@319
   182
slouken@557
   183
PTH timer driver:
slouken@557
   184
	Available with multitasking OS.
slouken@557
   185
slouken@319
   186
VBL timer driver:
slouken@398
   187
	Available on all machines (I think).
slouken@398
   188
patmandin@644
   189
Audio drivers:
patmandin@644
   190
	Cookies _SND, MCSN, STFA and GSXB used to detect supported audio
patmandin@644
   191
	capabilities.
slouken@398
   192
slouken@398
   193
	STE, Mega STE, TT:
slouken@398
   194
		8 bits DMA (hardware access)
patmandin@644
   195
		STFA, MCSN or GSXB driver if installed
patmandin@644
   196
	Falcon:
patmandin@644
   197
		8 bits DMA (hardware access)
patmandin@644
   198
		Xbios functions
patmandin@644
   199
		STFA, MCSN or GSXB driver if installed
patmandin@644
   200
	Other machines:
patmandin@644
   201
		STFA, MCSN or GSXB driver if installed
slouken@398
   202
patmandin@644
   203
	STFA driver:
patmandin@644
   204
		http://removers.free.fr/softs/stfa.html
patmandin@644
   205
	GSXB driver:
patmandin@644
   206
		http://assemsoft.atari.org/gsxb/
patmandin@644
   207
	MacSound driver:
patmandin@644
   208
		http://jf.omnis.ch/software/tos/
patmandin@644
   209
	MagicSound driver (MCSN,GSXB compatible):
patmandin@644
   210
		http://perso.wanadoo.fr/didierm/
patmandin@644
   211
	X-Sound driver (GSXB compatible):
patmandin@644
   212
		http://www.uni-ulm.de/~s_thuth/atari/xsound_e.html
slouken@319
   213
slouken@281
   214
-- 
slouken@281
   215
Patrice Mandin <pmandin@caramail.com>
slouken@314
   216
http://membres.lycos.fr/pmandin/