Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

CTRPluginFramework 3DS: Difference between revisions

From GameBrew
No edit summary
No edit summary
Line 3: Line 3:
|image=Ctrpluginframework2.png
|image=Ctrpluginframework2.png
|description=A blank CTRPF plugin for Luma3DS (with Action Replay).
|description=A blank CTRPF plugin for Luma3DS (with Action Replay).
|author=Nanquitas
|author=Nanquitas, PabloMK7
|lastupdated=2022/05/05
|lastupdated=2022/10/26
|type=Plugins
|type=Plugins
|version=0.7.3
|version=0.7.4
|license=Mixed
|license=Mixed
|download=[https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework.7z 0.5.1] and [https://discord.gg/z4ZMh27 latest]
|download=[https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework.7z 0.5.1] and [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases latest]
|website=https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729
|website=https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729
|source=https://gitlab.com/thepixellizeross/ctrpluginframework/-/releases
|source=https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases
}}
}}
This is blank CTRPF plugin to be used by [[Luma3DS 3GX Loader Edition 3DS|Luma3DS with plugin loader]]. It gives you a blank plugin so you can use the tools (search, guide and others) without being annoyed by builtin cheats.  
This is blank CTRPF plugin to be used by [[Luma3DS 3GX Loader Edition 3DS|Luma3DS 3GX Loader Edition]]. It gives you a blank plugin so you can use the tools (search, guide and others) without being annoyed by builtin cheats.  


You can use 2 plugins (or more, but only 1 CTRPF plugin) at the same time, and so you can use this blank plugin with another plugin which will have your cheats. You can also change the hotkey in Tools/Settings to avoid any overlapping.
You can use 2 plugins (or more, but only 1 CTRPF plugin) at the same time, and so you can use this blank plugin with another plugin which will have your cheats. You can also change the hotkey in Tools/Settings to avoid any overlapping.


==Installation==
==Installation==
Download contains the following files (from the orignal release thread):
Download contains version 0.5.1 (from the original release thread):
* CTRPluginFramework.3gx - CTRPF plugin v0.5.1 (latest version is available at the [https://discord.gg/z4ZMh27 Nanquitas' Playground] announcements channel).
* CTRPluginFramework.3gx - Plugin v0.5.1 (latest version is available [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases here]).
* CTRPluginFramework-UserGuide.pdf/docx - CTRPF manual (online version [https://www.docdroid.net/Sp0K2Xe/ctrpluginframework-userguide-pdf .pdf] and [https://drive.google.com/file/d/0B-JJmt53_KWgd0FtWFF6RWhjcXM/view?usp=sharing .docx]).
* UserGuide.pdf/docx - CTRPF Manual ([https://www.docdroid.net/Sp0K2Xe/ctrpluginframework-userguide-pdf online version]).
* ActionReplay.7z - Action Replay plugin (.plg).
* ActionReplay.7z - ActionReplay.plg.
* ActionReplayCodeTypes.txt - ActionReplay supported code types/template (from [https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860 here]).
* ActionReplayCodeTypes.txt - ActionReplay supported code types/template (from [https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860 here]).
* Fort42_GateShark_22-12-2017.zip - Archive of all GateShark cheat codes (from [https://filetrip.net/dl?bFxBtXHND0 Fort42 Cheat Codes]).
* Fort42_GateShark_22-12-2017.zip - Archive of all GateShark cheat codes (from [https://filetrip.net/dl?bFxBtXHND0 Fort42 Cheat Codes]).
* Luma3DS Mod.zip - Edited version of Luma3DS with Plugin Loader merged into it ([https://gitlab.com/Nanquitas/Luma3DS-PluginLoader source]).
* Luma3DS Mod.zip - Edited version of Luma3DS for CTRPF (please use [[Luma3DS 3GX Loader Edition 3DS|the updated version]]).
** 2020/11/17 please use the updated version [[Luma3DS 3GX Loader Edition 3DS]].
 
Quick guide for the [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases latest version]:
* Make sure you are using [[Luma3DS 3GX Loader Edition 3DS|Luma3DS 3GX Loader Edition]] (when updating, rename any existing boot.firm to boot.firm.bak in case you want to go back).
* Rename BlankTemplate.3gx to default.3gx to use by itself, or with [[CTRPluginFramework_3DS#Action Replay|SharkGate/AR cheats codes]].
* sd:/luma/plugins/default.3gx - Location for default.3gx (would be loaded for all games).
* sd:/cheats/<tid>.txt - Location for SharkGate/AR cheats codes, can be loaded with the blank plugin (replace <tid> by the title id of the game).


==User guide==
==User guide==
===Action Replay===
3GX plugins can be placed in 2 locations, requires [[Luma3DS 3GX Loader Edition 3DS|Luma3DS 3GX Loader Edition]] to use:
CTRPF now have it's own Action Replay system:
* sd:/luma/plugins/<TITLEID>/<filename>.3gx - This sets a plugin for a specified title (higher priority).
* It can load your cheats from a text file (no longer require any converter or compilation).
* sd:/luma/plugins/default.3gx - This set a plugin which would be loaded for all games (lower priority).
* It support Folder and note managing and also have it's own editor (able to edit/create/delete the codes at runtime).
 
* CTRPF supports all Gateshark code types and even some custom code types ([https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860 list of all supported codetype]).
Notes for N3DS/O3DS:
* The plugin loader is automatically enabled on Old3DS because Mode3 games needs it.  
* So on N3DS, you have to enable the plugin loader from Rosalina (L+Down+Select), and you can disable it too.  
* You can't disable it for Mode3 games though (O3DS only).


The cheats files can be at 2 locations:
PLG plugins require [[BootNTR Selector 3DS|BootNTR Selector]] to use (and you need to have [[Luma3DS 3GX Loader Edition 3DS|Luma3DS 3GX Loader Edition]] installed, as the official [[Luma3DS]] is not compatible):
* cheats.txt in the same folder of the plugin.
*sd:/plugin/<TITLEID>/cheat.plg - Location for .plg file.
* sd:/cheats/<tid>.txt - Replace <tid> by the title id of the game.
*Turn on your 3DS and make sure NTR CFW is running, you can check by pressing X+Y and if it is running a menu will pop up on the bottom screen.
* To use, unzip ActionReplay.7z and put it on your SD card (see the [[CTRPluginFramework_3DS#Luma3DS_with_Plugin_Loader|Luma3DS section below]] of how to use it for all games).
*If it is not running, open Boot NTR Selector, select 3.6 and wait for the blue flash.


===Gateshark cheats===
===Action Replay/Gateshark cheats===
Gateshark cheats should be supported at 100% by the Action Replay:
CTRPF now have it's own Action Replay system and can load your cheats from a text file, it supports:
* Just unzip Fort42 GateShark cheat archive and copy the cheats folder at the root of your SD card.
* All Gateshark code types and some custom code types ([https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860 list of all supported codetype]).
* Note that some cheats might not work.
* Folder, note managing and also have it's own editor (able to edit/create/delete the codes at runtime).  
* If a cheat is not working, it just means that the cheat is wrong: no support will be done for cheats not working.  
* Simply place the cheat files at sd:/cheats/<tid>.txt - replace <tid> by the title id of the game.


You can also find codes here:
It should work with the Fort42 GateShark cheat archive in download. Note that some cheats might not work. If a cheat is not working, it just means that the cheat is wrong: no support will be done for cheats not working. You can also find codes here:
* [https://gbatemp.net/threads/gateway-cheats.402900 Gateway cheats thread] (since all codes are supported).
* [https://gbatemp.net/threads/gateway-cheats.402900 Gateway cheats thread] (since all codes are supported).
* [https://gbatemp.net/threads/database-ctrpf-ar-cheat-codes.493220 Database thread] started by Vermil.
* [https://gbatemp.net/threads/database-ctrpf-ar-cheat-codes.493220 Database thread] started by Vermil.
* [https://github.com/JourneyOver/CTRPF-AR-CHEAT-CODES Github repo] by HollowedFear.
* [https://github.com/JourneyOver/CTRPF-AR-CHEAT-CODES Github repo] by HollowedFear.
===Luma3DS with Plugin Loader===
Currently [[BootNTR Selector 3DS|BootNTR Selector]] is not compatible with the official [[Luma3DS|Luma3DS]], and the modified version of Luma3DS is required:
* Get boot.firm from [[Luma3DS 3GX Loader Edition 3DS|Luma3DS 3GX Loader Edition]] then put it on your SD card (rename any existing boot.firm to boot.firm.bak in case you want to go back).
* The goal is to be able to launch plugins (.plg) from Luma3DS without the need to use BootNTR Selector.
PLG plugins can be set at 2 places:
* sd:/luma/plugins/<tid>/plugin.plg - Name of the plugin must be plugin.plg and you have to replace <tid> by the title id of your game.
* If a plugin isn't found in the tid folder, Luma3DS will search for ActionReplay.plg in sd:/luma/plugins/ActionReplay/ActionReplay.plg.
3GX plugins can be placed at 2 locations:
* sd:/luma/plugins/<TITLEID>/<filename>.3gx - This sets a plugin for a specified title (higher priority).
* sd:/luma/plugins/default.3gx - This set a plugin which would be loaded for all games (lower priority).
** Rename CTRPluginFramework.3gx to default.3gx to be used in conjunction with [[CTRPluginFramework_3DS#Action Replay|SharkGate/AR cheats codes]] (or just by CTRPF itself).
For N3DS/O3DS:
* The plugin loader is automatically enabled on Old3DS because Mode3 games needs it.
* So on N3DS, you have to enable the plugin loader from Rosalina (L+Down+Select), and you can disable it too.
* You can't disable it for Mode3 games though (O3DS only).
'''Note:''' See [https://gbatemp.net/threads/ctrpluginframework-in-combination-with-luma3ds.582335 the disscusion thread] for more info about using the plugin (.3gx) with Luma3DS.


===Other projects using CTRPF===
===Other projects using CTRPF===

Revision as of 02:50, 6 November 2022

CTRPluginFramework
Ctrpluginframework2.png
General
AuthorNanquitas, PabloMK7
TypePlugins
Version0.7.4
LicenseMixed
Last Updated2022/10/26
Links
[0.5.1 and latest Download]
Website
Source

This is blank CTRPF plugin to be used by Luma3DS 3GX Loader Edition. It gives you a blank plugin so you can use the tools (search, guide and others) without being annoyed by builtin cheats.

You can use 2 plugins (or more, but only 1 CTRPF plugin) at the same time, and so you can use this blank plugin with another plugin which will have your cheats. You can also change the hotkey in Tools/Settings to avoid any overlapping.

Installation

Download contains version 0.5.1 (from the original release thread):

  • CTRPluginFramework.3gx - Plugin v0.5.1 (latest version is available here).
  • UserGuide.pdf/docx - CTRPF Manual (online version).
  • ActionReplay.7z - ActionReplay.plg.
  • ActionReplayCodeTypes.txt - ActionReplay supported code types/template (from here).
  • Fort42_GateShark_22-12-2017.zip - Archive of all GateShark cheat codes (from Fort42 Cheat Codes).
  • Luma3DS Mod.zip - Edited version of Luma3DS for CTRPF (please use the updated version).

Quick guide for the latest version:

  • Make sure you are using Luma3DS 3GX Loader Edition (when updating, rename any existing boot.firm to boot.firm.bak in case you want to go back).
  • Rename BlankTemplate.3gx to default.3gx to use by itself, or with SharkGate/AR cheats codes.
  • sd:/luma/plugins/default.3gx - Location for default.3gx (would be loaded for all games).
  • sd:/cheats/<tid>.txt - Location for SharkGate/AR cheats codes, can be loaded with the blank plugin (replace <tid> by the title id of the game).

User guide

3GX plugins can be placed in 2 locations, requires Luma3DS 3GX Loader Edition to use:

  • sd:/luma/plugins/<TITLEID>/<filename>.3gx - This sets a plugin for a specified title (higher priority).
  • sd:/luma/plugins/default.3gx - This set a plugin which would be loaded for all games (lower priority).

Notes for N3DS/O3DS:

  • The plugin loader is automatically enabled on Old3DS because Mode3 games needs it.
  • So on N3DS, you have to enable the plugin loader from Rosalina (L+Down+Select), and you can disable it too.
  • You can't disable it for Mode3 games though (O3DS only).

PLG plugins require BootNTR Selector to use (and you need to have Luma3DS 3GX Loader Edition installed, as the official Luma3DS is not compatible):

  • sd:/plugin/<TITLEID>/cheat.plg - Location for .plg file.
  • Turn on your 3DS and make sure NTR CFW is running, you can check by pressing X+Y and if it is running a menu will pop up on the bottom screen.
  • If it is not running, open Boot NTR Selector, select 3.6 and wait for the blue flash.

Action Replay/Gateshark cheats

CTRPF now have it's own Action Replay system and can load your cheats from a text file, it supports:

  • All Gateshark code types and some custom code types (list of all supported codetype).
  • Folder, note managing and also have it's own editor (able to edit/create/delete the codes at runtime).
  • Simply place the cheat files at sd:/cheats/<tid>.txt - replace <tid> by the title id of the game.

It should work with the Fort42 GateShark cheat archive in download. Note that some cheats might not work. If a cheat is not working, it just means that the cheat is wrong: no support will be done for cheats not working. You can also find codes here:

Other projects using CTRPF

Useful links

Screenshots

ctrpluginframework3.png ctrpluginframework4.png

ctrpluginframework11.png ctrpluginframework6.png

ctrpluginframework12.png ctrpluginframework13.png

ctrpluginframework9.png ctrpluginframework10.png

Media

[CTRPF] Action Replay - Code Creator (Nanquitas Videos)

[CTRPF] - Action Replay - File picker (Nanquitas Videos)

Known issues

On N3DS, if the game uses the N3DS's HID (cstick, zl & zr), it won't work. Easy fix:

  • Open Rosalina.
  • Go in the Miscellaneous options menu.
  • Start the Input Redirection.
  • That's it, go back to your game, it should work now.

Credits

A huge thanks to:

  • AnalogMan - Alpha tester.
  • cell9 - NTR CFW and some ideas/code.
  • Anto726 - Alpha tester.
  • Mega-Mew - Alpha tester.
  • ObsidianX - Learnt how to untile the sysfont from one of his python tool.
  • PabloMK7 - Alpha tester.
  • Project CPP3DS - First c++ project, and reading the sources of CPP3DS gave me a starting point on how to structure my code.
  • RyDog - Alpha tester.
  • Slattz - Alpha tester.
  • Sc0tline - Action Replay tester.
  • Vermil - Action Replay tester.
  • Stackoverflow - A lot of code debugging/improvments took from random post here.
  • Ctrulib and it's contibuter - For all the work done.

External links

Advertising: