Difference between revisions of "Command line/en"
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 2: | Line 2: | ||
==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.<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/> | + | 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. | It's also useful for other stuff like automation. | ||
==Linux + bluetooth== | ==Linux + bluetooth== | ||
| − | In a terminal:<br/> | + | In a terminal:<br /> |
emu ps3_mac_address bt_device_index sixaxis_index | emu ps3_mac_address bt_device_index sixaxis_index | ||
| Line 14: | Line 14: | ||
:This argument is mandatory. | :This argument is mandatory. | ||
* bt_device_index | * bt_device_index | ||
| − | :The bluetooth device index (ex : 0 for hci0, 1 for hci1, etc).<br/> | + | :The bluetooth device index (ex : 0 for hci0, 1 for hci1, etc).<br /> |
This argument is optional, default device index is 0. | 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/> | + | :The sixaxis index (ex : 0 for sixaxis 1, 1 for sixaxis 2, etc).<br /> |
:This argument is optional, default sixaxis index is 0. | :This argument is optional, default sixaxis index is 0. | ||
| − | In another terminal:<br/> | + | In another terminal:<br /> |
emuclient --config file_name | emuclient --config file_name | ||
* file_name | * file_name | ||
| − | :The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br/> | + | :The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br /> |
| − | :This argument is mandatory.<br/> | + | :This argument is mandatory.<br /> |
:Use backslashes to escape spaces. | :Use backslashes to escape spaces. | ||
==Linux or Windows + DIY USB adapter or GPP== | ==Linux or Windows + DIY USB adapter or GPP== | ||
| − | In a terminal:<br/> | + | In a terminal:<br /> |
emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4 | emuclient --config file_name --serial --port /dev/ttyUSBX --joystick --precision 16 --refresh 4 | ||
emuclient options: | emuclient options: | ||
* file_name | * file_name | ||
| − | :The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br/> | + | :The name of the config file, in the ~/.emuclient/config directory (ex : toto.xml).<br /> |
:This argument is mandatory. | :This argument is mandatory. | ||
* --serial --port /dev/ttyUSB0 | * --serial --port /dev/ttyUSB0 | ||
| − | :The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.<br/> | + | :The serial port. Ex: /dev/ttyUSB0 in Linux, COM4 in windows.<br /> |
:Only mandatory for the DIY USB adapter. | :Only mandatory for the DIY USB adapter. | ||
* --joystick / --GPP / --360pad / --Sixaxis / --PS2pad | * --joystick / --GPP / --360pad / --Sixaxis / --PS2pad | ||
| Line 45: | Line 45: | ||
:The axis precision. Joystick: 16, Other adapters: 8. | :The axis precision. Joystick: 16, Other adapters: 8. | ||
* --refresh 4 | * --refresh 4 | ||
| − | :The refresh period, in ms.<br/> | + | :The refresh period, in ms.<br /> |
| − | :Recommended values:<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 53: | Line 53: | ||
* --curses | * --curses | ||
| − | :[http://en.wikipedia.org/wiki/Curses_%28programming_library%29 curses] terminal display.<br/> | + | :[http://en.wikipedia.org/wiki/Curses_%28programming_library%29 curses] terminal display.<br /> |
:Mouse calibration is available through this interface. | :Mouse calibration is available through this interface. | ||
* --status | * --status | ||
| Line 64: | Line 64: | ||
:Improve stick precision (counteract rounding issues). | :Improve stick precision (counteract rounding issues). | ||
* --keygen key | * --keygen key | ||
| − | :Generate a key press at emuclient startup.<br/> | + | :Generate a key press at emuclient startup.<br /> |
| − | :The main use case for this is the automation of macro's execution.<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/> | + | :Events that are not generated by macros are ignored.<br /> |
| − | :The only way to quit is to add KEYDOWN LSHIFT and KEYDOWN ESCAPE at the end of the macro, or use --nograb and press ctrl+c into the terminal.<br/> | + | :The only way to quit is to add KEYDOWN LSHIFT and 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). | :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 10:00, 12 July 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 LSHIFT and 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).
