CTRPluginFramework 3DS: Difference between revisions

From GameBrew
No edit summary
m (Text replacement - "Category:3DS homebrew rom hacks" to "")
 
(76 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Infobox 3DS homebrew
{{Infobox 3DS Homebrews
| title = CTRPluginFramework
|title=CTRPluginFramework
| image = https://dlhb.gamebrew.org/3dshomebrew/CTRPluginFramework.jpeg|250px
|image=Ctrpluginframework2.png
| type = Other Apps
|description=A blank CTRPF plugin for Luma3DS (with Action Replay).
| version =  
|author=Nanquitas, PabloMK7
| licence = Mixed
|lastupdated=2022/10/26
| author = Nanquitas
|type=Plugins
| website = https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729/
|version=0.7.4
| download = https://dlhb.gamebrew.org/3dshomebrew/CTRPluginFramework.rar
|license=Mixed
| source = https://github.com/Nanquitas/CTRPluginFramework-BlankTemplate
|downloadraw=[https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework.7z 0.5.1] - [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases Latest Download]
|website=https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729
|source=https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases
}}
}}
<youtube>zj5WajeV_-U</youtube>
This is blank CTRPF plugin to be used with [[Luma3DS 3GX Loader Edition 3DS|Luma3DS plugin loader]]. It gives you a blank plugin so you can use the tools (search, guide and others) without being annoyed by builtin cheats.


I do this thread so we can have a general place to talk about it, and also to give 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.
I remind you that you can use 2 plugins (or more, but only 1 ctrpf plugin though) at the same time, and so you can use this blank plugin with another plugin which will have your cheats.
You can change the hotkey in Tools/Settings to avoid any overlapping.


===Guide===
==Installation==
The .7z contains version 0.5.1 (from the original release thread):
* CTRPluginFramework.3gx - Plugin v0.5.1 (please use [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases the latest version]).
* UserGuide.pdf/docx - CTRPF Manual ([https://www.docdroid.net/Sp0K2Xe/ctrpluginframework-userguide-pdf online version]).
* ActionReplay.7z - ActionReplay.plg.
* 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]).
* Luma3DS Mod.zip - Edited version of Luma3DS for CTRPF (please use [[Luma3DS]]).


You can find a guide to use some of the features here [https://www.docdroid.net/Sp0K2Xe/ctrpluginframework-userguide.pdfm(pdf)].
Quick install guide for the [https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate/releases latest version]:
* Make sure you are using [[Luma3DS]].
* Rename BlankTemplate.3gx to default.3gx to use by itself, or with [[CTRPluginFramework_3DS#Action_Replay.2FGateshark_cheats|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).


Sadly as you can see, the guide is a little outdated because of lack of time.
Notes on Luma3DS (N3DS/O3DS):
So, I'm searching for volunteers that would like to update / translate it.
* The plugin loader is automatically enabled on Old3DS because Mode3 games needs it.  
If you're interested, you can find an editable (.docx) version of the guide here. ;)
* 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).


===Action Replay===
==User guide==
===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 ([https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860 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's now ""official"" CTRPF have it's own Action Replay system. It means that it can now load your cheats from a text file (so no more needs for any converter or compilation).
It should work with the Fort42 GateShark cheat archive in the download. Note that some cheats might not work, and it just means the cheat is wrong. You can also find codes here:
CTRPF supports all Gateshark code types and even add some custom code types to increase the possibilities of the codes.
* [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://github.com/iSharingan/CTRPF-AR-CHEAT-CODES Database] by iSharingan ([https://github.com/JourneyOver/CTRPF-AR-CHEAT-CODES old repo] by HollowedFear).


You can find a list with all the supported codes here: [[https://gist.github.com/Nanquitas/d6c920a59c757cf7917c2bffa76de860|List of all codetype]].
===Notes on plugin types===
3GX plugins can be placed in 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).  


CTRPF support Folder and note managing and also have it's own editor.
PLG plugins require [[BootNTR Selector 3DS|BootNTR Selector]] to use:
Which means that you can edit, create and delete the codes at runtime, without the need for anything else.
*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.


====The cheats files can be at 2 locations:====
===Projects using CTRPF===
* [[ACNL-NTR-Cheats 3DS|Animal Crossing - New Leaf Multi Cheats plugin]] - A plugin with various cheats and fun mods by RyDog.
* [[Mario Kart 7 - Custom Track Grand Prix 7 3DS|CTGP7]] - An MK7 mods with a lot of custom track and other things by PabloMK7.
* [https://gbatemp.net/threads/release-ntr-plugin-fantasy-life.456458 Fantasy Life Cheat plugin] - A plugin with various cheats for the game Fantasy Life.
* [https://gbatemp.net/threads/release-miitopia-ntr-plugin.480438 MiitopiaFramework] - A plugin with various cheats for the game Miitopia by AnalogMan.
* [https://gbatemp.net/threads/release-new-pokemon-xy-oras-ntr-cheat-plugin.477974 Pokemon XY & ORAS Cheat plugin] - A plugin with various cheats for the Pokemons games by Mega-Mew.
* [https://gbatemp.net/threads/release-ultrasumoframework-ntr-plugin-for-ultra-sumo.489098 UltraSuMoFramework - NTR Plugin for Ultra SuMo] - A plugin with various cheats for Pokemon USUMO by AnalogMan.
* [[Zelda_Ocarina_Of_Time_3D_Plugin_3DS|Zelda Ocarina Of Time 3D Cheat plugin]] - A plugin with various cheats for Zelda OOT.


* cheats.txt in the same folder of the plugin
===Useful links===
* sd:/cheats/<tid>.txt - Replace <tid> by the title id of the game
* [https://3ds.eiphax.tech/ntrplugins NTR Plugin Guide].
* [https://3ds.eiphax.tech/lumaplugins Luma3ds Plugin Loader Guide].


To use it, download the ActionReplay.7z attached and put it on your SD card (see the Luma3DS section below to use the ame plugin for all games).
==Screenshots==
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework3.png
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework4.png


A video to see how to use the editor and create codes:
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework11.png
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework6.png


===Gateshark cheats===
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework12.png
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework13.png


Gateshark cheats should be supported at 100% by the Action Replay.
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework9.png
https://dlhb.gamebrew.org/3dshomebrews/ctrpluginframework10.png


Just unzip and copy the cheats folder at the root of your SD card.
==Media==
'''[CTRPF] Action Replay - Code Creator''' ([https://www.youtube.com/watch?v=c2258P9wKkA Nanquitas Videos]) <br>
<youtube>c2258P9wKkA</youtube>


Note that I didn't create those cheats, and some cheats might not work.
'''[CTRPF] - Action Replay - File picker''' ([https://www.youtube.com/watch?v=J2s61lW0vN4 Nanquitas Videos]) <br>
If a cheat is not working, it just means that the cheat is wrong: no support will be done for cheats not working, I'm not here to fix all cheats, so create another thread (or move to another existing thread), thank you.
<youtube>J2s61lW0vN4</youtube>


You can also find codes here:
==Known issues==
 
On N3DS, if the game uses the N3DS's HID (cstick, zl & zr), it won't work. Easy fix:
* [https://gbatemp.net/threads/gateway-cheats.402900/ Gateway cheats] thread (since all codes are supported)
* Open Rosalina.
* [https://gbatemp.net/threads/database-ctrpf-ar-cheat-codes.493220/ Database] thread started by @Vermil
* Go in the Miscellaneous options menu.
* [https://github.com/JourneyOver/CTRPF-AR-CHEAT-CODES Github repo] by @HollowedFear
* Start the Input Redirection.
 
* That's it, go back to your game, it should work now.
==Known bug==
 
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
 
===Projects using CTRPF and could interest you:===
 
Animal Crossing: New Leaf Multi Cheats plugin: A plugin with various cheats and fun mods by @RyDog
CTGP7: An MK7 mods with a lot of custom track and other things by @PabloMK7
Fantasy Life Cheat plugin: A plugin with various cheats for the game Fantasy Life
MiitopiaFramework: A plugin with various cheats for the game Miitopia by @AnalogMan
Pokemon XY & ORAS Cheat plugin: A plugin with various cheats for the Pokemons games by @Mega-Mew
UltraSuMoFramework - NTR Plugin for Ultra SuMo: A plugin with various cheats for Pokemon USUMO by @AnalogMan
Zelda Ocarina Of Time 3D Cheat plugin: A plugin with various cheats for Zelda OOT


==Credits==
A huge thanks to:
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.


* @AnalogMan: Alpha tester
==External links==
* @cell9: NTR CFW and some ideas / code
* GHitLab - https://gitlab.com/thepixellizeross/ctrpluginframework
* @Anto726 : Alpha tester
* GitHub (Nanquitas) - https://github.com/Nanquitas/CTRPluginFramework-BlankTemplate
* @Mega-Mew: Alpha tester
* GitHub (PabloMK7) - https://github.com/PabloMK7/CTRPluginFramework-BlankTemplate
* @ObsidianX: I learned how to untile the sysfont from one of his python tool
* GBAtemp - https://gbatemp.net/threads/ctrpluginframework-blank-plugin-now-with-action-replay.487729
* @PabloMK7: Alpha tester
* Discord - https://discord.gg/z4ZMh27
* @Project CPP3DS: This is my 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
* Probably a lot more as I use Google a lot and read various code, will update when/if I'll remember particular projects/persons
 
==Luma3DS with Plugin Loader==
 
I merged and edited the plugin loader from NTR (which is now open source) into Luma3DS.
 
The goal was to be able to launch plugins from Luma3DS without the need to use BootNTR Selector.
 
So, this is possible, but know that only CTRPF plugins can be loaded from this plugin loader.
 
To use it, download the boot.7z attached and unzip it. Then put it on your sd card (rename any existing boot.firm to boot.firm.bak in case you want to go back).
 
===The 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
 
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+ DPad Down + Select), and you can disable it too. You can't disable it for Mode3 games though (O3DS only).
 
The code source can be found here.
 
No support on the code is intended, I did this mostly for fun, if you want to change anything you're on your own.

Latest revision as of 06:16, 6 May 2024

CTRPluginFramework
Ctrpluginframework2.png
General
AuthorNanquitas, PabloMK7
TypePlugins
Version0.7.4
LicenseMixed
Last Updated2022/10/26
Links
0.5.1 - Latest Download
Website
Source

This is blank CTRPF plugin to be used with Luma3DS plugin loader. 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

The .7z contains version 0.5.1 (from the original release thread):

  • CTRPluginFramework.3gx - Plugin v0.5.1 (please use the latest version).
  • 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 Luma3DS).

Quick install guide for the latest version:

  • Make sure you are using Luma3DS.
  • 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).

Notes on Luma3DS (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).

User guide

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 the download. Note that some cheats might not work, and it just means the cheat is wrong. You can also find codes here:

Notes on plugin types

3GX plugins can be placed in 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).

PLG plugins require BootNTR Selector to use:

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

Projects using CTRPF

Useful links

Screenshots

ctrpluginframework3.pngctrpluginframework4.png

ctrpluginframework11.pngctrpluginframework6.png

ctrpluginframework12.pngctrpluginframework13.png

ctrpluginframework9.pngctrpluginframework10.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

Retrieved from ‘https://www.gamebrew.org/index.php?title=CTRPluginFramework_3DS&oldid=154574’

Advertising: