README.MiNT
author Patrice Mandin <patmandin@gmail.com>
Wed, 29 Jun 2005 20:38:56 +0000
changeset 1083 9f8aa754622b
parent 1064 fba6b67b4d60
child 1087 8c44005e0979
permissions -rw-r--r--
Direct newbies to what to do
     1 ==============================================================================
     2 Using the Simple DirectMedia Layer on Atari
     3 ==============================================================================
     4 
     5 
     6     If you want to build SDL from sources to create SDL programs on Atari:
     7         see sections I - II.
     8 	
     9     If you want to create SDL programs on Atari using SDL binary build,
    10         download it from my web site (URL at end of this file).
    11 
    12     If you want to configure a program using SDL on Atari,
    13 	    see sections IV - VI.
    14 
    15 
    16 ==============================================================================
    17 I.  Building the Simple DirectMedia Layer libraries:
    18     (This step isn't necessary if you have the SDL binary distribution)
    19 
    20   Do the classic configure, with --disable-shared --enable-static and:
    21 
    22     Tos version (should run everywhere):
    23       --disable-threads
    24     Tos does not support threads.
    25 
    26     MiNT version (maybe Magic, only for multitasking OS):
    27       --disable-pthreads --enable-pth
    28     Mint and Magic may supports threads, so audio can be used with current
    29     devices, like Sun audio, or disk-writing support. Like Tos, interrupt
    30     audio without threads is more suited for Atari machines.
    31 
    32   Then you can make ; make install it.
    33 
    34 ==============================================================================
    35 II. Building the Simple DirectMedia Layer test programs:
    36 
    37   Do the classic configure, then make.
    38 
    39   Run them !
    40 
    41 ==============================================================================
    42 III.  Enjoy! :)
    43 
    44   If you have a project you'd like me to know about, or want to ask questions,
    45   go ahead and join the SDL developer's mailing list by sending e-mail to:
    46 
    47 	sdl-request@libsdl.org
    48 
    49   and put "subscribe" into the subject of the message. Or alternatively you
    50   can use the web interface:
    51 
    52 	http://www.libsdl.org/mailman/listinfo/sdl
    53   
    54 ==============================================================================
    55 IV.  What is supported:
    56 
    57 Keyboard (GEMDOS, BIOS, GEM, Ikbd)
    58 Mouse (XBIOS, GEM, Ikbd)
    59 Video (XBIOS (Fullscreen), GEM (Windowed and Fullscreen))
    60 Timer (VBL vector, GNU pth library)
    61 Joysticks and joypads (Ikbd, Hardware)
    62 Audio (Hardware, XBIOS, GSXB, MCSN, STFA, /dev/audio if threads enabled)
    63 Threads (Multitasking OS only via GNU pth library)
    64 Shared object loader (using LDG library from http://ldg.atari.org/)
    65 Audio CD (MetaDOS)
    66 OpenGL (using Mesa offscreen rendering driver)
    67 
    68 - Driver combinations:
    69 Video   Kbd     Mouse   Timer   Joysticks Joypads	OpenGL
    70 xbios   ikbd    ikbd    vbl(2)  ikbd      hardware	OSMesa
    71 xbios   gemdos  xbios   vbl(2)  xbios     hardware	OSMesa
    72 xbios   bios    xbios   vbl(2)  xbios     hardware	OSMesa
    73 gem     gem     gem(1)  vbl(2)  xbios     hardware	OSMesa
    74 
    75 (1) GEM does not report relative mouse motion, so xbios mouse driver is used
    76 to report this type event.
    77 
    78 (2) If you build SDL with threads using the GNU pth library, timers are
    79 supported via the pth library.
    80 
    81 ==============================================================================
    82 V.  Environment variables:
    83 
    84 SDL_VIDEODRIVER:
    85 	Set to 'xbios' to force xbios video driver
    86 	Set to 'gem' to force gem video driver
    87 
    88 SDL_VIDEO_GL_DRIVER:
    89 	Set to filename to load as OpenGL library, if you use SDL_GL_LoadLibrary()
    90 
    91 SDL_AUDIODRIVER:
    92 	Set to 'mint_gsxb' to force Atari GSXB audio driver
    93 	Set to 'mint_mcsn' to force Atari MCSN audio driver
    94 	Set to 'mint_stfa' to force Atari STFA audio driver
    95 	Set to 'mint_xbios' to force Atari Xbios audio driver
    96 	Set to 'mint_dma8' to force Atari 8 bits DMA audio driver
    97 	Set to 'audio' to force Sun /dev/audio audio driver
    98 	Set to 'disk' to force disk-writing audio driver
    99 
   100 SDL_ATARI_EVENTSDRIVER
   101 	Set to 'ikbd' to force IKBD 6301 keyboard driver
   102 	Set to 'gemdos' to force gemdos keyboard driver
   103 	Set to 'bios' to force bios keyboard driver
   104 
   105 SDL_JOYSTICK_ATARI:
   106 	Use any of these strings in the environment variable to enable or
   107 	disable a joystick:
   108 
   109 	'ikbd-joy1-[on|off]' for IKBD joystick on port 1 (hardware access)
   110 	'xbios-joy1-[on|off]' for IKBD joystick on port 1 (xbios access)
   111 	'porta-pad-[on|off]' for joypad on port A
   112 	'porta-joy0-[on|off]' for joystick 0 on port A
   113 	'porta-joy1-[on|off]' for joystick 1 on port A
   114 	'porta-lp-[on|off]' for lightpen on port A
   115 	'porta-anpad-[on|off]' for analog paddle on port A
   116 	'portb-pad-[on|off]' for joypad on port B
   117 	'portb-joy0-[on|off]' for joystick 0 on port B
   118 	'portb-joy1-[on|off]' for joystick 1 on port B
   119 	'portb-anpad-[on|off]' for analog paddle on port B
   120 
   121 	Default configuration is:
   122 		'ikbd-joy1-on' (if IKBD events driver enabled)
   123 		'xbios-joy1-on' (if gemdos/bios/gem events driver enabled)
   124 		'porta-pad-on portb-pad-on' (if available on the machine)
   125 
   126 	port[a|b]-[pad|joy?|lp|anpad]-* strings are mutually exclusives.
   127 	On such a port, you can only use a joypad OR 1 or 2 joysticks OR
   128 	a lightpen OR an analog paddle. You must disable joypad before
   129 	setting another controller.
   130 
   131 	The second joystick port on IKBD is used by the mouse, so not usable.
   132 
   133 	Descriptions of joysticks/joypads:
   134 	- Joypads: 1 hat, 17 buttons (Atari Jaguar console-like).
   135 	- Joysticks: 1 hat, 1 button.
   136 	- Lightpen, analog paddles: 2 axis, 2 buttons. The 2 buttons are those
   137 	  affected to 1 button joysticks on the same port.
   138 
   139 ==============================================================================
   140 VI.  More informations about drivers:
   141 
   142 OpenGL:
   143 	The default is to use the Mesa offscreen driver (osmesa.ldg). If you want
   144 	to use an older OpenGL implementation, like mesa_gl.ldg or tiny_gl.ldg,
   145 	your program must use SDL_GL_LoadLibrary() to do so, and retrieve the
   146 	needed function pointers with SDL_LoadFunction(). In all cases, the OpenGL
   147 	context is taken care of by SDL itself, you just have to use gl* functions.
   148 
   149 	However, there is one OpenGL call that has a different prototype in the old
   150 	implementations: glOrtho(). In the old implementations, it has 6 float as
   151 	parameters, in the standard one, it has 6 double parameters. If you want
   152 	to compile testdyngl, or any other SDL program that loads its OpenGL
   153 	library, you must change the glOrtho() prototype used in this program. In
   154 	osmesa.ldg, you can retrieve a glOrtho() with double parameters, by
   155 	searching for the function "glOrtho6d".
   156 
   157 Xbios video:
   158 	Video chip is detected using the _VDO cookie.
   159 	Screen enhancers are not supported, but could be if you know how to
   160 	use them.
   161 
   162 	ST, STE, Mega ST, Mega STE:
   163 		320x200x4 bits, shades of grey, available only for the purpose
   164 		of testing SDL.
   165 	TT:
   166 		320x480x8 and 320x240x8 (software double-lined mode).
   167 	Falcon:
   168 		All modes supported by the current monitor (RVB or VGA).
   169 		BlowUp and Centscreen extended modes, ScreenBlaster 3 current mode.
   170 	Clones and any machine with monochrome monitor:
   171 		Not supported.
   172 
   173 Gem video:
   174 	Automatically used if xbios not available.
   175 
   176 	All machines:
   177 		Only the current resolution, if 8 bits or higher depth.
   178 
   179 IKBD keyboard, mouse and joystick driver:
   180 	Available if _MCH cookie is ST, Mega ST, STE, Mega STE, TT or Falcon.
   181 
   182 	Hades has an IKBD, but xbios is not available for video, so IKBD
   183 	driver is disabled.
   184 
   185 Gemdos and bios keyboard driver:
   186 	Available on all machines.
   187 
   188 Mouse and joystick xbios driver:
   189 	Available on all machines (I think).
   190 
   191 Joypad driver:
   192 	Available if _MCH cookie is STE or Falcon.
   193 
   194 PTH timer driver:
   195 	Available with multitasking OS.
   196 
   197 VBL timer driver:
   198 	Available on all machines (I think).
   199 
   200 Audio drivers:
   201 	Cookies _SND, MCSN, STFA and GSXB used to detect supported audio
   202 	capabilities.
   203 
   204 	STE, Mega STE, TT:
   205 		8 bits DMA (hardware access)
   206 		STFA, MCSN or GSXB driver if installed
   207 	Falcon:
   208 		8 bits DMA (hardware access)
   209 		Xbios functions
   210 		STFA, MCSN or GSXB driver if installed
   211 	Other machines:
   212 		STFA, MCSN or GSXB driver if installed
   213 
   214 	STFA driver:
   215 		http://removers.free.fr/softs/stfa.html
   216 	GSXB driver:
   217 		http://assemsoft.atari.org/gsxb/
   218 	MacSound driver:
   219 		http://jf.omnis.ch/software/tos/
   220 	MagicSound driver (MCSN,GSXB compatible):
   221 		http://perso.wanadoo.fr/didierm/
   222 	X-Sound driver (GSXB compatible):
   223 		http://www.uni-ulm.de/~s_thuth/atari/xsound_e.html
   224 
   225 -- 
   226 Patrice Mandin <pmandin@caramail.com>
   227 http://membres.lycos.fr/pmandin/