3DS:Rehid: Difference between revisions

From Hacks Guide Wiki
m (capitalize Rehid when applicable)
m (add 0004013000003302.ips to {{Tree list}})
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox homebrew
{{Lowercase title}}{{Infobox homebrew
| title = Rehid
| title = Rehid
| image = rehid-Helper-banner.png
| image = rehid-Helper-banner.png
| imagealt = RehidHelper banner as used on the HOME Menu
| imagealt = RehidHelper's HOME Menu banner
| for3ds = 1
| for3ds = 1
| developers = hax0kartik
| developers = hax0kartik
| version = 4.0
| version = 4.0
| releasedate = 2023-07-20
| releasedate = 2023-07-20
| website= https://gbatemp.net/threads/585387/ gbatemp.net/threads/585387
| github = hax0kartik/rehid
| github = hax0kartik/rehid
| githubtag = v4.0
| githubtag = v4.0
| universaldb = 3ds/rehid
| universaldb = 3ds/rehid
}}
}}
'''Rehid''' is a rewrite of the 3DS' hid module, to allow for the remapping of buttons or the touch screen.


=Installation=
'''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 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 the console
# Power on your console
# Launch '''Universal-Updater'''
# Launch '''Universal Updater'''
# Tap the magnifying glass on the bottom screen, then search for '''rehid'''
# Select 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 installs
# Wait until the app finishes installing
# 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 Luma3DS configuration
# While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]]
# Ensure that "'''Enable loading external FIRMs and modules'''" is selected
# Turn on '''Enable loading external FIRMs and modules''' if it is not already enabled
# 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 [https://github.com/hax0kartik/rehid/releases/latest Rehid] (the <code>0004013000001D02.cxi</code> and <code>rehidhelper.cia</code> files)
* The latest release of {{GitHub|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
* [[3DS:luma3DS|Luma3DS]] updated to 13.0+
* A v13.0 or higher version of [[3DS:luma3DS|Luma3DS]]' <code>boot.firm</code> on the root of your SD card


===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 53: Line 65:
# 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 Luma3DS configuration
# While holding {{B|SELECT}}, power on your console to enter [[3DS:Luma3DS/Configuration|the Luma3DS configuration menu]]
# Ensure that "'''Enable loading external FIRMs and modules'''" is selected
# Turn on '''Enable loading external FIRMs and modules''' if it is not already enabled
# Press {{B|START}} to save and exit
# Press {{B|START}} to save and exit
</span>


</span>
</tabber>
</tabber>


==Remapping buttons==
== Usage ==
<tabber>
 
|-|Generated=
=== Adding configs ===
<span>
# 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 generate your remappings
# 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 for all titles
# Select a title from the list for the remap to be applied to, or select global to apply it to the entire console
# Press {{B|start}} to exit
# Press {{B|START}} to exit
</span>
 
=== Disabling Rehid ===
# Launch '''RehidHelper''' from the HOME Menu
# Select '''Toggle Rehid State'''
# 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 ==
 
=== Config file ===
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:
* <code>"keys":</code> Maps one or more keys to press different key(s).
** Syntax: <syntaxhighlight lang="json">{"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}]}</syntaxhighlight>
*: 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>
*: You can use this to do custom key combos, such as the following:
*::<syntaxhighlight lang="json">{"keys":[{"press":"X+Y","get":"R"},{"press":"SELECT","get":"L+R"}]}</syntaxhighlight>
*: 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.
* <code>"cpad":</code> Maps a key press to the given XY coordinates on the Circle Pad, between -190 and 190.</p>
** Syntax: <syntaxhighlight lang="json">{"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]},{"press":"CLEFT","get":[-190,0]},{"press":"CRIGHT","get":[190,0]}]}</syntaxhighlight>
* <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).
** Syntax: <syntaxhighlight lang="json">{"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}]}</syntaxhighlight>
* <code>"touchtokeys":</code> Maps the given area on the touch screen at the given XY coordinates to output a key press when tapped.</p>
** Syntax: <syntaxhighlight lang="json">{"touchtokeys":[{"press":[10,20,50,100],"get":"A"}]}</syntaxhighlight>
*: The above example creates a box starting at x=10 y=20 that has a height of 50 and a width of 100.
* Other options include:
** <code>"cpadtodpad":true</code> Automatically redirects all C-Pad inputs to the D-Pad.<br>
** <code>"dpadtocpad":true</code> Automatically redirects all D-Pad inputs to the C-Pad.<br>
** <code>"overidecpadpro":true</code> Stops games from recognizing the Circle Pad Pro.<br>
** <code>"homebutton":</code> Remaps the HOME button to one or more key press(es).</p>
* All of the above options can be used at once in one remapping. For example:</p>
*: <syntaxhighlight lang="json">{"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}],"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]}],"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}],"touchtokeys":[{"press":[10,20,50,100],"get":"A"}],"cpadtodpad":true,"dpadtocpad":true,"overridecpadpro":true,"homebutton":"ZR+ZL"}</syntaxhighlight>


|-|Manual=
=== SD file layout ===
<span>
{{Tree list}}
<ol>
* {{Tree icon|sd}} (root)
<li><p>Create a <code>rehid.json</code> file with the remappings you want. possible options include:</p>
** {{Tree icon|d}} luma
<p><code>"keys":</code> which maps a key press to another key press.<br>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>
*** {{Tree icon|d}} sysmodules
<syntaxhighlight lang="json">{"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}]}</syntaxhighlight>
**** {{Tree icon|f}} 0004013000001D02.cxi
<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.</p>
**** {{Tree icon|f}} 0004013000003302.ips
<p>You can also do custom key combos;</p>
** {{Tree icon|d}} rehid
<syntaxhighlight lang="json">{"keys":[{"press":"X+Y","get":"R"},{"press":"SELECT","get":"L+R"}]}</syntaxhighlight>
*** {{Tree icon|f}} rehid.json
<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>
*** {{Tree icon|d}} <title ID>
<p><code>"cpad":</code>, which maps a key press to a circle pad x and y coordinate from -190 to 190;</p>
**** {{Tree icon|f}} rehid.json
<syntaxhighlight lang="json">{"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]},{"press":"CLEFT","get":[-190,0]},{"press":"CRIGHT","get":[190,0]}]}</syntaxhighlight>
{{Tree list/end}}
<p><code>"touch":</code>, which maps a key press to a touchscreen x and y coordinate from 0,0 top left to 320,240 bottom right;</p>
<syntaxhighlight lang="json">{"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}]}</syntaxhighlight>
<p><code>"touchtokeys":</code> which maps two coordinate pairs to make a box on the touch screen that when tapped will output a key press;</p>
<syntaxhighlight lang="json">{"touchtokeys":[{"press":[0,0,50,50],"get":"A"}]}</syntaxhighlight>
<p>For this example, tapping anywhere in a 50x50 pixel box in the top left will press A.</p>
<p>Other options include:<br>
<code>"cpadtodpad":true</code> maps the C-pad with D-pad key presses<br>
<code>"dpadtocpad":true</code> maps the D-pad with C-pad key presses<br>
<code>"overidecpadpro":true</code> makes it so games don't recognize the circle pad pro<br>
<code>"homebutton":</code> maps the HOME button to a key press</p>
<p>These Options can be strung together into a single line, for example:</p>
<syntaxhighlight lang="json">{"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}],"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]}],"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}],"touchtokeys":[{"press":[0,0,50,50],"get":"A"}],"cpadtodpad":true,"dpadtocpad":true,"overridecpadpro":true,"homebutton":"ZR+ZL"}</syntaxhighlight>
</li>
<li>Copy <code>rehid.json</code> to a <code>rehid</code> folder on the root of your SD card
<ul>
<li>If you want to the remapping to be used for a specific title, copy <code>rehid.json</code> to <code>rihid/(title ID)/</code> instead. You can find the title ID of your game using [https://3dsdb.com/ 3dsdb]</li></ul>
</li>
</ol>
</span>
</tabber>


==Troubleshooting==
== Troubleshooting ==


===An exception occurred===
=== An exception occurred ===
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:EXCEPTION|Luma3DS exceptions page]] for information on exceptions.


[[Category:Nintendo 3DS guides]]
[[Category:Nintendo 3DS guides]]
[[Category:Nintendo 3DS homebrew]]
[[Category:Nintendo 3DS homebrew]]

Latest revision as of 03:32, 30 March 2024

Rehid
RehidHelper's HOME Menu banner
Developer(s)hax0kartik
ConsoleNintendo 3DS
Version4.0 (July 20, 2023; 9 months ago (2023-07-20))
Links
Websitegbatemp.net/threads/585387
GitHubhax0kartik/rehid
Download


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 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

What you need

Instructions

  1. Power on your console
  2. Launch Universal Updater
  3. Select the magnifying glass on the bottom screen, then search for rehid
  4. Press A while hovering over rehid from the list of homebrew
  5. Choose rehidhelper.cia
  6. Wait until the app finishes installing
  7. Close Universal Updater
  8. Launch RehidHelper and select Download Rehid
  9. Wait for it to download and reboot, then press B to exit the app
  10. Power off your console
  11. While holding SELECT, power on your console to enter the Luma3DS configuration menu
  12. Turn on Enable loading external FIRMs and modules if it is not already enabled
  13. Press START to save and exit

What you need

  • The latest release of rehid (the 0004013000001D02.cxi and rehidhelper.cia files)
  • FBI installed on your console
  • A v13.0 or higher version of Luma3DS' boot.firm on the root of your SD card

Instructions

  1. Copy 0004013000001D02.cxi to sd:/luma/sysmodules/
    • Create the folder sysmodules if it doesn't exist
  2. Copy rehidhelper.cia to the root of your SD card
  3. Reinsert your SD card into your console
  4. Launch FBI and select SD -> rehidhelper.cia -> Install and delete CIA
  5. Press A and wait for the CIA to install, then exit FBI
  6. Power off your console
  7. While holding SELECT, power on your console to enter the Luma3DS configuration menu
  8. Turn on Enable loading external FIRMs and modules if it is not already enabled
  9. Press START to save and exit

Usage

Adding configs

  1. Open the 3DS Remap Builder and configure your key mappings
  2. 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 rehid.json into the folder sd:/rehid, or sd:/rehid/<title ID>/ if you only want to remap a specific game. You can find the title ID of your game using 3dsdb
  3. Power on your console and launch RehidHelper
  4. Select Scan QR Code and scan the generated QR code from the website
  5. Press A to proceed
  6. Select a title from the list for the remap to be applied to, or select global to apply it to the entire console
  7. Press START to exit

Disabling Rehid

  1. Launch RehidHelper from the HOME Menu
  2. Select Toggle Rehid State
  3. Press B to reboot

Removing configs

  • For global configurations, delete sd:/rehid/rehid.json or, for a configuration set to a title delete sd:/rehid/<title ID>/rehid.json

Configuration

Config file

Rehid stores its key mappings in .json files located either as sd:/rehid/rehid.json for global mappings or in a title ID folder within sd:/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": Maps one or more keys to press different key(s).
    • Syntax: 
      {"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}]}
    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.
    The keys you can use for this 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)

    You can use this to do custom key combos, such as the following: 
    {"keys":[{"press":"X+Y","get":"R"},{"press":"SELECT","get":"L+R"}]}
    With this, pressing X+Y will trigger R instead, and pressing SELECT will trigger both L and R at the same time.
  • "cpad": Maps a key press to the given XY coordinates on the Circle Pad, between -190 and 190.

    • Syntax: 
      {"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]},{"press":"CLEFT","get":[-190,0]},{"press":"CRIGHT","get":[190,0]}]}
  • "touch": Maps a key press to the given XY coordinates on the touchscreen, from 0,0 (top-left corner) to 320,240 (bottom-right corner).
    • Syntax: 
      {"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}]}
  • "touchtokeys": Maps the given area on the touch screen at the given XY coordinates to output a key press when tapped.

    • Syntax: 
      {"touchtokeys":[{"press":[10,20,50,100],"get":"A"}]}
    The above example creates a box starting at x=10 y=20 that has a height of 50 and a width of 100.
  • Other options include:
    • "cpadtodpad":true Automatically redirects all C-Pad inputs to the D-Pad.
    • "dpadtocpad":true Automatically redirects all D-Pad inputs to the C-Pad.
    • "overidecpadpro":true Stops games from recognizing the Circle Pad Pro.
    • "homebutton": Remaps the HOME button to one or more key press(es).

  • All of the above options can be used at once in one remapping. For example:

    {"keys":[{"press":"ZR","get":"R"},{"press":"ZL","get":"L"}],"cpad":[{"press":"CUP","get":[0,190]},{"press":"CDOWN","get":[0,-190]}],"touch":[{"press":"LEFT+UP","get":[0,0]},{"press":"RIGHT+DOWN","get":[320,240]}],"touchtokeys":[{"press":[10,20,50,100],"get":"A"}],"cpadtodpad":true,"dpadtocpad":true,"overridecpadpro":true,"homebutton":"ZR+ZL"}

SD file layout

  • SD card icon (root)
    • Folder icon luma
      • Folder icon sysmodules
        • File icon 0004013000001D02.cxi
        • File icon 0004013000003302.ips
    • Folder icon rehid
      • File icon rehid.json
      • Folder icon <title ID>
        • File icon rehid.json

Troubleshooting

An exception occurred

Check the Luma3DS exceptions page for information on exceptions.

Retrieved from "https://wiki.hacks.guide/w/index.php?title=3DS:Rehid&oldid=5564"