This repository has been archived by the owner on Jan 10, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
128 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,136 +1,164 @@ | ||
| <b>Manual Transmission and Steering Wheel Support for GTA V</b> | ||
| This mod enables manual transmission and offers various options to fine-tune your gameplay, from gearbox selection to engine braking. | ||
|
|
||
| Support for steering wheels is fully integrated into this mod: full force feedback, multiple input devices, every setting is customizable to fit your wheel and personal preferences. | ||
|
|
||
| <br> | ||
| <b>Features</b> | ||
| <ul> | ||
| <li>Friendly in-game menu for configuration</li> | ||
| <li>Supports keyboard, controller and wheel input</li> | ||
| <li>Supports for all land-based engine-powered vehicles</li> | ||
| <li>Loads of options for every aspect of the mod!</li> | ||
| <li>Choose between transmission systems - On the fly!: | ||
| <ul> | ||
| <li>Sequential gearbox</li> | ||
| <li>H-pattern gearbox</li> | ||
| <li>Custom automatic gearbox</li> </ul> </li> | ||
| <li>Engine and transmission mechanics: | ||
| <ul> | ||
| <li>Clutch support</li> | ||
| <li>Engine braking</li> | ||
| <li>Engine damage</li> | ||
| <li>Engine stalling</li> </ul> </li> | ||
| <li>Adds UDP telemetry support, exports DiRT 4 telemetry, for <a href=https://www.simhubdash.com/>SimHub</a> and similar tools</li> | ||
| <li>Custom active driving assists: ABS, Traction Control, Stability Control</li> | ||
| <li>Control over the <b>transmission</b> and drivetrain components | ||
| <ul> | ||
| <li>Sequential, H-pattern or custom automatic gearbox modes</li> | ||
| <li>Clutch and engine simulation</li> | ||
| <li>Limited slip differential emulation</li> | ||
| </ul> | ||
| </li> | ||
| <li>Complete <b>steering wheel</b> integration, with <b>Force Feedback</b></li> | ||
| <li>Enhanced support for keyboard/mouse and controllers | ||
| <ul> | ||
| <li>Customizable steering sensitivity and assist levels</li> | ||
| </ul> | ||
| </li> | ||
| <li>Custom realistic active <b>driver assists</b>: ABS, Traction Control, Stability Control</li> | ||
| <li>Customizable <b>steering wheel rotation</b>, with <b>synchronized animations</b></li> | ||
| <li>Custom first person driving camera with <b>physics effects</b></li> | ||
| <li>Enhanced experience with other software and mods | ||
| <ul> | ||
| <li>Exports UDP telemetry in DiRT 4 format</li> | ||
| <li> <a href="https://github.com/E66666666/GTAVManualTransmission/blob/master/Gears/ManualTransmission.h">API</a> to read and control the mod</li> | ||
| </ul> | ||
| </li> | ||
| <li>Extensive customizability of nearly <b>every aspect</b> of the mod using the in-game menu</li> | ||
| </ul> | ||
|
|
||
| <br> | ||
| <b>Requirements</b> | ||
| <ul> | ||
| <li>Grand Theft Auto V</li> | ||
| <li><a href=http://www.dev-c.com/gtav/scripthookv/>ScriptHookV</a></li> | ||
| <li><a href=https://aka.ms/vs/16/release/vc_redist.x64.exe>Microsoft Visual Studio Redistributable (x64) (2015-2019)</a></li> </ul> | ||
| <li>Grand Theft Auto V</li> | ||
| <li> <a href=http://www.dev-c.com/gtav/scripthookv/>ScriptHookV</a></li> | ||
| <li> <a href=https://www.gta5-mods.com/tools/dashhook>DashHook</a> (optional)</li> | ||
| </ul> | ||
|
|
||
| <br> | ||
| <b>Installation</b> | ||
| Put Gears.asi and the folder ManualTransmission in your GTA V folder (overwrite when asked) | ||
| Read <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md>the README</a> and configure the mod to your preferences with the in-game menu. | ||
| <ul> | ||
| <li>Put <b>Gears.asi</b> and the folder <b>ManualTransmission</b> in your GTA V folder (overwrite when asked)</li> | ||
| <li>Put <b>DismembermentASI.asi</b> by <a href=https://www.gta5-mods.com/users/CamxxCore><b>CamxxCore</b></a> in your GTA V folder (if not already installed)</li> | ||
| <li>Read <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md>the README</a> and configure the mod to your preferences with the in-game menu.</li> | ||
| <li> <b><i>Use the in-game menu!</i></b> Wheel users: Assign all axes and buttons you intend to use.</li> | ||
| </ul> | ||
|
|
||
| <b>Updating</b> | ||
| Put Gears.asi in your GTA V folder. You can keep old settings, new options are added automatically when needed. | ||
|
|
||
| <b>Wheel installation</b> | ||
| <b><i>Use the in-game menu!</i></b> Be sure to assign all axes and buttons you intend to use. | ||
|
|
||
| <b>More information</b> | ||
| Refer to the <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md>readme</a>. Additionally, The in-game menu contains descriptions for every option. | ||
|
|
||
| <b>Keys</b> | ||
| Open menu: | ||
| <ul> | ||
| <li>[{ on US layout</li> | ||
| <li>Enter the "mtmenu" cheat</li> | ||
| <li>Press <b>RB + B</b> on your controller</li> </ul> | ||
| <li>Put <b>Gears.asi</b> and the folder <b>ManualTransmission</b> in your GTA V folder</li> | ||
| <li>Old settings <b>do NOT need to be overwritten</b></li> | ||
| <li>Check the changelog for new or changed options</li> | ||
| </ul> | ||
|
|
||
| Refer to the <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md>readme</a> for other default keys. | ||
| <b>Usage</b> | ||
| <ul> | ||
| <li>Menu opening: | ||
| <ul> | ||
| <li>Press <b>[{</b> (US layout) (right of the "P" on most QWERTY keyboards)</li> | ||
| <li>Enter the "<b>mtmenu</b>" cheat (without quotes)</li> | ||
| <li>Press <b>RB + B</b> on your controller</li> | ||
| </ul> | ||
| </li> | ||
| <li>Default keys: Check the options in the menu or check the <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/README.md#default-controls>readme</a></li> | ||
| </ul> | ||
|
|
||
| <b>Recommended mods</b> | ||
| <a href=https://www.gta5-mods.com/vehicles/realistic-driving-v>Realistic Driving V</a>: Improves general car physics. Must-have if you have a force-feedback wheel, since it correctly reduces lateral grip to more realistic levels. | ||
| <a href=https://www.gta5-mods.com/scripts/custom-gear-ratios>Custom Gear Ratios</a>: Essential if you have cars with more than 6 gears, and allows matching gear ratios with the real car counterparts. | ||
| <a href=https://www.gta5-mods.com/scripts/turbo-fix>Turbo Fix</a>: Improves turbo response. | ||
| <a href=https://www.gta5-mods.com/scripts/dial-accuracy-fix>Dial Accuracy Fix</a>: Map the dashboard speedometer dials to fit your real speed, for more immersion. | ||
|
|
||
| <i>Speedometers</i> | ||
| <a href=https://www.gta5-mods.com/scripts/speedometer-improvedalexbladeversion>LeFix Speedometer</a> | ||
| <a href=https://www.gta5-mods.com/scripts/nfsgauge-rpm-gear-speedometer>NFS Gauge</a> | ||
| <a href=https://www.gta5-mods.com/scripts/need-for-speed-underground-speedometer>NFSU Speedometer</a> (includes a turbo gauge!) | ||
|
|
||
| <ul> | ||
| <li> Gameplay and driving: | ||
| <ul> | ||
| <li> <a href=https://www.gta5-mods.com/vehicles/realistic-driving-v>Realistic Driving V</a>: Improves general car handling. Must-have for force-feedback wheels, since it uses realistic lateral grip.</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/custom-gear-ratios>Custom Gear Ratios</a>: Essential if you have cars with more than 6 gears, and allows matching gear ratios with the real car counterparts.</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/turbo-fix>Turbo Fix</a>: A quicker, more realistic turbo response.</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/dial-accuracy-fix>Dial Accuracy Fix</a>: Map the dashboard speedometer dials to fit your real speed, for more immersion.</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/true-realistic-driving-v-realistic-mass-v0-1-beta>True Realistic Driving V</a>: Script-based physics</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/stop-powercutting>Stop!Powercutting</a>: InversePower alternative</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/inversetorque>InverseTorque</a>: InversePower alternative</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/inversepower>InversePower</a></li> | ||
| </ul> | ||
| </li> | ||
| <li>Speedometers with proper gears and revs: | ||
| <ul> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/lefix-speedometer>Speedometer by LeFix</a> (maintained by me)</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/nfsgauge-rpm-gear-speedometer>NFS Gauge</a> by XMOD</li> | ||
| <li> <a href=https://www.gta5-mods.com/scripts/need-for-speed-underground-speedometer>NFSU Speedometer</a> (includes a turbo gauge!)</li> | ||
| <li>Any ScriptHookVDotNet-based speedometer with gears and revs</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| <b>Troubleshooting</b> | ||
| <i>Have you tried turning it off and on again?</i> | ||
| <ul> | ||
| <li>When asking for help, include the following: | ||
| You can use <a href=www.pastebin.com>pastebin</a> to post the files. | ||
| <li> <b>ALWAYS</b> include the following (use <a href=www.pastebin.com>pastebin</a> or something similar to post the files): | ||
| <ul> | ||
| <li>ManualTransmission/Gears.log</li> | ||
| <li>ManualTransmission/settings_general.ini</li> | ||
| <li>ManualTransmission/settings_wheel.ini</li> | ||
| <li>What kind of inputs (wheel/controller/keyboard) you're using</li> | ||
| <li>What you already tried to do</li> </ul> </li> | ||
| <li>FiveM support is limited. If you have an issue try to pinpoint the issue. Provide logs.</li> | ||
| <li>What you already tried to do</li> | ||
| </ul> | ||
| </li> | ||
| <li>FiveM support is limited. Try to pinpoint the issue. Provide logs.</li> | ||
| <li>Incompatibilities with other mods is similar. Pinpoint the issue and provide logs.</li> </ul> | ||
|
|
||
| <b>Known bugs and problems</b> | ||
| <ul> | ||
| <li>Crashes with a <b>Logitech G920</b> and <b>ScriptHookVDotNet v2</b> | ||
| <ul> | ||
| <li>Workaround 1: Remove ScriptHookVDotNet</li> | ||
| <li>Workaround 2: Try <a href="https://ragepluginhook.net/">RagePluginHook</a> (Found by BULLFAYCE)</li> </ul> </li> | ||
| <li>Wheel sticks to one side and/or brake/throttle stuck. | ||
| <ul> | ||
| <li>Workaround: Try switching the mod off and on again.</li> </ul> </li> | ||
| <li>Wheel is 100% not detected when using Steam | ||
| <ul> | ||
| <li>Fix: Steam > Steam Big Picture > Settings > Controller Settings > Uncheck Generic Gamepad Configuration Support (Found by Kaerali)</li> </ul> </li> </ul> | ||
| <li>Crashes with a <b>Logitech G920</b> and <b>ScriptHookVDotNet v2</b> | ||
| <ul> | ||
| <li>Workaround 1: Launch the game using <a href="https://ragepluginhook.net/">RagePluginHook</a> (Found by BULLFAYCE)</li> | ||
| <li>Workaround 2: Remove ScriptHookVDotNet</li> | ||
| </ul> | ||
| </li> | ||
| <li>Wheel sticks to one side and/or brake/throttle stuck | ||
| <ul> | ||
| <li>Prevent: Pause before alt-tabbing. Do not alt-tab before the game finished loading.</li> | ||
| <li>Workaround: Try switching the mod off and on again.</li> | ||
| </ul> | ||
| </li> | ||
| <li>Wheel is 100% not detected when using Steam | ||
| <ul> | ||
| <li>Fix: Steam > Steam Big Picture > Settings > Controller Settings > Uncheck Generic Gamepad Configuration Support (Found by Kaerali)</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| <b>Thank you!</b> | ||
| Thank you everybody who helped and contributed in any way. Getting feedback from you users is invaluable, and of course the donations are very appreciated (it helped me buy a G27 to develop with)! | ||
| <b>Thank you!</b><br> | ||
| Thank you everybody who uses, helped and contributed in any way. Getting feedback from you only makes it better :) | ||
| <br> | ||
| Special thanks to: | ||
| <ul> | ||
| <li>Everyone who helped, provided information in any stage of this mod :)</li> | ||
| <li>alloc8or - much of the newer memory stuff</li> | ||
| <li>CamxxCore - DismembermentASI.asi</li> | ||
| <li>InfamousSabre - steering related code</li> | ||
| <li>any333 - limited slip diff sample code</li> | ||
| <li>Nyconing - alternative automatic transmission PR</li> | ||
| </ul> | ||
|
|
||
| <b>Source code</b> | ||
| <br> | ||
| <b>Source code</b><br> | ||
| <a href=https://github.com/E66666666/GTAVManualTransmission>Hosted on GitHub</a> | ||
|
|
||
| <br> | ||
| <b>Alternative downloads</b> | ||
| Releases archive: <a href=https://github.com/E66666666/GTAVManualTransmission/releases>GitHub Releases</a> | ||
| Latest build: <a href=https://ci.appveyor.com/project/E66666666/gtavmanualtransmission/build/artifacts>AppVeyor Artifacts</a> | ||
|
|
||
| <b>Changelog</b> | ||
| <b>v4.7.1</b> | ||
| Due to size, read on GitHub. Short version: | ||
|
|
||
| New features: | ||
|
|
||
| * Add ESC (Electronic Stability Control) | ||
| * Add ABS/TCS/ESC/Handbrake warning lights HUD element | ||
|
|
||
| Wheel fixes and improvements: | ||
|
|
||
| * Add back misshift sounds - only works for wheels in H-pattern mode | ||
| * Fix burnout using wheel pedals not fully engaging | ||
| * Disable USB detection, caused crashes while game is paused | ||
|
|
||
| Force feedback changes: | ||
|
|
||
| * Add gamma and speed limit parameters. Gamma helps increasing FFB response at low | ||
| speeds and decreases wobble when nearing the speed limit. | ||
| * Fix "bump" when FFB changes direction | ||
| * Fix FFB continue playing when paused or ejected from car (for real this time!) | ||
| * Improve understeer calculations | ||
| <ul> | ||
| <li> Releases archive: <a href=https://github.com/E66666666/GTAVManualTransmission/releases>GitHub Releases</a></li> | ||
| <li> Latest automatic build: <a href=https://ci.appveyor.com/project/E66666666/gtavmanualtransmission/build/artifacts>AppVeyor Artifacts</a></li> | ||
| </ul> | ||
| <br> | ||
| <b>Changelog</b><br> | ||
|
|
||
| <b>v4.7.0</b> | ||
| Due to size, read directly on GitHub. | ||
| <b>v4.8.0</b><br> | ||
| Due to size, <a href="https://github.com/E66666666/GTAVManualTransmission/releases/tag/v4.8.0">read directly on GitHub</a>!<br> | ||
|
|
||
| <a href="https://github.com/E66666666/GTAVManualTransmission/blob/v4.7.0/doc/changelog.md">Changelog</a> | ||
| <a href="https://github.com/E66666666/GTAVManualTransmission/blob/v4.7.0/doc/v4.7.0-release-notes.md">Release notes</a> | ||
| <a href="https://github.com/E66666666/GTAVManualTransmission/blob/v4.7.0/doc/changelog.md">Changelog</a><br> | ||
| <a href="https://github.com/E66666666/GTAVManualTransmission/blob/v4.7.0/doc/v4.7.0-release-notes.md">Release notes</a><br> | ||
|
|
||
| <br> | ||
| <b>Full changelog </b> <a href=https://github.com/E66666666/GTAVManualTransmission/blob/master/doc/changelog.md>available on GitHub</a> | ||
| <br> | ||
|
|
||
| <a href=https://forum.fivem.net/t/release-manual-transmission-steering-wheel-support-client/13769><b>🐌 View topic on FiveM.net Forums »</b></a> | ||
| <a href=https://discord.gg/gHee23U><b>💬 Chat along on Discord!</b></a> | ||
| <b>Contact</b> | ||
| <ul> | ||
| <li> <a href=https://discord.gg/gHee23U><b>💬 Chat along on Discord!</b></a></li> | ||
| <li> <a href=https://forum.fivem.net/t/release-manual-transmission-steering-wheel-support-client/13769><b>🐌 View topic on FiveM.net Forums »</b></a></li> | ||
| </ul> |