Guide

From GIMX
Jump to: navigation, search

This guide was generated based on the following options:

  • Operating System: windows
  • Platform: pc
  • Control Scheme: SteeringWheel
  • Connection Type: USB

If you want to change any of these options please go back to the main page.

Capabilities and limitations

GIMX allows to emulate a G27 for PC. It is possible to run GIMX on the target PC. All controls are working: wheel and pedals axes, wheel buttons, shifter buttons. Combining multiple devices (wheel, pedals, shifter, ...) is possible. Force feedback is supported for all Windows-compatible force feedback wheels. Auto-adjustment of the wheel range is only supported for Logitech wheels older than the G29/G920, and rpm led control is only supported for the G27.



In the diagram below, the computer is represented by the console. It is possible to have the game and GIMX run on the same computer. In this case both ends of the adapter are plugged to the same computer.

Schemewheel.png

Hardware requirements

  1. Computer
    PC running Windows 7 or later
  2. USB adapter
    This is an adapter that you can either buy from the GIMX shop or build yourself:
    Forget about using any other USB to USB cable (like file transfer cables, or direct cables), they are not suited to this use.

Before Installation

System Preparation

  1. Install all Windows updates (otherwise GIMX setup may refuse installation).
  2. GIMX setup will request Windows to create a restore point at the beginning of the installation. As GIMX installs a few drivers, you may want to turn on system restore before installing (if you turned it off).

GIMX Installation

Depending on your Windows version download the correct package:

If you are unsure about your Windows version look for the "System type" in the System properties.
Double-click on the downloaded file and proceed with the installation.

Install Logitech Gaming Software (LGS)

Install either the 64-bit version or the 32-bit version on the target computer, depending on the Windows version running on it.

Downloading configurations

Logitech wheels

If you own a Logitech wheel that has a pre-made configuration, gimx-launcher will download it automatically.
In such case you will not be prompted to download a configuration on first start, and a configuration will appear in the "Config" drop-down menu.
Make sure you have installed LGS, otherwise gimx-launcher may not download the right configuration.

Downloading configurations directly from gimx-launcher (recommended)

Most config files shared by users of the GIMX community can be downloaded directly from gimx-launcher. To check all available configurations please refer to Configurations Index page on this wiki.

Please contribute by sharing your own configs in the Configuration and Requests forum section.

  • Run gimx-launcher
  • The first time gimx-launcher is started, if there is no config file present on the PC, a message box will ask you if config files should be downloaded.
    Noconfigs.jpg


  • The config file downloader is also available through the "Help>Get configs" menu entry.
    Getconfigs.jpg


  • The config file downloader displays all config files available to download:
    Configdownload.jpg


The config name syntax is: <CONSOLE>_<GAME>_<AUTHOR>.xml or <CONSOLE>_<OS>_<DEVICE>_<AUTHOR>.xml. Examples:

  • LogitechDrivingForceGT_G29.xml: config file to use with Logitech Driving Force GT for emulating a G29.
  • PS3_Battlefield3_McKack.xml: config file to use with mouse built by McKack for the PS3 version of Battlefield 3.
  • PS3_X360Pad.xml: config file to use with a 360 pad and a PS3.

Just select configurations you want to download and click OK, program will do the rest and you can now use config you've downloaded.

If you can't find configuration that matches your needs in gimx-launcher nor in Configurations Index you may need to create one by yourself.

Downloading configurations manually

Some configurations aren't pushed to the repository for various reasons including:

  • lack of ADS (right-click aim) profile
  • mislabeled controls
  • being untested
  • low quality

Note: As for time of writing this article all configurations need to be hosted on the forum now so they will never get deleted. Some older configs however may be hosted on external download servers and you will need to download them from these servers first in order to use them.

If you want to try them anyway, use the following guide:

  • Go directly to the Configurations Index page on this wiki, select configuration you wish to download and click "More Info" link.
  • Copy config to clipboard or download it from external server
  • Open your gimx-launcher
  • Click File->Open config directory
  • Create a new text file with name you wish to use (make sure to add .xml after the name), open it using notepad and paste data. Then save the file.
  • Click File->Refresh in gimx-launcher so config will appear on the configurations list or simply restart gimx-launcher.


Editing configurations

Sometimes you would want to edit a configuration to match your needs. That includes:

  • Reassigning keys
  • Increasing/Decreasing sensitivity
  • Playing with other values

In order to do it, please check following tutorial.

Creating configurations

If you can't find configuration that satisfies you, for example when:

  • Using Steering wheel that there's no ready-made config for
  • Trying to play a game using a mouse that there's no premade config for
  • Any other cases when you want to customize configuration to the max

You may need to create your own configuration. In order to do it please check Creating Configurations tutorial.

Loading firmware

This part explains how to load the right firmware into the adapter.


Preparation for flash

Connect both ends of the adapter to the computer, as shown in the picture below.

Schemeflash.png

Flashing firmware for official GIMX adapter

  1. Run gimx-launcher.
  2. Click on "Help > Update firmware".
  3. Select EMUG27PC, click on "Load", and follow the instructions. Upon success a "Firmware loaded successfully!" message should be displayed.

Flashing firmware for other adapters

Firmwares

Download link

GIMX adapter or Arduino-compatible atmega32u4-based boards

Using gimx-loader

(easy method, recommended)

  • Install the GIMX software.
  • Run gimx-launcher.
  • Click on "Help > Update firmware".
  • Select a firmware, click on "Load", and follow the instructions.

Upon success a "Firmware loaded successfully!" message should be displayed.

Notes:

  • gimx-loader is available since GIMX 6.8
  • it is not necessary to download the firmwares since they are provided by the installer

Using Avrdude

(hard method, not recommended)

  • Download the Arduino Leonardo drivers and unzip the archive.
  • Right-click on the arduino.inf file and click on Install.
  • Make sure that the USB to UART board (e.g. CP2102) is connected and powered, and that the wiring with the atmega32u4 board is correct (see above GND->GND, TXD->RXD, RXD->TXD).
  • Make sure that the atmega32u4 board is connected to your computer and powered.
  • You should now have the atmega32u4 board connected via the USB-to-UART and via its on-board USB port
  • Download the Arduino Builder tool and extract the archive (using 7zip).
  • Open a command window (cmd) and change the current directory to the extracted ArduinoBuilder folder. e.g. cd "C:\Path\To\ArduinoBuilder\", or simply shift-right-click in windows file explorer and click "open command window here."
  • Type the following text but don't press enter:
avrdude -p atmega32u4 -c avr109 -P COMx -D -U flash:w:<path to atmega32u4.hex>:i
  • Make sure to replace "<path to atmega32u4.hex>" in the command line with the location of the firmware to load (for example: C:\Users\YourUserName\Downloads\firmwares-5.0\EMUPS4\atmega32u4.hex).
  • Open the device manager, and expand the "Ports" item. You should see your USB-to-UART driver (e.g. CP2102) connected to a COM port and the Arduino connected to another COM port. *Neither* of these are the COM ports you're looking for, in all likelihood.
  • Unplug/replug the atmega32u4 on-board USB (not the USB-to-UART) from your computer (doing this on the computer side rather than the Arduino side may be easier). When you replug it back in, watch the device manager, and notice which COM port is opened when the bootloader starts up. Ideally, this will be the same every time it is disconnected and reconnected. *THIS* is the COM port you want!
  • Change the "x" in "COMx" in the above command to the number of the COM port that the bootloader uses.
  • Unplug and replug the atmega32u4 USB again, and as soon the bootloader COM shows up, press enter to execute your command
  • The bootloader is executed very briefly. You may have to make a few attempts before the firmware gets loaded correctly!
  • If successful, avrdude should say "avrdude done. Thank you."

In GNU/Linux, the avrdude command is:

avrdude -p atmega32u4 -c avr109 -P /dev/ttyACM0 -D -U flash:w:atmega32u4.hex:i

(make sure to adjust the port and the file)

Teensy boards

Teensy boards can be easily flashed using the Teensy Loader.
It is only compatible with genuine teensy boards.

Other tools (DFU-compatible boards)

There are a few other tools that can be used to load the hex file:

dfu-programmer example:

   sudo dfu-programmer at90usb162 erase
   sudo dfu-programmer at90usb162 flash at90usb162.hex
   sudo dfu-programmer at90usb162 reset

Connecting to the console

Now you need to connect the USB adapter to both your computer and the console.

In this guide official GIMX adapter from GIMX shop is used. If you use a DIY USB adapter, several steps may be different from this guide.

In the diagram below, the target computer is represented by the console. It is possible to have the game and GIMX run on the same computer. In this case both ends of the adapter are plugged to the same computer.

Schemewheel.png

  1. Connect AVR board (USB cable) to the console
  2. Connect UART converter (the other side) to the computer

Playing with GIMX

USB Adapter

Check points below to be sure that you are ready to play:

  • Make sure your device is connected to both, console and computer. If you are unsure how to do this see this guide
  • Check if you have correct firmware loaded on USB adapter

If you are sure you did everything correctly you can proceed to the last part.

GIMX Options

On the gimx-launcher screen there are following options:

Launcher.png
  • Output - Set to "GIMX adapter"
  • Port - There should be only one entry available, if it's empty then you adapter is not detected
  • Input - Should be "Physical Devices"
  • Config - There you can select configuration you want to use
  • Messages - "None" for playing, "log file" for troubleshooting
  • Mouse capture - "Auto" is recommended. You may force enabling or disabling mouse capture selecting either "Yes" or "No".

Playing with GIMX

  1. Click on "Check". It may indicate something wrong with the configuration, or important information (it will say if a device is missing).
  2. Click on "Start". If "Mouse capture" is set to "Yes" or your config has mouse or keyboard bindings and "Mouse capture" is set to "Auto", your mouse will be grabbeb.
  3. Play
  4. Exit gimx by pressing "Shift+Esc"