Game Setup - Keenny38/ModernTinyPedals GitHub Wiki
Game Setup
NeoPedal reads telemetry from the game's shared memory, and for Le Mans Ultimate also from the game's local REST API. Set up your game once, then select it in the app.
Summary
| Game | Windows | Linux |
|---|---|---|
| Le Mans Ultimate | Nothing to install. Turn on Enable Plugins in the game. |
Requires a third-party plugin, see below. |
| rFactor 2 | rF2SharedMemoryMapPlugin | Wine version of the plugin |
Display mode
Set the game display mode to Borderless or Windowed. In exclusive fullscreen, the game draws over every other window and the overlays are hidden.
Select the game in the app
The setup wizard asks for your game on first launch. To change it later, open the API menu of the main window and select Le Mans Ultimate or rFactor 2.
- The status bar at the bottom of the main window shows the selected game and its connection state (click it to refresh). Game options are in
API>Options. API>Restart APIreconnects to the game.API>Remember API Selection from Presetstores the game in each preset (on by default), so a preset made for rFactor 2 selects rFactor 2 when loaded.Le Mans Ultimate (legacy)(LMU through the rFactor 2 plugin) is only listed afterAPI>Enable Legacy API Selection. It is deprecated and not recommended.
Overlays appear once your car is on track and hide otherwise (Auto Hide, see Getting Started).
Le Mans Ultimate
Windows
- In the game, open
Settings>Gameplayand turnEnable Pluginson. - Select
Le Mans Ultimatein the app (default on Windows).
No plugin needs to be installed: LMU has its own shared memory API.
Linux
LMU's built-in API can be selected on Linux, but may need a third-party plugin to be readable from Linux.
LMU REST API (automatic)
With Le Mans Ultimate, the app also reads the game's local REST API. It is enabled by default and needs no setup. It provides:
- the in-game chat (Chat overlay) and contacts between cars (Dashboard HUD event log, Results & Replays page);
- the replays saved by the game, which the Results & Replays page can open and control;
- team stints (fuel, energy and tyre wear of each driver of your car) and the allowed tyres of the session, used by the Race Calculator;
- the game's fuel and energy estimate per lap, used until a lap of the car is recorded on the track;
- the official track layout, track edges and pit lane, used by the Telemetry Viewer;
- in overlays: official delta, invalid lap, puncture, optimal tyre temperature, yellow flags per sector and full course yellow, wind, ride height, speed limiter reminder, engine overheating;
- the setup name loaded in the game, kept with each recorded lap.
The app only reads data. Commands are sent to the game only when you ask for them (for example opening a replay), never automatically.
If REST data does not show up, check API > Options (with Le Mans Ultimate selected):
enable_restapi_accessmust be on.url_port(default6397) must match theWebUI portvalue of the game fileUserData\player\Settings.JSON. This value can change in some situations.enable_vehicle_info,enable_race_info,enable_garage_setup_info,enable_session_infoandenable_weather_infoturn individual data groups on or off.
The performance monitor (Help > Widget Performance, Game data section) shows the age of the shared memory data and the state of each REST data group. Details of each option: Le Mans Ultimate API.
rFactor 2
Windows
- Download
rFactor2SharedMemoryMapPlugin64.dllfrom the rF2SharedMemoryMapPlugin page. - Copy it to
rFactor 2\Bin64\Plugins(create thePluginsfolder if it is missing). - In the game, open
Settings>Gameplay, find thePluginssection and turn onrFactor2SharedMemoryMapPlugin64.dll. - Restart the game.
- Select
rFactor 2in the app.
If the plugin does not appear in the game (no rFactor2SharedMemoryMapPlugin64.dll entry in CustomPluginVariables.JSON), install the Visual C++ 2013 runtime provided in the game's Support\Runtimes folder.
Linux
Use the Wine build of the plugin, installed and enabled the same way.
rFactor 2 REST API
rFactor 2 also has a REST API (port 5397 by default, WebUI port in UserData\player\player.JSON), used for garage setup, session and weather data. See rFactor 2 API.
Auto backup of car setups
API > Enable Auto Backup Car Setup (LMU and rFactor 2) saves a copy of your car setup in the carsetups folder each time you leave the pit lane with a changed setup. It needs the Stats module and the enable_restapi_access and enable_garage_setup_info API options.
Still not working?
See Troubleshooting.