| imagealt = RehidHelper banner as used on the HOME Menu
| for3ds = 1
| for3ds = 1
| developers = hax0kartik
| developers = hax0kartik
Line 12:
Line 12:
| universaldb = 3ds/rehid
| universaldb = 3ds/rehid
}}
}}
'''Rehid''' is a rewrite of the 3DS' hid module, that allow for the remapping of buttons or the touch screen in 3DS titles.
'''rehid''' is a rewrite of the 3DS' hid module that allows you to flexibly remap buttons or the touch screen in 3DS titles.
==Features==
* '''Remapping Buttons''' - Rehid allows for the remapping of buttons or button combos to different buttons or combos.
* '''Remapping Directional Input''' - Rehid also lets you remap the circle pad or the C stick, and can map the circle pad or D-pad to each other.
* '''Remapping Touch''' - You can assign button inputs to points on the touchscreen, or map certain areas on the touchscreen to button.
* '''Per Game Remaps''' - Rehid allows you to save configurations to a specific title, or set a remap to be used globally.
* '''RehidHelper''' - Rehid features an app to help you download Rehid's sysmodules, scan QR codes to install configurations, or disable Rehid.
== Features ==
==Installation==
* '''Remapping Buttons''' - Rehid allows you to remap buttons or combinations of buttons to different buttons or combos.
* '''Remapping Directional Input''' - Rehid also lets you remap the circle pad, remap the C stick, and/or map the circle pad and D-pad to each other.
* '''Remapping Touch''' - You can assign button inputs to points on the touchscreen, or map specific parts of the touchscreen to buttons.
* '''Per-Game Remaps''' - Rehid allows you to choose between applying a remap to only one specific title or applying it to all titles at once.
* '''RehidHelper''' - Rehid features an app to help you download its sysmodules, scan QR codes to install remaps, or disable rehid entirely.
== Installation ==
<tabber>
<tabber>
|-|Universal Updater=
|-|Universal-Updater=
<span>
<span>
=== What you need ===
===what you need===
* A working internet connection
* A working internet connection
* [[3DS:Universal-Updater|Universal-Updater]] installed on your console
* [[3DS:Universal-Updater|Universal Updater]] installed on your console
* [[3DS:luma3DS|Luma3DS]] updated to 13.0+
* [[3DS:luma3DS|Luma3DS]] updated to 13.0+
=== Instructions ===
===instructions===
# Power on your console
# Power on the console
# Launch '''Universal-Updater'''
# Launch '''Universal-Updater'''
# Select the magnifying glass on the bottom screen, then search for '''rehid'''
# Tap the magnifying glass on the bottom screen, then search for '''rehid'''
# Press {{B|A}} while hovering over '''rehid''' from the list of homebrew
# Press {{B|A}} while hovering over '''rehid''' from the list of homebrew
# Choose <code>rehidhelper.cia</code>
# Choose <code>rehidhelper.cia</code>
# Wait until the app finishes installing
# Wait until the app installs
# Close '''Universal-Updater'''
# Close '''Universal-Updater'''
# Launch '''RehidHelper''' and select <code>Download Rehid</code>
# Launch '''RehidHelper''' and select <code>Download Rehid</code>
# Wait for it to download and reboot, then press {{B|B}} to exit the app
# Wait for it to download and reboot, then press {{B|B}} to exit the app
# Power off your console
# Power off your Console
# While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]]
# While holding {{B|SELECT}}, power on your console to enter Luma3DS configuration
# Turn on '''Enable loading external FIRMs and modules''' if it is not already enabled
# Ensure that "'''Enable loading external FIRMs and modules'''" is selected
# Press {{B|START}} to save and exit
# Press {{B|START}} to save and exit
</span>
</span>
|-|Manual=
|-|Manual=
<span>
<span>
=== What you need ===
===what you need===
* The latest release of {{GitHub|hax0kartik/rehid/releases/latest|'''rehid'''}} (the <code>0004013000001D02.cxi</code> and <code>rehidhelper.cia</code> files)
* the latest release of [https://github.com/hax0kartik/rehid/releases/latest Rehid] (the <code>0004013000001D02.cxi</code> and <code>rehidhelper.cia</code> files)
* [[3DS:FBI|FBI]] installed on your console
* [[3DS:FBI|FBI]] installed on your console
* A v13.0 or higher version of [[3DS:luma3DS|Luma3DS]]' <code>boot.firm</code> on the root of your SD card
* [[3DS:luma3DS|Luma3DS]] updated to 13.0+
=== Instructions ===
===Instructions===
# Copy <code>0004013000001D02.cxi</code> to <code>sd:/luma/sysmodules/</code>
# Copy <code>0004013000001D02.cxi</code> to <code>sd:/luma/sysmodules/</code>
#* Create the folder <code>sysmodules</code> if it doesn't exist
#* Create the folder <code>sysmodules</code> if it doesn't exist
Line 65:
Line 61:
# Launch '''FBI''' and select <code>SD</code> -> <code>rehidhelper.cia</code> -> <code>Install and delete CIA</code>
# Launch '''FBI''' and select <code>SD</code> -> <code>rehidhelper.cia</code> -> <code>Install and delete CIA</code>
# Press {{B|A}} and wait for the CIA to install, then exit '''FBI'''
# Press {{B|A}} and wait for the CIA to install, then exit '''FBI'''
# Power off your console
# Power off your Console
# While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]]
# While holding {{B|SELECT}}, power on your console to enter Luma3DS configuration
# Turn on '''Enable loading external FIRMs and modules''' if it is not already enabled
# Ensure that "'''Enable loading external FIRMs and modules'''" is selected
# Press {{B|START}} to save and exit
# Press {{B|START}} to save and exit
</span>
</span>
</tabber>
</tabber>
== Usage ==
==Usage==
=== Adding configs ===
===Adding configs===
# Open the [https://mikahjc.github.io/3dsRemapBuilder/config 3DS Remap Builder] and configure your key mappings
# Go to [https://mikahjc.github.io/3dsRemapBuilder/config 3DS Remap Builder] to configure your key mappings
# When finished, click on '''Show as QR code'''
# When finished click on '''Show as QR code'''
#* If you are unable to scan QR codes on your console, instead click '''Build this remap''' and place the downloaded <code>rehid.json</code> into the folder <code>sd:/rehid</code>, or <code>sd:/rehid/<title ID>/</code> if you only want to remap a specific game. You can find the title ID of your game using [https://3dsdb.com/ 3dsdb]
#* If you are unable to scan QR codes on your console, instead click '''Build this remap''' and place the downloaded <code>rehid.json</code> into a <code>rehid</code> folder on the root of your SD card, or <code>rehid/(title ID)/</code> to remap a specific game. You can find the title ID of your game using [https://3dsdb.com/ 3dsdb]
# Power on your console and launch '''RehidHelper'''
# Power on your console and launch RehidHelper
# Select '''Scan QR Code''' and scan the generated QR code from the website
# Select Scan QR Code and scan the generated QR code from the website
# Press {{B|A}} to proceed
# Press {{B|A}} to proceed
# Select a title from the list for the remap to be applied to, or select global to apply it to the entire console
# Select a title from the list for the remap to be applied to, or select global for all titles
# Press {{B|START}} to exit
# Press {{B|start}} to exit
=== Disabling Rehid ===
===Disabling Rehid===
# Launch '''RehidHelper''' from the HOME Menu
# launch RehidHelper from the HOME menu
# Select '''Toggle Rehid State'''
# Select '''Toggle Rehid State'''
# Press {{B|B}} to reboot
# Press {{B|B}} to reboot.
=== Removing configs ===
* For global configurations, delete <code>sd:/rehid/rehid.json</code> or, for a configuration set to a title delete <code>sd:/rehid/<title ID>/rehid.json</code>
== Configuration ==
===Removing configs===
* For global configurations delete <code>/rehid/rehid.json</code> or, for a configuration set to a title delete <code>/rehid/(Title ID)/rehid.json</code>
=== Config file ===
==Configuration==
Rehid stores its key mappings in <code>.json</code> files located either as <code>sd:/rehid/rehid.json</code> for global mappings or in a title ID folder within <code>sd:/rehid/</code> to use with a specific title. You can manually create your own key mappings by creating a <code>rehid.json</code> file with the key mappings you want. Possible options include:
===Config file===
* <code>"keys":</code> Maps one or more keys to press different key(s).
<p>Rehid stores its key mappings in <code>.json</code> files located at <code>/rehid/rehid.json</code>, or in a title ID folder within <code>/rehid/</code> to use with a specific title. You can manually create your own key mappings by creating a <code>rehid.json</code> file with the key mappings you want. Possible options include:</p>
<p><code>"keys":</code> which maps a key press to another key press.</p>
*: With the above, any time you press the {{B|ZR}} key, {{B|R}} key would be triggered, and any time you press the {{B|ZL}} key, {{B|L}} key would be triggered.
*:: The keys you can use for this are: <code>A</code>, <code>B</code>, <code>X</code>, <code>Y</code>, <code>SELECT</code>, <code>START</code>, <code>ZL</code>, <code>ZR</code>, <code>L</code>, <code>R</code>, <code>LEFT</code>, <code>RIGHT</code>, <code>UP</code>, <code>DOWN</code>, <code>CLEFT</code>(CPAD), <code>CRIGHT</code>(CPAD), <code>CUP</code>(CPAD), <code>CDOWN</code>(C-PAD), <code>CSLEFT</code>(C-STICK), <code>CSRIGHT</code>(C-STICK), <code>CSUP</code>(C-STICK), <code>CSDOWN</code>(C-STICK)
<p>With the above, any time you press the {{B|ZR}} key, {{B|R}} key would be triggered, and any time you press the {{B|ZL}} key, {{B|L}} key would be triggered. Possible Keys are: <code>A</code>, <code>B</code>, <code>X</code>, <code>Y</code>, <code>SELECT</code>, <code>START</code>, <code>ZL</code>, <code>ZR</code>, <code>L</code>, <code>R</code>, <code>LEFT</code>, <code>RIGHT</code>, <code>UP</code>, <code>DOWN</code>, <code>CLEFT</code>(CPAD), <code>CRIGHT</code>(CPAD), <code>CUP</code>(CPAD), <code>CDOWN</code>(C-PAD), <code>CSLEFT</code>(C-STICK), <code>CSRIGHT</code>(C-STICK), <code>CSUP</code>(C-STICK), <code>CSDOWN</code>(C-STICK)</p>
*: You can use this to do custom key combos, such as the following:
*: With this, pressing {{B|X+Y}} will trigger {{B|R}} instead, and pressing {{B|SELECT}} will trigger both {{B|L}} and {{B|R}} at the same time.
<p>With this any time you press {{B|X+Y}}, {{B|R}} key would be triggered, and any time you press the {{B|SELECT}} button, both {{B|L}} and {{B|R}} would be triggered.</p>
* <code>"turbo":</code> Maps one or more key(s) to toggle different key(s) to be repeatedly triggered with a given delay.
<p><code>"cpad":</code>, which maps a key press to a circle pad x and y coordinate from -190 to 190;</p>
*: With the above, any time you press the {{B|ZL+ZR}} key, {{B|A}} key would be repeatedly triggered, with a HID-frame delay of 5. Unlike other options, "turbo" does not prevent the "press" key(s) from triggering.
<p><code>"touch":</code>, which maps a key press to a given x,y coordinate on the touchscreen from 0,0 top left to 320,240 bottom right;</p>
* <code>"cpad":</code> Maps a key press to the given XY coordinates on the Circle Pad, between -190 and 190.
<p><code>"touchtokeys":</code> which maps a box starting at a given x,y coordinate, with a given height and width, that when tapped will output a key press;</p>
* <code>"touch":</code> Maps a key press to the given XY coordinates on the touchscreen, from 0,0 (top-left corner) to 320,240 (bottom-right corner).
If your console crashes while booting with "an exception occurred" and the "current proccess:" is hid, you may have an old version of Rehid thats causing issues. Look for and delete <code>/luma/titles/0004013000001D02</code> and <code>/luma/titles/0004013000003302</code>. If these don't exist, you may have a more serious hardware issue, join the [https://discord.gg/C29hYvh Nintendo Homebrew Discord] and ask, in English, for help.
Check the [[3DS:Error screens/Luma3DS exception screen|Luma3DS exceptions page]] for information on exceptions.
If you are unable to scan QR codes on your console, instead click Build this remap and place the downloaded rehid.json into a rehid folder on the root of your SD card, or rehid/(title ID)/ to remap a specific game. You can find the title ID of your game using 3dsdb
Power on your console and launch RehidHelper
Select Scan QR Code and scan the generated QR code from the website
Press A to proceed
Select a title from the list for the remap to be applied to, or select global for all titles
Press start to exit
Disabling Rehid
launch RehidHelper from the HOME menu
Select Toggle Rehid State
Press B to reboot.
Removing configs
For global configurations delete /rehid/rehid.json or, for a configuration set to a title delete /rehid/(Title ID)/rehid.json
Configuration
Config file
Rehid stores its key mappings in .json files located at /rehid/rehid.json, or in a title ID folder within /rehid/ to use with a specific title. You can manually create your own key mappings by creating a rehid.json file with the key mappings you want. Possible options include:
"keys": which maps a key press to another key press.
With the above, any time you press the ZR key, R key would be triggered, and any time you press the ZL key, L key would be triggered. Possible Keys are: A, B, X, Y, SELECT, START, ZL, ZR, L, R, LEFT, RIGHT, UP, DOWN, CLEFT(CPAD), CRIGHT(CPAD), CUP(CPAD), CDOWN(C-PAD), CSLEFT(C-STICK), CSRIGHT(C-STICK), CSUP(C-STICK), CSDOWN(C-STICK)
For this example, it creates a box starting at x=10 y=20, with a height of 50 and a width of 100.
Other options include: "cpadtodpad":true maps the C-pad with D-pad key presses "dpadtocpad":true maps the D-pad with C-pad key presses "overidecpadpro":true makes it so games don't recognize the circle pad pro "homebutton": maps the HOME button to a key press
These Options can be strung together into a single line, for example:
If your console crashes while booting with "an exception occurred" and the "current proccess:" is hid, you may have an old version of Rehid thats causing issues. Look for and delete /luma/titles/0004013000001D02 and /luma/titles/0004013000003302. If these don't exist, you may have a more serious hardware issue, join the Nintendo Homebrew Discord and ask, in English, for help.