Difference between revisions of "Command line"
(→General emuclient options) |
|||
| Line 1: | Line 1: | ||
==Motivation== | ==Motivation== | ||
| − | It's not for performance at this time, but a future release may be able to run entirely from a Linux terminal without having to run a windowing system. This would improve performances on all hardwares, especially on small ones like the [http://www.raspberrypi.org/ raspberry pi] or [http://en.wikipedia.org/wiki/Thin_client thin clients].<br/> | + | It's not for performance at this time, but a future release may be able to run entirely from a Linux terminal without having to run a windowing system.<br/> |
| − | + | This would improve performances on all hardwares, especially on small ones like the [http://www.raspberrypi.org/ raspberry pi] or [http://en.wikipedia.org/wiki/Thin_client thin clients].<br/> | |
| + | It's also useful for other stuff like automation. | ||
==Linux + bluetooth== | ==Linux + bluetooth== | ||
| Line 10: | Line 11: | ||
* ps3_mac_address | * ps3_mac_address | ||
| − | + | This argument is mandatory. | |
* bt_device_index | * bt_device_index | ||
| − | + | The bluetooth device index (ex : 0 for hci0, 1 for hci1, etc).<br/> | |
| − | + | This argument is optional, default device index is 0. | |
* sixaxis_index | * sixaxis_index | ||
| − | + | The sixaxis index (ex : 0 for sixaxis 1, 1 for sixaxis 2, etc).<br/> | |
| − | + | This argument is optional, default sixaxis index is 0. | |
In another terminal:<br/> | In another terminal:<br/> | ||
| Line 22: | Line 23: | ||
* file_name | * file_name | ||
| − | + | The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br/> | |
| − | + | This argument is mandatory.<br/> | |
| − | + | Use backslashes to escape spaces. | |
==Linux or Windows + DIY USB adapter or GPP== | ==Linux or Windows + DIY USB adapter or GPP== | ||
| Line 33: | Line 34: | ||
emuclient options: | emuclient options: | ||
* file_name | * file_name | ||
| − | + | The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br/> | |
| − | + | This argument is mandatory. | |
* --serial --port /dev/ttyUSB0 | * --serial --port /dev/ttyUSB0 | ||
| − | serial port | + | The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.<br/> |
| − | + | Only mandatory for the DIY USB adapter. | |
* --joystick / --GPP / --360pad / --Sixaxis / --PS2pad | * --joystick / --GPP / --360pad / --Sixaxis / --PS2pad | ||
| − | + | The type of USB adapter. | |
* --precision 16 | * --precision 16 | ||
| − | + | The axis precision. Joystick: 16, Other adapters: 8. | |
* --refresh 4 | * --refresh 4 | ||
| − | + | The refresh period, in ms.<br/> | |
| − | + | Recommended values:<br/> | |
joystick/GPP/360pad/Sixaxis: 4 (250Hz)<br/> | joystick/GPP/360pad/Sixaxis: 4 (250Hz)<br/> | ||
PS2pad: 16 (62.5Hz) | PS2pad: 16 (62.5Hz) | ||
| Line 54: | Line 55: | ||
Mouse calibration is available through this interface. | Mouse calibration is available through this interface. | ||
* --status | * --status | ||
| − | + | Display controls in the terminal. | |
* --nograb | * --nograb | ||
| − | + | Do not grab the mouse cursor. | |
* --force-updates | * --force-updates | ||
| − | + | Send button+axis status even if there is no change (for compatibility with games like DNF). | |
* --subpos | * --subpos | ||
| − | + | Improve stick precision (counteract rounding issues). | |
* --keygen key | * --keygen key | ||
| − | + | Generate a key press at emuclient startup.<br/> | |
| − | + | The main use case for this is the automation of macro's execution.<br/> | |
| − | + | Events that are not generated by macros are ignored.<br/> | |
| − | + | The only way to quit is to add KEYDOWN ESCAPE at the end of the macro, or use --nograb and press ctrl+c into the terminal.<br/> | |
| − | + | Another use case is the sending of a single command (it requires to use a macro as no key up event is generated). | |
Revision as of 09:57, 20 June 2012
Contents
Motivation
It's not for performance at this time, but a future release may be able to run entirely from a Linux terminal without having to run a windowing system.
This would improve performances on all hardwares, especially on small ones like the raspberry pi or thin clients.
It's also useful for other stuff like automation.
Linux + bluetooth
In a terminal:
emu ps3_mac_address bt_device_index sixaxis_index
- ps3_mac_address
This argument is mandatory.
- bt_device_index
The bluetooth device index (ex : 0 for hci0, 1 for hci1, etc).
This argument is optional, default device index is 0.
- sixaxis_index
The sixaxis index (ex : 0 for sixaxis 1, 1 for sixaxis 2, etc).
This argument is optional, default sixaxis index is 0.
In another terminal:
emuclient --config file_name
- file_name
The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).
This argument is mandatory.
Use backslashes to escape spaces.
Linux or Windows + DIY USB adapter or GPP
In a terminal:
emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4
emuclient options:
- file_name
The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).
This argument is mandatory.
- --serial --port /dev/ttyUSB0
The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.
Only mandatory for the DIY USB adapter.
- --joystick / --GPP / --360pad / --Sixaxis / --PS2pad
The type of USB adapter.
- --precision 16
The axis precision. Joystick: 16, Other adapters: 8.
- --refresh 4
The refresh period, in ms.
Recommended values:
joystick/GPP/360pad/Sixaxis: 4 (250Hz)
PS2pad: 16 (62.5Hz)
General emuclient options
- --curses
curses terminal display.
Mouse calibration is available through this interface.
- --status
Display controls in the terminal.
- --nograb
Do not grab the mouse cursor.
- --force-updates
Send button+axis status even if there is no change (for compatibility with games like DNF).
- --subpos
Improve stick precision (counteract rounding issues).
- --keygen key
Generate a key press at emuclient startup.
The main use case for this is the automation of macro's execution.
Events that are not generated by macros are ignored.
The only way to quit is to add KEYDOWN ESCAPE at the end of the macro, or use --nograb and press ctrl+c into the terminal.
Another use case is the sending of a single command (it requires to use a macro as no key up event is generated).
