OnionFS 3DS: Difference between revisions

From GameBrew
No edit summary
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Infobox 3DS homebrew
{{Infobox 3DS Homebrews
| title = OnionFS
|title=OnionFS
| image = https://dlhb.gamebrew.org/3dshomebrew/OnionFS.jpeg|250px
|image=Onionfs2.png
| type = Utilities
|description=ROMFS and SAVE redirection to the SD.
| version = v2.0
|author=mariohackandglitch
| licence = Mixed
|lastupdated=2021/04/24
| author = mariohackandglitch
|type=Utilities
| website = https://github.com/mariohackandglitch/OnionFS
|version=2.1
| download = https://dlhb.gamebrew.org/3dshomebrew/OnionFS.rar
|license=Mixed
| source = https://dlhb.gamebrew.org/3dshomebrew/OnionFS.rar
|download=https://dlhb.gamebrew.org/3dshomebrews/onionfs.7z
|website=https://github.com/mariohackandglitch/OnionFS
|source=https://github.com/mariohackandglitch/OnionFS
}}
}}
OnionFS is a fork of layeredfs plugin made by cell9 that redirects romfs and save access to the SD card, useful for game mods and multiple save slots. It is designed to work with any game, even if there is an update patch installed (however there may be untested games that are incompatible for whatever reason, if you find one, please [https://github.com/mariohackandglitch/OnionFS/issues create an issue] with the problem).
==Features==
* ROMFS redirection to SD card, only modded files are needed.
* SAVE redirection to SD card, the game will save to the SD instead of the cartridge or digital save (compatible even with games with secure value).
* Built-in rom hack/save pack manager, allows to chose which folder in the SD should be used for ROMFS/SAVE redirection.
==User guide==
Default redirection paths:
* Extracted romfs - <code>SD:/OnionFS/<lowtitleID>/romfs/</code>
* Save file - <code>SD:/OnionFS/<lowtitleID>/save/</code>
<code><lowtitleID></code> is the last 8 characters of the game title ID.
===ROMFS redirection===
* If ROMFS redirection is enabled, the game will first try to open ROMFS files from the SD card.
* If they don't exist then the original ones will be used.
* This feature behaves the exact same way as layeredFS.
===SAVE redirection===
* If SAVE redirection is enabled, all the save files will be stored directly in the SD as if they were extracted from [[Checkpoint 3DS]] or JKSV.
* Note that the plugin won't extract the existing save files, it will create new ones.
* If you want to use your existing save extract it first with Checkpoint.
* In order to keep the original save file untouched and working, the secure value of games that use it will be removed each time the game starts.
===Entry manager===
* You can create multiple SAVE and ROMFS entries for the same game in the SD card.
* This allows to load different romhacks or have multiple save slots.
* To use this feature press Select to open the [[CTRPluginFramework_3DS|CTRPF]] ingame menu and access the OnionFS entry.
* Note: Modifying the current loaded entry or changing to another one will force the console to reboot to prevent any save corruption. Custom entry redirection paths:
** Extracted romfs - <code>SD:/OnionFS/<entryname>/romfs/</code>
** Save file - <code>SD:/OnionFS/<entryname>/save/</code>
Notice that if a new entry is created, the redirected path will no longer depend on the game titleID. This is done so it is possible to share the save between compatible games if an entry with the same name is created for both games.
===Debug mode===
* You can use debug mode to output the plugin log to a file <code>SD:/OnionFS/<titleID>debug.txt</code>.
* This information will be useful to log all the accessed files by the game as well as the initial setup operations.
* To enable debug mode, hold D-Pad Up while the game is booting.
'''Note''' The game will run very slow and may lag in debug mode as a lot of file writes will be happening very quickly.
==Media==
'''OnionFS 2.0 - ROMFS & SAVE redirection to SD card''' ([https://www.youtube.com/watch?v=T7G_sFwYdsY PabloMK7]) <br>
<youtube>T7G_sFwYdsY</youtube>
<youtube>T7G_sFwYdsY</youtube>


= OnionFS =
==Credits==
OnionFS is a fork of layeredfs plugin made by cell9 that redirects romfs and save access to the SD card, useful for game mods and multiple save slots. It is designed to work with any game, even if there is an update patch installed (however there may be untested games that are incompatible for whatever reason, if you find one, please create an issue with the problem). Default redirection paths:
* cell9 - Developer of layeredfs and NTRCFW.
* Extracted romfs: '''&quot;SD:/OnionFS/&lt;lowtitleID&gt;/romfs/&quot;'''
* Nanquitas - CTRPF developer and help.
* Save file: '''&quot;SD:/OnionFS/&lt;lowtitleID&gt;/save/&quot;''' '''&lt;lowtitleID&gt;:''' The last 8 characters of the game title ID.
 
== ROMFS redirection ==
==External links==
If ROMFS redirection is enabled, the game will first try to open ROMFS files from the SD card, and if they don't exist then the original ones will be used. This feature behaves the exact same way as layeredFS
* GitHub - https://github.com/mariohackandglitch/OnionFS
== SAVE redirection ==
 
If SAVE redirection is enabled, all the save files will be stored directly in the SD as if they were extracted from Checkpoint or JKSV. Note that the plugin won't extract the existing save files, it will create new ones. If you want to use your existing save extract it first with Checkpoint. In order to keep the original save file untouched and working, the secure value of games that use it will be removed each time the game starts.
[[Category:3DS homebrew applications]]
== Entry manager ==
[[Category:Homebrew utility applications on 3DS]]
You can create multiple SAVE and ROMFS entries for the same game in the SD card. This allows to load different romhacks or have multiple save slots. To use this feature press the (Select) button to open the CTRPF ingame menu and access the OnionFS entry, from there you will be able to add more entries, configure existing ones and change which one will be used. '''NOTE:''' Modifying the current loaded entry or changing to another one will force the console to reboot to prevent any save corruption. Custom entry redirection paths:
* Extracted romfs: '''&quot;SD:/OnionFS/&lt;entryname&gt;/romfs/&quot;'''
* Save file: '''&quot;SD:/OnionFS/&lt;entryname&gt;/save/&quot;''' Notice that if a new entry is created, the redirected path will no longer depend on the game titleID. This is done so '''it is possible to share the save between compatible games if an entry with the same name is created for both games.'''
== Debug mode ==
You can use debug mode to output the plugin log to a file: '''&quot;SD:/OnionFS/&lt;titleID&gt;debug.txt&quot;'''. This information will be useful to log all the accessed files by the game as well as the initial setup operations. To enable debug mode, hold '''DPAD UP''' while the game is booting. '''NOTE:''' The game will run very slow and may lag in debug mode as a lot of file writes will be happening very quickly.
- ROMFS &amp; SAVE redirection to SD card.]]]
== Credits ==
* cell9: Developer of layeredfs and NTRCFW.
* Nanquitas: CTRPF developer and help. (A LOT of help actually :P)

Latest revision as of 06:50, 22 March 2022

OnionFS
Onionfs2.png
General
Authormariohackandglitch
TypeUtilities
Version2.1
LicenseMixed
Last Updated2021/04/24
Links
Download
Website
Source

OnionFS is a fork of layeredfs plugin made by cell9 that redirects romfs and save access to the SD card, useful for game mods and multiple save slots. It is designed to work with any game, even if there is an update patch installed (however there may be untested games that are incompatible for whatever reason, if you find one, please create an issue with the problem).

Features

  • ROMFS redirection to SD card, only modded files are needed.
  • SAVE redirection to SD card, the game will save to the SD instead of the cartridge or digital save (compatible even with games with secure value).
  • Built-in rom hack/save pack manager, allows to chose which folder in the SD should be used for ROMFS/SAVE redirection.

User guide

Default redirection paths:

  • Extracted romfs - SD:/OnionFS/<lowtitleID>/romfs/
  • Save file - SD:/OnionFS/<lowtitleID>/save/

<lowtitleID> is the last 8 characters of the game title ID.

ROMFS redirection

  • If ROMFS redirection is enabled, the game will first try to open ROMFS files from the SD card.
  • If they don't exist then the original ones will be used.
  • This feature behaves the exact same way as layeredFS.

SAVE redirection

  • If SAVE redirection is enabled, all the save files will be stored directly in the SD as if they were extracted from Checkpoint 3DS or JKSV.
  • Note that the plugin won't extract the existing save files, it will create new ones.
  • If you want to use your existing save extract it first with Checkpoint.
  • In order to keep the original save file untouched and working, the secure value of games that use it will be removed each time the game starts.

Entry manager

  • You can create multiple SAVE and ROMFS entries for the same game in the SD card.
  • This allows to load different romhacks or have multiple save slots.
  • To use this feature press Select to open the CTRPF ingame menu and access the OnionFS entry.
  • Note: Modifying the current loaded entry or changing to another one will force the console to reboot to prevent any save corruption. Custom entry redirection paths:
    • Extracted romfs - SD:/OnionFS/<entryname>/romfs/
    • Save file - SD:/OnionFS/<entryname>/save/

Notice that if a new entry is created, the redirected path will no longer depend on the game titleID. This is done so it is possible to share the save between compatible games if an entry with the same name is created for both games.

Debug mode

  • You can use debug mode to output the plugin log to a file SD:/OnionFS/<titleID>debug.txt.
  • This information will be useful to log all the accessed files by the game as well as the initial setup operations.
  • To enable debug mode, hold D-Pad Up while the game is booting.

Note The game will run very slow and may lag in debug mode as a lot of file writes will be happening very quickly.

Media

OnionFS 2.0 - ROMFS & SAVE redirection to SD card (PabloMK7)

Credits

  • cell9 - Developer of layeredfs and NTRCFW.
  • Nanquitas - CTRPF developer and help.

External links

Advertising: