Difference between revisions of "Getting Started"

Latest revision as of 21:34, 3 July 2023

Plain virtual keyboard (Xbox One themed)

Spiral virtual keyboard

What is Joyxoff?

Joyxoff is a free and lightweight program that has the ability to simulate mouse and keyboard input using an Xinput compatible controller like an Xbox 360/One controller.

Key Features

Controller mapper.
Profiles creation.
Turn off Xbox 360 controllers.
Battery check.
Spiral virtual keyboard.
Plain virtual keyboard (Xbox One Themed).
Auto-disable on fullscreen.
Customizable absolute mouse movement (spring mode).
Runs on UAC prompts and sign-in screen.

System Requirements

■ OS	Peripherals
■ Windows 7 with platform update installed and DWM (Desktop Window Manager) enabled.	Xbox 360/One Controller.
■ Windows 8 or above.	Xbox 360/One Controller.

Supported Languages

Language	Translator
Brazilian Portuguese (Português do Brasil)	Ferracini
Colombian Spanish (Español Colombiano)	Francisco Quimbay
English US	Ferracini
French (Français)	Clems & Max
French (Français)	ld892012
German (Deutsche)	AltF4x36
Japanese (日本語)	Imai
Polish (Polski)	Patryk
Simplified Chinese (简体中文)	1x1xxx
Traditional Chinese (繁體中文)	1x1xxx

Remarks: All translations are fetched from our Crowdin project. If you want to add a new language, contact us and it will be added.

Download & Install Joyxoff

Download the latest version of Joyxoff. Check Joyxoff's website for the latest release.
Unpack the Joyxoff-x.x.x.x.rar file. Extract the installer with WinRAR .
Run the .msi file and follow installation wizard.
After the installation is completed, the Joyxoff will automatically open and display the Settings window.

Joyxoff Settings

Command line options

Syntax: Joyxoff.exe [command] <options>...

-turnoff (-n | -all)
Turn off one or more connected controllers. (Xbox 360 only)

Parameter	Description
`-n`	Turn off the n-th connected controller.
`-all`	Turn off all connected controllers.

Usage example: joyxoff.exe -turnoff -1

-close
Close an open JoyXoff instance.

Usage example: joyxoff.exe -close

-stdir config_path
Loads configuration files from specific folder paths.

Usage example: joyxoff.exe -stdir "D:\Documents\Config"

-import -srcpath joyx_filepath (-procpath process_filepath | -procname process_name | -desktop | -vk)
Import bindings.

Parameter	Description
`-srcpath joyx_filepath`	Specifies the path to the Joyxoff binding file (.joyx) to be imported.
`-procpath process_filepath`	Process path associated with the profile.
`-procname process_name`	Specifies the profile description.
`-desktop`	Desktop bindings.
`-vk`	Virtual keyboard bindings.

Usage example: joyxoff.exe -import -srcpath "D:\Documents\Profiles\Chrome.joyx" -procname "Google Chrome"

-export (-destpath joyx_filepath (-procpath process_filepath | -procname process_name | -desktop | -vk)) |(-all -destfolder folder_path)
Export bindings.

Parameter	Description
`-destpath joyx_filepath`	Specifies the path to the Joyxoff binding file (.joyx) to be exported.
`-procpath process_filepath`	Process path associated with the profile.
`-procname process_name`	Specifies the profile description.
`-desktop`	Desktop bindings.
`-vk`	Virtual keyboard bindings.
`-all`	All bindings.

Usage example: joyxoff.exe -export -all -destfolder "D:\Documents\Profiles"

-add -procpath process_filepath [-procname process_name]
Adds a profile.

Parameter	Description
`-procpath process_filepath`	Process path associated with the profile.
`-procname process_name`	(Optional) Specifies the profile description.

Usage example: joyxoff.exe -add -procpath "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" -procname "My custom description for Chrome"

-del (-procpath process_filepath | -procname process_name)
Deletes a profile.

Parameter	Description
`-procpath process_filepath`	Process path associated with the profile.
`-procname process_name`	Specifies the profile description.

Usage example: joyxoff.exe -del -procpath "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"

@@ Line 1: / Line 1: @@
 __NOTOC__
+[[File:Plainvk.png|thumb|Plain virtual keyboard (Xbox One themed)]]
+[[File:Spiralvk.png|thumb|Spiral virtual keyboard]]
 ==What is Joyxoff?==
-Joyxoff is a free and lightweight program that has the ability to emulate a mouse and/or keyboard using an Xinput compatible controller like an Xbox 360/One controller, and it also comes with a virtual keyboard.
+Joyxoff is a free and lightweight program that has the ability to simulate mouse and keyboard input using an Xinput compatible controller like an Xbox 360/One controller.
 ===Key Features===
@@ Line 8: / Line 9: @@
 * Profiles creation.
 * Turn off Xbox 360 controllers.
+* Battery check.
 * Spiral virtual keyboard.
+* Plain virtual keyboard (Xbox One Themed).
 * Auto-disable on fullscreen.
 * Customizable absolute mouse movement (spring mode).
-* Run on UAC prompts and sign-in screen.
+* Runs on UAC prompts and sign-in screen.
 ==System Requirements==
@@ Line 31: / Line 34: @@
 ! Language !! Translator
 |-
-| English
+| Brazilian Portuguese (Português do Brasil) || Ferracini
-|rowspan="2" | Diego
+|-
+| Colombian Spanish (Español Colombiano) || Francisco Quimbay
+|-
+| English US || Ferracini
+|-
+| rowspan="2" | French (Français) || Clems & Max
 |-
-| Brazilian Portuguese (Português do Brasil)
+| ld892012
 |-
-|Japanese || Imai
+| German (Deutsche) || AltF4x36
 |-
-| Traditional Chinese
+| Japanese (日本語) || Imai
+|-
+| Polish (Polski) || Patryk
+|-
+| Simplified Chinese (简体中文)
 |rowspan="2" | 1x1xxx
 |-
-| Simplified Chinese
+| Traditional Chinese (繁體中文)
-|-
-| French (Français) || Clems & Max
 |}
+<b>Remarks:</b> All translations are fetched from our '''[https://crowdin.com/project/joyxoff Crowdin project]'''. If you want to add a new language, '''[mailto:diegoferracini@joyxoff.com?subject=Translation contact us]''' and it will be added.
 ==Download & Install Joyxoff==
 #Download the latest version of Joyxoff. Check [http://www.joyxoff.com Joyxoff's website] for the latest release.
-#Unpack the <code>Joyxoff-x.x.x.x.rar</code> file.
+#Unpack the <code>Joyxoff-x.x.x.x.rar</code> file. Extract the installer with [http://www.rarlab.com/download.htm WinRAR ].
-#Extract the installer with [http://www.rarlab.com/download.htm WinRAR ], run the '''.msi''' file and follow installation wizard.
+#Run the '''.msi''' file and follow installation wizard.
 #After the installation is completed, the Joyxoff will automatically open and display the ''Settings'' window.
 ===Joyxoff Settings===
-*[[Overview:Initial Setup|Initial Setup]]
+*[[Initial Setup]]
-*[[Overview:Button bindings|Button bindings]]
+*[[Bindings]]
-*[[Overview:Creating Profiles|Creating Profiles]]
 ==Command line options==
-<big>Arguments:</big>
+Syntax: <code>Joyxoff.exe [command] <options>...</code>
+<br><br>
+* <code>-turnoff (-n | -all)</code> <br> '''Turn off one or more connected controllers. (Xbox 360 only)'''
 {|class="wikitable"
-|<code>-o -''n''</code>
+|-
+! Parameter !! Description
+|-
+|<code>-n</code>
 |Turn off the n-th connected controller.
 |-
-|<code>-a</code>
+|<code>-all</code>
 |Turn off all connected controllers.
+|}
+''Usage example:'' <code>joyxoff.exe -turnoff -1</code>
+<br><br>
+* <code>-close</code> <br> '''Close an open JoyXoff instance.'''
+''Usage example:'' <code>joyxoff.exe -close</code>
+<br><br>
+* <code>-stdir config_path</code> <br> '''Loads configuration files from specific folder paths.'''
+''Usage example:'' <code>joyxoff.exe -stdir "D:\Documents\Config"</code>
+<br><br>
+* <code>-import -srcpath joyx_filepath (-procpath process_filepath | -procname process_name | -desktop | -vk)</code> <br> '''Import bindings.'''
+{|class="wikitable"
+|-
+! Parameter !! Description
+|-
+|<code>-srcpath joyx_filepath</code>
+|Specifies the path to the Joyxoff binding file (.joyx) to be imported.
+|-
+|<code>-procpath process_filepath</code>
+|Process path associated with the profile.
+|-
+|<code>-procname process_name</code>
+|Specifies the profile description.
+|-
+|<code>-desktop</code>
+|Desktop bindings.
+|-
+|<code>-vk</code>
+|Virtual keyboard bindings.
+|}
+''Usage example:'' <code>joyxoff.exe -import -srcpath "D:\Documents\Profiles\Chrome.joyx" -procname "Google Chrome"</code>
+<br><br>
+* <code>-export (-destpath joyx_filepath (-procpath process_filepath | -procname process_name | -desktop | -vk)) |(-all -destfolder folder_path)</code> <br> '''Export bindings.'''
+{|class="wikitable"
+|-
+! Parameter !! Description
+|-
+|<code>-destpath joyx_filepath</code>
+|Specifies the path to the Joyxoff binding file (.joyx) to be exported.
+|-
+|<code>-procpath process_filepath</code>
+|Process path associated with the profile.
+|-
+|<code>-procname process_name</code>
+|Specifies the profile description.
+|-
+|<code>-desktop</code>
+|Desktop bindings.
+|-
+|<code>-vk</code>
+|Virtual keyboard bindings.
+|-
+|<code>-all</code>
+|All bindings.
+|}
+''Usage example:'' <code>joyxoff.exe -export -all -destfolder "D:\Documents\Profiles"</code>
+<br><br>
+* <code>-add -procpath process_filepath [-procname process_name]</code> <br> '''Adds a profile.'''
+{|class="wikitable"
+|-
+! Parameter !! Description
+|-
+|<code>-procpath process_filepath</code>
+|Process path associated with the profile.
 |-
-|<code>-c</code>
+|<code>-procname process_name</code>
-|Close an open Joyxoff instance.
+| (Optional) Specifies the profile description.
 |}
-''Usage example:'' <code>joyxoff.exe -o -1 -c</code>
+''Usage example:'' <code>joyxoff.exe -add -procpath "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" -procname "My custom description for Chrome"</code>
+<br><br>
+* <code>-del (-procpath process_filepath | -procname process_name)</code> <br> '''Deletes a profile.'''
+{|class="wikitable"
+|-
+! Parameter !! Description
+|-
+|<code>-procpath process_filepath</code>
+|Process path associated with the profile.
+|-
+|<code>-procname process_name</code>
+| Specifies the profile description.
+|}
+''Usage example:'' <code>joyxoff.exe -del -procpath "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"
 <br><br>
-[[Category:Introductory pages]] [[Category:Installation]]
+[[Category:Introductory]]