speed-dreams-code/doc/userman/how_to_drive.html

<!--
	file        : how_to_drive.html
	created     : Fri Aug  12 13:39:11 CET 2005
	copyright   : (C) 2005 Eric Espie, 2009 The Speed Dreams Team
	web         : speed-dreams.sourceforge.net
	version     : $Id: how_to_drive.html 1987 2009-12-22 19:31:21Z pouillot $

	Permission is granted to copy, distribute and/or modify this document
	under the terms of the GNU Free Documentation License, Version 1.2
	or any later version published by the Free Software Foundation;
	with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
	Texts.  A copy of the license is available at http://www.gnu.org/copyleft.
-->
	
	<h1>I want to drive !</h1>
	
	<p>
		Here is the manual for the players who want to drive in Speed Dreams <b>1.4.0</b>.
	</p>
	
	<p>
		First of all you should install and run Speed Dreams ; for that, please read see the
		INSTALL file <a href="http://speed-dreams.svn.sourceforge.net/viewvc/speed-dreams/trunk">here</a>.
	</p>
	
	<p>
		After that you'll be able to drive a car with a joystick, a steering wheel, 
		or simply with the mouse and/or keyboard.
	</p>
	
	<p>
		Before that, you may want to know about the project contributors ...
		The Credits menu is here for that.
	</p>
	
	<p>
		<img src="images/welcome-credits.jpg">
	</p>
	
	<p>
		Take a while to navigate in the different chapters through the up and down arrows.
		And get back to the main menu through the Back button.
	</p>
	
	<p>
		<img src="images/credits-nextpage.jpg">
	</p>
	
	<p>
		Now, back to the race preparation !
	</p>
	
	<p>
		Wait ! A last but important tip : never forget to hit the F1 key if you need help
		about the available keyboard shortcuts in the current menu ...
	</p>
	
	<p>
		You first need to configure a "human player" in order to choose you car and control device(s) : 
		go to the Player Configuration menu.
	</p>
	
	<p>
		<img src="images/welcome-playerconfig.jpg">
	</p>
	
	<p>
		To select a player to configure, click in the "Players" list box on one player's name. 
		You can also :
		<ul>
			<li>create a new player through the New button under the list box (all default settings),</li>
			<li>copy the selected one with the Copy button (all his settings will be copied, you'll then need to give him a new name),</li>
			<li>delete the selected one with the Delete button.</li>
		</ul>
	</p> 
	
	<p>
		<img src="images/playerconfig-select.jpg">
	</p>
	
	<p>
		Here, we have selected the player named "Player". 
	</p>
	
	<p>
		To change his name, click in the "name" field and edit it with usual keys.
	</p>
		<img src="images/playerconfig-editname.jpg">
	<p>
		Tip: If you do not want to come back later to change the car / control settings,
		create here multiple players with different cars / control settings ...
	</p>
	
	<p>
		This configuration screen is also used to:
		<ul>
			<li>Select the player's car:
				<ol>
					<li>First select the car's category you want:
						<ul>
							<li><b>36 GP</b>: These terrible Grand-Prix cars of the thirties</li>
							<li><b>Supercars</b>: The ones you dream of, in their unmodified version</li>
							<li><b>TRB1</b>: The Speed Dreams setups of the well known GTs from Torcs</li>
							<li><b>LS-GT1</b>: The future awesome Speed Dreams GT1 series</li>
						</ul>
					</li>
					<li>Then select your car within the category.</li>
				</ol>
			</li>
			<li>Select the transmission mode (automatic, sequential or grid)</li>
				<ul>
					<li><b>automatic</b>: Just throttle down or brake, the computer takes car of the gears</li>
					<li><b>sequential</b>: Shift up and down like in a F1 car</li>
					<li><b>grid</b>: Enjoy the good old grid shifter, like grand father's</li>
				</ul>
			<li>Program the number of pit stops you want for the race, so the initial fuel amount is adjusted accordingly.</li>
			<li>Change the player's skill level:
				<ul>
					<li><b>Rookie</b>: No damages (0%),  high traction (+40%)</li>
					<li><b>Amateur</b>: Small damages (50%),  high traction (+35%)</li>
					<li><b>Semi-Pro</b>: Medium damages (80%), medium traction (+30%)</li>
					<li><b>Pro</b>: High damages (100%), low traction (+0%)</li>
				</ul>
			</li>
			<li>Select the auto reverse function (engage automatically the reverse gear when the car is stopped and you continue to brake).</li>
			<li>Configure the control device(s) (see below)</li>
		</ul>
	</p>
	
	<!--pagebreak-->	
	
	<h1>Player's Control Configuration</h1>
	
	<p>
		To configure the controls click on the "Controls" button
	</p>
	
	<p>
		<img src="images/playerconfig-control.jpg">
	</p>
	
	<p>
		Now, click on the control you want to change ...
	</p>
	
	<p>
		<img src="images/controlconfig-autoseq.jpg">
	</p>
	
	<p>
		... and then press the keyboard key you want to use for that control, 
		or a mouse button if you prefer, or even ... move the mouse
		if that control have to be assigned to a mouse move event.
	</p>
	
	<p>
		Tip: To unassign a given control, click on it and press the Escape key.
	</p>
	
	</p>
	
	<p>
		<img src="images/controlconfig-mouseleft.jpg">
	</p>
	
	<p>
 		You can also use a joystick, a gamepad, or even a wheel with/without pedals/gear lever ...
		See <a href="http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/">the Vojtech Pavlik's joystick
		driver site</a> for more information on how you can have your device work under Linux.
		(see also <a href="http://www.icculus.org/lgfaq">Linux Gamers FAQ</a>).
	</p>
	
	<p>
		The control configuration screen is a bit different if you choosed the grid shifting mode,
		but it works the same way.
	</p>
	
	<p>
		<img src="images/controlconfig-wheelright.jpg">
	</p>
	
	<p>
		Tip: If your device was not plugged in (you forgot), just exit 
		from the control configuration screen, plug it in, and then get back ...
		This time it should work.
	</p>
	
	<p>
		Proceed with all the controls you want to configure (you can use device buttons, axes, ...).
	</p>
	
	<p>
		Then you probably want to calibrate the relevant axes.
	</p>
	
	<p>
		<img src="images/controlconfig-calibrate.jpg">
	</p>
	
	<p>
		Just follow the calibration instructions on the screen.
	</p>
	
	<p>
		<img src="images/joystickconfig.jpg">
	</p>
	
	<p>
		The calibration screen is a bit different when you choosed the mouse.
	</p>
	
	<p>
		<img src="images/mouseconfig.jpg">
	</p>
	
	<p>
		When the calibration is done, press the "back" button. If something went wrong
		during the calibration process, don't panic, use the "reset" button to start over
		the calibration.
	</p>
	
	<p>
		You'll have to save your control settings before exiting (unless you want to cancel all through the Cancel button).
	</p>
	
	<p>
		<img src="images/controlconfig-save.jpg">
	</p>
	
	<p>
		And then save the players settings (or Cancel all of your changes through the Cancel button).
	</p>
	
	<p>
		<img src="images/playerconfig-accept.jpg">
	</p>
	
	<!--pagebreak-->
	<h1>General Configuration Options</h1>
	
	<p>
		You can configure general options using the "Options" menu
	</p>
	
	<p>
		<img src="images/welcome-options.jpg">
	</p>
	
	<p>
		The screen display configuration is done in the "Display" menu
	</p>
	
	<p>
		<img src="images/options-display.jpg">
	</p>
	
	<p>
		You can adjust the screen / window resolution, the colour depth,
		the display mode (windowed or fullscreen), the video initialization mode
		("compatible" normally works, while best may produce odd graphic effects ...).
	</p>
	<p>
		<img src="images/display-accept.jpg">
	</p>
	
	<p>
		Use the Apply button to validate your changes. 
	</p>
	
	<p>
		<b>Note:</b> If the program does not restart with the parameters you have chosen, 
		don't panic, just edit the "screen.xml" file and reset the values 
		to a more conservative choice (this file is normally located in ~/.speed-dreams/config under Unixes, or <My documents>/speed-dreams.settings/config under Windows).
	</p>
	
	<p>
		<b>Advanced:</b> Under Windows, you can also set the maximum screen refresh rate (Hz)
		during the game : if your real hardware screen refresh rate is 75 Hz,
		it's useless (no harm, only warm and noise ;-) to use a higher value
		as your CPU will work for nothing. Under Linux, use your video driver configuration
		tool and set the "Sync to VBlank" option to get the same effect.
	</p>
	
	<p>
		If you are experiencing problems with the mouse cursor, you can try to launch TORCS with the option "-m".
		And if you have texture problems, you can try the "-s" option to run in single texture mode.
	</p>
	
	<p>
        The Graphic parameters are located in the "Graphic" menu
    </p>
	<p>
		<img src="images/options-graphic.jpg">
	</p>
	
	<p>The following parameters are customisable:</p>
	    <ul>
	        <li><b>Visibility</b>: The depth of view factor (> 0), you can go beyond 100%</li>
	        <li><b>Smoke</b>: The number of smokes per car (>= 0)</li>
	        <li><b>Skid Marks</b>: The number of skid marks per car (>= 0)</li>
	        <li><b>LOD Factor</b>: The cars LOD (Level Of Detail) threshold (>= 0.0)</li>
	    </ul>
	<p>
        As a general rule for all these parameters, greater values will need a more powerfull system :
        play a little to find the ones that fit best your hardware</p>
	<p>
		<img src="images/graphic-accept.jpg">
	</p>
	
	<p>
		The Open GL settings can be changed in the "Open GL" menu
	</p>
	
	<p>
		<img src="images/options-opengl.jpg">
	</p>
	
	<p>
		You can enable or disable the texture compresssion if your hardware supports it
		and adjust the maximum texture size (as the number of pixels for each side of a square).
	</p>
	<p>
		<img src="images/opengl-accept.jpg">
	</p>
	
	<p>
		The Sound parameters can be changed in the "Sound" menu
	</p>
	
	<p>
		<img src="images/options-sound.jpg">
	</p>
	
	<p>
		You can disable in-game sound, or select the OpenAL or PLib backend
		(OpenAL generaly gives a better 16 bits sound ; choose PLib if OpenAL doesn't work
        or according to your taste).
		You can also adjust the master volume (from 0 to 100% of the current OS level).
	</p>
	<p>
		<img src="images/sound-accept.jpg">
	</p>
	
	<p>
		The Simulation Engine settings can be changed in the "Simulation" menu
	</p>
	
	<p>
		<img src="images/options-simulation.jpg">
	</p>
	
	<p>
		You can select here the physics engine you prefer :
	    <ul>
	        <li><b>Simu V2</b>: The current official engine (2.5D) ; the cars and robots are optimized for this engine</li>
	        <li><b>Simu V3</b>: The future Speed Dream engine (3D) ; experimental for the moment</li>
	    </ul>
	</p>
	<p>
		<img src="images/simulation-accept.jpg">
	</p>
	
	<p>
		The AI opponents settings can be changed in the "AI Opponents" menu
	</p>
	
	<p>
		<img src="images/options-aiopponents.jpg">
	</p>
	
	<p>
		You can change here the AI opponents global skill level
		(same possible values as for the human player skill level).
	</p>
	<p>
		<img src="images/aiopponents-accept.jpg">
	</p>
	
	<!--pagebreak-->
	
	<h1>Racing</h1>
	
	<p>
		Go to the racing menu:
	</p>
	
	<p>
		<img src="images/welcome-race.jpg">
	</p>
	
	<p>
		Select one of the race types : "Quick Race" is the one, if you want to be able
		configure everything for the race.
	</p>
	
	<p>
		<img src="images/race-quickrace.jpg">
	</p>
	
	<p>
		Configure you race (note you have here a shortcut to the "Player Configuration" menu) :
	</p>
	
	<p>
		<img src="images/quickrace-configure.jpg">
	</p>
	
	<p>
		Select the track you want to race on ; you can choose it in 4 categories :
	    <ul>
	        <li><b>Grand Prix Circuits</b>: Permanent circuit tracks</li>
	        <li><b>Road Tracks</b>: Countryside and in-town tracks</li>
	        <li><b>Dirt Tracks</b>: All terrain tracks</li>
	        <li><b>Speedways</b>: American "oval" tracks or alike</li>
	    </ul>
        Note the screen background gives you an overview of the currently selected track,
        while the track outline is displayed on the left.
	</p>
	
	<p>
		<img src="images/selecttrack-accept.jpg">
	</p>
	
	<p>
		Once you found the track you want, click on the "Accept" button :
        you've reached the drivers selection menu (AI and also human ones).
	</p>
	
	<p>
		On the right, the list of the available drivers : you can filter the drivers list 
		by car category and by driver type (human, AI USR and AI Simplix)
        you've reached the drivers selection menu (AI and also human ones).
	</p>
	
	<p>
		On the left, the list of the selected drivers : to select a driver for the race,
		click on him on the right list, and then click on the "(De)Select" button (or hit the space bar).
        To unselect him, click on him on the left list, and do the same. 
        You can also change the starting grid order with the "Move Up" and "Move Down" buttons :
        they change the position of the selected driver in the left list.
	</p>
	
	<p>
		<img src="images/selectdrivers-select.jpg">
	</p>
	
	<p>
		When happy with the selected drivers, save it with the "Accept" button. 
	</p>
	
	<p>
		<img src="images/selectdrivers-accept.jpg">
	</p>
	
	<p>
		Finally, configure the race length (as a number of laps or a distance) :
	</p>
	
	<p>
		<img src="images/quickraceoptions-accept.jpg">
	</p>
	
	<p>
		And ... start the race !
	</p>
	
	<p>
		<img src="images/quickrace-newrace.jpg">
	</p>
	
	<p>
		Be patient, the game is loading everything ... but be ready !
	</p>
	
	<p>
		<img src="images/race-loading.jpg">
	</p>
	
	<!--pagebreak-->	
	
	<p>
        On your marks !
    </p>
	
	<p>
		<img src="images/race-f2cam1.jpg">
	</p>
	
	<p>
		Press <b>F2</b> to cycle through the driver views:
	</p>
	
	<p>
		<img src="images/race-f2cam2.jpg">
	</p>
	
	<p>
		<img src="images/race-f2cam3.jpg">
	</p>
	
	<p>
		<img src="images/race-f2cam4.jpg">
	</p>
	
	<p>
		<img src="images/race-f2cam0.jpg">
	</p>
	
	<p>
		At any time during the race, press <b>F1</b> to get help about all the commands (and pause the game). 
		Beware, most views, cameras and the map keys are "modal", so if you hit them multiple times,
		you will get different variants of the view / camera / map.
	</p>
	
	<p>
		<img src="images/race-help.jpg">
	</p>
	
	<p>Now drive as fast as you can ... and try being faster that the robots !</p>

	<p>
		<img src="images/race-results.jpg">
	</p>
	
	<p>(at the end of each race, you get the board, and know what's still to improve ;-)</p>