Difference between revisions of "Quick Start/en"

From GIMX
Jump to: navigation, search
(Updating to match new version of source page)
(Updating to match new version of source page)
 
Line 1: Line 1:
 
<languages />
 
<languages />
 +
{{Deprecated}}
 
==Start GIMX==
 
==Start GIMX==
  
Line 5: Line 6:
 
Launch gimx-launcher.
 
Launch gimx-launcher.
  
TODO: update screenshot
+
<div class="image200px">[https://gimx.fr/wiki/images/2/29/Start-gimx-launcher.jpg https://gimx.fr/wiki/images/2/29/Start-gimx-launcher.jpg]</div>
  
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.1_2_start_gimx-serial.jpg https://gimx.fr/img/screenshots/tuto/2.1_2_start_gimx-serial.jpg]</div>
+
==How to download a config file==
  
==Config file download==
+
<div class="mw-collapsible mw-collapsed">
 +
'''This section contains information about downloading configuration from gimx-launcher.'''
  
A few config files are shared by users of the GIMX community, and can be downloaded from gimx-launcher.<br />
+
Most config files shared by users of the GIMX community can be downloaded directly from gimx-launcher. <!-- TODO: link page --->
 
Please contribute by sharing your own configs in the [https://gimx.fr/forum/viewforum.php?f=9 Configuration and Requests forum section].
 
Please contribute by sharing your own configs in the [https://gimx.fr/forum/viewforum.php?f=9 Configuration and Requests forum section].
  
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.<br />
+
* 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. <div class="image200px">[https://gimx.fr/wiki/images/d/d3/Noconfigs.jpg https://gimx.fr/wiki/images/d/d3/Noconfigs.jpg]</div>
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.2_1_first_start.jpg https://gimx.fr/img/screenshots/tuto/2.2_1_first_start.jpg]</div>
 
  
The config file downloader is also available through the "Help>Get configs" menu entry.<br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.2_2_get_configs.png https://gimx.fr/img/screenshots/tuto/2.2_2_get_configs.png]</div>
 
  
The config file downloader displays all config files available to download:<br />
+
* The config file downloader is also available through the "Help>Get configs" menu entry. <div class="image200px">[https://gimx.fr/wiki/images/f/f0/Getconfigs.jpg https://gimx.fr/wiki/images/f/f0/Getconfigs.jpg]</div>
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.2_3_config_download.png https://gimx.fr/img/screenshots/tuto/2.2_3_config_download.png]</div>
 
  
The config name syntax is: <CONSOLE>_<GAME>_<AUTHOR>.xml or <CONSOLE>_<OS>_<DEVICE>_<AUTHOR>.xml.<br />
+
 
 +
* The config file downloader displays all config files available to download: <div class="image200px">[https://gimx.fr/wiki/images/9/96/Configdownload.jpg https://gimx.fr/wiki/images/9/96/Configdownload.jpg]</div>
 +
 
 +
 
 +
The config name syntax is: <CONSOLE>_<GAME>_<AUTHOR>.xml or <CONSOLE>_<OS>_<DEVICE>_<AUTHOR>.xml.
 
Examples:
 
Examples:
* PS3_Battlefield3_McKack.xml: config file built by McKack for the PS3 version of Battlefiled 3.
+
* '''LogitechDrivingForceGT_G29.xml''': config file that emulates '''G29''' to use with '''Logitech Driving Force GT'''.
* PS3_LINUX_X360Pad.xml: config file to use in Linux with a 360 pad and a PS3.
+
* '''PS3_Battlefield3_McKack.xml''': config file to use with '''mouse''' built by McKack for the PS3 version of '''Battlefield 3'''.
 +
* '''PS3_LINUX_X360Pad.xml''': config file to use in Linux with a '''360''' pad and a '''PS3'''.
 +
 
 +
Just select configurations you want to download and click <u>OK</u>, program will do the rest and you can now use config you've downloaded.
 +
 
 +
 
 +
</div>
  
 
==Mouse sensitivity conversion==
 
==Mouse sensitivity conversion==
 +
 +
<div class="mw-collapsible mw-collapsed">
  
 
This part is for the FPS gamers.
 
This part is for the FPS gamers.
 
Before using a prebuilt config file, you have to convert the sensitivity so that it matches your own mouse DPI.<br />
 
Before using a prebuilt config file, you have to convert the sensitivity so that it matches your own mouse DPI.<br />
Make sure to set the in-game sensitivity to the highest, and make sure to have your mouse tracking at its highest DPI setting (examples: Logitech G5 @2000DPI, Logitech G500 @5700DPI).
+
For most cases the in-game sensitivity should be set to the highest however there are some exceptions to that. If you get bad results try playing with the in-game sensitivity bar until you get good results. Also make sure to have your mouse tracking at its highest DPI setting (examples: Logitech G5 @2000DPI, Logitech G500 @5700DPI).
  
 
GIMX provides means to convert the sensitivity, knowing both the DPI of the source mouse (which can be embedded in the config file) and the DPI of the destination mouse.<br />
 
GIMX provides means to convert the sensitivity, knowing both the DPI of the source mouse (which can be embedded in the config file) and the DPI of the destination mouse.<br />
Line 40: Line 50:
  
 
===Gimx-config===
 
===Gimx-config===
 +
 +
<div class="mw-collapsible mw-collapsed">
 +
 
In gimx-launcher, select the config file, and click on the "File>Edit config" menu item.<br />
 
In gimx-launcher, select the config file, and click on the "File>Edit config" menu item.<br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_1_edit_config.png https://gimx.fr/img/screenshots/tuto/2.3_1_edit_config.png]</div><br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_1_edit_config.png https://gimx.fr/img/screenshots/tuto/2.3_1_edit_config.png]</div><br />
Line 51: Line 64:
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_5_multiplier_changed.png https://gimx.fr/img/screenshots/tuto/2.3_5_multiplier_changed.png]</div><br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_5_multiplier_changed.png https://gimx.fr/img/screenshots/tuto/2.3_5_multiplier_changed.png]</div><br />
 
Click on the "File>Save".
 
Click on the "File>Save".
 +
 +
</div>
  
 
===Gimx-fpsconfig===
 
===Gimx-fpsconfig===
 +
 +
<div class="mw-collapsible mw-collapsed">
 +
 
In gimx-launcher, select the config file, and click on the "File>Edit FPS config" menu item.<br />
 
In gimx-launcher, select the config file, and click on the "File>Edit FPS config" menu item.<br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_6_edit_fps_config.png https://gimx.fr/img/screenshots/tuto/2.3_6_edit_fps_config.png]</div><br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_6_edit_fps_config.png https://gimx.fr/img/screenshots/tuto/2.3_6_edit_fps_config.png]</div><br />
Line 63: Line 81:
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_7_sensitivity_converted.png https://gimx.fr/img/screenshots/tuto/2.3_7_sensitivity_converted.png]</div><br />
 
<div class="image200px">[https://gimx.fr/img/screenshots/tuto/2.3_7_sensitivity_converted.png https://gimx.fr/img/screenshots/tuto/2.3_7_sensitivity_converted.png]</div><br />
 
Click on the "File>Save".
 
Click on the "File>Save".
 +
 +
</div>
 +
</div>
  
 
==Play==
 
==Play==
  
 
===Ubuntu or Raspbian + bluetooth===
 
===Ubuntu or Raspbian + bluetooth===
 +
 +
<div class="mw-collapsible mw-collapsed">
  
 
Make sure to read the [[Main_Page#Hardware_requirements|Hardware requirements]].
 
Make sure to read the [[Main_Page#Hardware_requirements|Hardware requirements]].
  
 
====PS3====
 
====PS3====
 +
 +
<div class="mw-collapsible mw-collapsed">
  
 
# Open gimx-launcher.
 
# Open gimx-launcher.
Line 88: Line 113:
 
# Play.
 
# Play.
 
# Press Left Shift + Escape to quit.
 
# Press Left Shift + Escape to quit.
 +
 +
</div>
  
 
====PS4====
 
====PS4====
 +
 +
<div class="mw-collapsible mw-collapsed">
  
 
The PS4 only takes inputs from licensed controller.<br />
 
The PS4 only takes inputs from licensed controller.<br />
Line 135: Line 164:
 
# Play.
 
# Play.
 
# Press Left Shift + Escape to quit.
 
# Press Left Shift + Escape to quit.
 +
 +
</div>
 +
 +
</div>
  
 
===Ubuntu or Windows + DIY USB adapter===
 
===Ubuntu or Windows + DIY USB adapter===
 +
 +
<div class="mw-collapsible mw-collapsed">
  
 
====Controller authentication====
 
====Controller authentication====
Line 142: Line 177:
 
* Xbox 360: it is required to have a genuine wired controller (the play and charge cable won't work) wired to the PC at startup. In Windows, the 360 controller has to be unplugged/replugged before each spoof attempt.<br />
 
* Xbox 360: it is required to have a genuine wired controller (the play and charge cable won't work) wired to the PC at startup. In Windows, the 360 controller has to be unplugged/replugged before each spoof attempt.<br />
 
* Xbox One: it is required to have a genuine controller wired to the PC at startup. In Windows, the Xbox One controller has to be unplugged/replugged each time the AVR USB board or the console are power-cycled.<br />
 
* Xbox One: it is required to have a genuine controller wired to the PC at startup. In Windows, the Xbox One controller has to be unplugged/replugged each time the AVR USB board or the console are power-cycled.<br />
* PS4: it is required to have a genuine DS4 wired to the PC all the time.<br />
+
* PS4: it is required to have a genuine Dualshock 4 wired to the PC all the time.<br />
  
 
'''Note: when using a console that requires authentication, make sure to turn off the controller before connecting it to the PC.'''
 
'''Note: when using a console that requires authentication, make sure to turn off the controller before connecting it to the PC.'''
Line 163: Line 198:
 
# Play
 
# Play
 
# Press Left Shift + Escape to quit
 
# Press Left Shift + Escape to quit
 +
 +
</div>

Latest revision as of 22:01, 31 August 2018

Other languages:
Deutsch • ‎English • ‎français
This page is deprecated. It is kept for archival purposes.
Please visit to the current main page to see the latest documentation.

Start GIMX

Ubuntu or Windows

Launch gimx-launcher.

Start-gimx-launcher.jpg

How to download a config file

This section contains information about downloading configuration from gimx-launcher.

Most config files shared by users of the GIMX community can be downloaded directly from gimx-launcher. Please contribute by sharing your own configs in the Configuration and Requests forum section.

  • 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 that emulates G29 to use with Logitech Driving Force GT.
  • PS3_Battlefield3_McKack.xml: config file to use with mouse built by McKack for the PS3 version of Battlefield 3.
  • PS3_LINUX_X360Pad.xml: config file to use in Linux 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.


Mouse sensitivity conversion

This part is for the FPS gamers. Before using a prebuilt config file, you have to convert the sensitivity so that it matches your own mouse DPI.
For most cases the in-game sensitivity should be set to the highest however there are some exceptions to that. If you get bad results try playing with the in-game sensitivity bar until you get good results. Also make sure to have your mouse tracking at its highest DPI setting (examples: Logitech G5 @2000DPI, Logitech G500 @5700DPI).

GIMX provides means to convert the sensitivity, knowing both the DPI of the source mouse (which can be embedded in the config file) and the DPI of the destination mouse.
If the source DPI and the destination DPI are the same, there is no need to convert anything.

It's possible to do this with gimx-config or gimx-fpsconfig. These tools are further detailed on this page.

Gimx-config

In gimx-launcher, select the config file, and click on the "File>Edit config" menu item.

2.3_1_edit_config.png

This opens the config file with the gimx-config editor.
Click on the "Edit>Convert mouse sensitivity".

2.3_2_replace_mouse_dpi.png

If the config contains no DPI value, a first dialog box is displayed. Enter the source DPI and validate.
A dialog box is displayed. Enter the destination DPI and validate.

2.3_4_new_dpi.png

The sensitivity is converted in all profiles (hip fire = profile 1, ADS = profile 2).

2.3_5_multiplier_changed.png

Click on the "File>Save".

Gimx-fpsconfig

In gimx-launcher, select the config file, and click on the "File>Edit FPS config" menu item.

2.3_6_edit_fps_config.png

This opens the config file with the gimx-fpsconfig editor.
If the source DPI was saved into the config file, the mouse DPI should be different from 0.
Click on the "Convert sensitivity" button. A dialog box is displayed. Enter the destination DPI and validate.

2.3_7_convert_sensitivity.png

2.3_4_new_dpi.png

The sensitivity is converted for both hip fire and ADS.

2.3_7_sensitivity_converted.png

Click on the "File>Save".

Play

Ubuntu or Raspbian + bluetooth

Make sure to read the Hardware requirements.

PS3

  1. Open gimx-launcher.
  2. In the "Output" drop-down menu, select "Bluetooth / PS3".
  3. If no previous pairing was defined, you will be asked to create a new pairing. Click on "Yes".
  4. As requested, connect a Sixaxis / Dualshock 3, and click on "Yes".
  5. Select the pairing to use and click on "Validate".
  6. As requested, connect a bluetooth dongle, and click on "Yes".
  7. Save the bluetooth dongle address as you may wish to restore it later.
  8. Select the bluetooth dongle, and click on "Validate".
  9. Make sure you saved the dongle address, and click on "Yes".
  10. The dongle address will be modified to match the address of the Sixaxis / Dualshock 3.
  11. If you get an error message, buy a compatible bluetooth dongle.
  12. Unplug your sixaxis and if it doesn't power off by itself, press the PS button until it powers off.
  13. In the "Config" drop-down menu, select the configuration file to use.
  14. Click on "Start".
  15. Play.
  16. Press Left Shift + Escape to quit.

PS4

The PS4 only takes inputs from licensed controller.
In order to authenticate itself as a licensed controller, GIMX needs to be connected over bluetooth to a real Dualshock 4 all the time.

  • Raspbian-specific instructions

The bluetooth service is automatically started when a device tries to connect.
This is annoying since it will intercept the connection requests.
To disable the service, run the following command and reboot:

sudo update-rc.d bluetooth disable

Alternatively, you can stop the bluetooth service and move the bluetoothd binary:

sudo service bluetooth stop
cd /usr/sbin
sudo mv bluetoothd bluetoothd.bk

The drawback of this second method is that it will need to be performed again after each update of the bluez package.

  • AVR USB development board

An AVR USB development board is required for pairing the bluetooth dongle with the PS4.
The same board can be used to build a DIY USB adapter, but no USB to serial TTL converter is needed here.
The firmware with the needed "atmega32u4.hex" file is available at: https://gimx.fr/download/EMUPS4PAIRING.7z
Load this firmware as explained in the Firmware loading instructions.

  • First-start instructions
  1. Open gimx-launcher.
  2. In the "Output" drop-down menu, select "Bluetooth / PS4".
  3. If no previous pairing was defined, you will be asked to create a new pairing. Click on "Yes".
  4. As requested, connect a compatible bluetooth dongle, and click on "Yes".
  5. As requested, connect a Dualshock 4 with a micro USB cable, and click on "Yes".
  6. Select the pairing to use and click on "Validate".
  7. Connect the AVR USB board (e.g. Teensy 2.0) and click on "Yes".
  8. As requested, connect the AVR USB board to the PS4, and wait a few seconds.
  9. Connect the AVR USB board back to the computer, and click on "Yes".
  10. A new pairing should appear in the "Pairing" drop-down menu.
  11. Unplug the Dualshock 4.
  12. In the "Config" drop-down menu, select the configuration file to use.
  13. Click on "Start".
  14. Press on the PS button of the Dualshock 4.
  15. Play.
  16. Press Left Shift + Escape to quit.

Ubuntu or Windows + DIY USB adapter

Controller authentication

  • Xbox 360: it is required to have a genuine wired controller (the play and charge cable won't work) wired to the PC at startup. In Windows, the 360 controller has to be unplugged/replugged before each spoof attempt.
  • Xbox One: it is required to have a genuine controller wired to the PC at startup. In Windows, the Xbox One controller has to be unplugged/replugged each time the AVR USB board or the console are power-cycled.
  • PS4: it is required to have a genuine Dualshock 4 wired to the PC all the time.

Note: when using a console that requires authentication, make sure to turn off the controller before connecting it to the PC.

Connexion

Plug the AVR USB board (e.g. Teensy, Arduino Leonardo, Micro Pro...) to the console.
Plug the USB to UART adapter (e.g. CP2102, FT232RL...) to the computer.

Start

2.4_2_gimx-serial.png
  1. Turn on the console
  2. Select the adapter
  3. Select the serial port
  4. Select the configuration file to use
  5. Click on Start
  6. Press the PS button on Playstation consoles, or the Home button on Xbox consoles.
  7. Play
  8. Press Left Shift + Escape to quit