More actions
No edit summary |
(→FAQ) |
||
| (23 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Infobox 3DS Homebrews | {{Infobox 3DS Homebrews | ||
|title=PKSM | |title=PKSM | ||
|image= | |image=Pksm2.png | ||
|description=Save editor for Pokemon generations 4 to 7. | |description=Save editor for Pokemon generations 4 to 7. | ||
|author= | |author=FlagBrew | ||
|lastupdated= | |lastupdated=2024/04/04 | ||
|type= | |type=Save Managers and Editors | ||
|version= | |version=10.1.1 | ||
|license=GPL-3.0 | |license=GPL-3.0 | ||
|download=https:// | |download=https://github.com/FlagBrew/PKSM/releases | ||
|website=https:// | |website=https://flagbrew.org/projects/PKSM | ||
|source=https://github.com/FlagBrew/PKSM | |source=https://github.com/FlagBrew/PKSM | ||
|donation=https://www.patreon.com/FlagBrew | |||
}} | }} | ||
<!--do not add mirror--> | |||
PKSM is a multipurpose and portable save manager for Pokemon generations IV to VII, programmed in C++. | PKSM is a multipurpose and portable save manager for Pokemon generations IV to VII, programmed in C++. | ||
''' | '''Authors' note:''' We do not support or condone cheating at the expense of others. Do not use significantly edited Pokemon in battle or in trades with those who are unaware edited Pokemon are in use. | ||
We do not support or condone cheating at the expense of others. Do not use significantly edited Pokemon in battle or in trades with those who are unaware edited Pokemon are in use. | |||
==Features== | ==Features== | ||
| Line 27: | Line 26: | ||
* Capable of scanning QR codes to inject both .pkx files or event wondercards. | * Capable of scanning QR codes to inject both .pkx files or event wondercards. | ||
* Contains an offline wondercard database to get events from old distributions. | * Contains an offline wondercard database to get events from old distributions. | ||
* Capable of automatic verification and legalization of all your data. | * Capable of automatic verification and legalization of all your data (internet connection required). | ||
** Optional interfacing with an Android app to handle verification and legalization without a network connection | |||
==Installation== | ==Installation== | ||
This software works on CFW and Rosalina-based Homebrew Launchers. An internet connection is required when first launching PKSM. | This software works on CFW and Rosalina-based Homebrew Launchers. An internet connection is required when first launching PKSM. | ||
* CFW - Install the PKSM.cia file with your favourite installer, then launch the application from the Home Menu. | * CFW - Install the PKSM.cia file with your favourite installer, then launch the application from the Home Menu. | ||
* Rosalina HBL - Copy the PKSM.3dsx file into | * Rosalina HBL - Copy the PKSM.3dsx file into sdmc:/3ds/PKSM/, then launch PKSM from a Rosalina-based Homebrew Launcher. | ||
Initial launch will require your system to be connected to the internet. This is needed to download the additional assets required for the application to launch. If your system is not connected to the internet, PKSM will return back to your menu. | Initial launch will require your system to be connected to the internet. This is needed to download the additional assets required for the application to launch. If your system is not connected to the internet, PKSM will return back to your menu. | ||
==User guide== | ==User guide== | ||
Refer to the [https://github.com/FlagBrew/PKSM/wiki PKSM wiki] for documentation. | |||
===Supported games=== | ===Supported games=== | ||
As of | As of v10.0.0 the following games are supported: | ||
* Gen | * Gen 1 - Pokémon Red/Green, Pokémon Blue, Pokémon Yellow | ||
** Pokémon Ruby, | * Gen 2 - Pokémon Gold/Silver, Pokémon Crystal | ||
* Gen 3 - Pokémon Ruby/Sapphire, Pokémon FireRed/LeafGreen, Pokémon Emerald | |||
* Gen 4 - Pokémon Diamond/Pearl, Pokémon Platinum, Pokémon HeartGold/SoulSilver | |||
* Gen 4 | * Gen 5 - Pokémon Black/White, Pokémon Black 2/White 2 | ||
* Gen 6 - Pokémon X/Y, Pokémon Omega Ruby/Alpha Sapphire | |||
* Gen 7 - Pokémon Sun/Moon, Pokémon Ultra Sun/Ultra Moon, Pokémon Let's Go Pikachu/Let's Go Eevee | |||
* Gen 8 - Pokémon Sword, Shield (v1.3 only) (supported DLCs: Isle of Armor, Crown Tundra | |||
* Gen 5 | |||
* Gen 6 | |||
* Gen 7 | |||
* Gen 8 | |||
LGPE saves can be accessed by bridging PKSM on 3DS to Checkpoint on Switch. SWSH saves can be accessed through the same bridging function, but | Gen 3 games work either through emulators (via [https://github.com/FlagBrew/PKSM/wiki/Settings#extra-saves Extra Saves]) or through [https://github.com/FlagBrew/PKSM/wiki/GBA-Injection VC injects] (via [https://github.com/FlagBrew/PKSM/wiki/Settings#title-ids custom Title IDs]). | ||
LGPE saves can be accessed by bridging PKSM on 3DS to Checkpoint on Switch. SWSH saves can be accessed through the same bridging function, but PKSM's support may be unstable due to SWSH version updates changing the sizes of save files. | |||
===Applications compatible with PKSM=== | ===Applications compatible with PKSM=== | ||
* PKHeX | * [https://github.com/kwsch/PKHeX PKHeX]: Generates .pk7, .pk6, .wc7, .wc6 QR codes scannable from PKSM. Runs on PC. | ||
* MysteryGiftBot | * [https://twitter.com/mysterygiftbot MysteryGiftBot]: Generates .wc7 QR codes scannable from PKSM. Runs on Twitter. | ||
* PKSM-Scripts - A toolkit to develop and compile .pksm and .c scripts. | * [https://github.com/FlagBrew/PKSM-Scripts PKSM-Scripts]: A toolkit to develop and compile .pksm and .c scripts. | ||
* The GPSS | * [https://flagbrew.org/gpss The GPSS]: An online Pokémon sharing platform. | ||
* [https://play.google.com/store/apps/details?id=com.flagbrew.gpss_mobile GPSS Mobile]: Mobile interface for the GPSS and related features. Android only. | |||
===Working path=== | ===Working path=== | ||
| Line 77: | Line 70: | ||
===FAQ=== | ===FAQ=== | ||
[https://github.com/FlagBrew/PKSM/wiki/FAQs PKSM FAQs] | |||
==Controls== | ==Controls== | ||
| Line 224: | Line 90: | ||
==Screenshots== | ==Screenshots== | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm12.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm13.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm11.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm10.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm6.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm7.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm8.png | ||
https://dlhb.gamebrew.org/3dshomebrews/ | https://dlhb.gamebrew.org/3dshomebrews/pksm9.png | ||
==Media== | ==Media== | ||
| Line 243: | Line 109: | ||
==Changelog== | ==Changelog== | ||
'''v10.1.1''' | |||
*This release fixes the bag editor item list bug, as well as the commit hash missing from the version in the top right corner of the screen. | |||
'''v10.1.0''' | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1372 #1372] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1373 #1373] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1374 #1374] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1381 #1381] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1384 #1384] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1391 #1391] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1392 #1392] | |||
* Fixed [https://github.com/FlagBrew/PKSM/issues/1394 #1394] | |||
* Fixed GPSS download codes not working. | |||
'''v10.0.0''' | |||
* Gen 1 & 2 support! | |||
** Huge thank you to [https://github.com/SNBeast @SNBeast] for his work on this! | |||
* GPSS Upgrades: | |||
** GPSS now works with the current version of the [https://flagbrew.org FlagBrew website upgrades]. | |||
* Language updates: | |||
** The way we structured our language files has changed to hopefully make translators' lives easier. | |||
* Storage: | |||
** Adds dumping selected groups from within the bank storage screen. | |||
* View of Pokémon will color stats according to nature increase/decrease: | |||
** Hyper Trained stats and hidden abilities will also be colored. | |||
* Add many G8 sprites; now they won't all be eggs. | |||
* Adds a "save and launch" button to allow immediately launching games with changes. | |||
*Fixes: | |||
** G3 bag item counts now don't go insane on every change. | |||
** Cloning now works properly in blue-cursor mode. | |||
** Many miscellaneous bug fixes. | |||
Note: the ELF file here is for ease of finding it for future debugging. It is unlikely anyone downloading PKSM will need it. | |||
'''v9.2.0''' | '''v9.2.0''' | ||
* The Generation 3 and 8 hex editors are now filled in. | * The Generation 3 and 8 hex editors are now filled in. | ||
| Line 262: | Line 160: | ||
==Credits== | ==Credits== | ||
* Bernardo | * [https://github.com/BernardoGiordano/ Bernardo] for creating PKSM. | ||
* piepie62 | * [https://github.com/piepie62 piepie62] and [https://github.com/Admiral-Fish Admiral-Fish] for the immense amount of dedication they put into the project. | ||
* dsoldier for the gorgeous graphic work. | * dsoldier for the gorgeous graphic work. | ||
* SpiredMoth, trainboy2019 | * [https://github.com/SpiredMoth SpiredMoth], [https://github.com/trainboy2019 trainboy2019] and all the scripters for making PKSM-Scripts great. | ||
* Archit Date | * [https://github.com/architdate Archit Date] for CoreConsole and PKHeX AutoLegalityMod. | ||
* Allen | * [https://github.com/FM1337 Allen] for the GPSS, CoreConsole’s successor, CoreAPI and GPSS Mobile. | ||
* The | * [https://github.com/LiquidFenrir LiquidFenrir] for the PoC of session stealing that led to Gen 3 support and GPSS Mobile. | ||
* kwsch | * The whole [https://github.com/FlagBrew FlagBrew] team for collaborating with us. | ||
* fincs | * [https://github.com/kwsch kwsch] and [https://github.com/SciresM SciresM] for PKHeX, memecrypto and documentation. | ||
* kamronbatman | * [https://github.com/fincs fincs] and [https://github.com/WinterMute WinterMute] for citro2d and devkitARM. | ||
* [https://github.com/kamronbatman kamronbatman] and ProjectPokemon.org for EventsGallery. | |||
* [https://github.com/nayuki nayuki] for [https://github.com/nayuki/QR-Code-generator QR-Code-generator]. | |||
* [https://github.com/jpoirier jpoirier], [https://gitlab.com/zsaleeba zsaleeba], and [https://gitlab.com/jenda.svejda Jan Švejda] for the base and most improvements in [https://github.com/FlagBrew/picoc our picoC fork]. | |||
* [https://github.com/dlbeer dlbeer] for [https://github.com/dlbeer/quirc quirc]. | |||
* [https://github.com/GriffinG1 Griffin] For FlagBot and all the help it has been on the server. | |||
* [https://github.com/SNBeast SNBeast] For Generation 1 and 2 support. | |||
* All the translators. | * All the translators. | ||
* Subject21_J and all the submitters for | * Subject21_J and all the submitters for PKSM’s icon. | ||
* Allen, piepie62, SpiredMoth and all the contributors for the documentation. | * Allen, piepie62, SpiredMoth and all the contributors for the documentation. | ||
* All the past contributors to the project. | * All the past contributors to the project. | ||
* All the patrons and the huge amount of supporters that this project has gained over the year. | * All the patrons and the huge amount of supporters that this project has gained over the year. | ||
==External links== | |||
[[Category: | * Official website - https://flagbrew.org | ||
* GitHub - https://github.com/FlagBrew/PKSM | |||
* Discord - https://discord.gg/bGKEyfY | |||
<!--mirror: https://dlhb.gamebrew.org/3dshomebrews/pksm.7z--> | |||
[[Category:Support the author]] | |||
Latest revision as of 02:19, 17 August 2024
| PKSM | |
|---|---|
 | |
| General | |
| Author | FlagBrew |
| Type | Save Managers and Editors |
| Version | 10.1.1 |
| License | GPL-3.0 |
| Last Updated | 2024/04/04 |
| Links | |
| Download | |
| Website | |
| Source | |
| Support Author | |
PKSM is a multipurpose and portable save manager for Pokemon generations IV to VII, programmed in C++.
Authors' note: We do not support or condone cheating at the expense of others. Do not use significantly edited Pokemon in battle or in trades with those who are unaware edited Pokemon are in use.
Features
- Supports original cartridges and digital copies of games from DPPt to SwSh.
- Allows on-the-fly modifications to all of your data.
- Allows internal and resizable offline storage to store your Pokemon.
- Capable of running custom scripts to allow injection of arbitrary data into your saves.
- Interfaces with multiple ad-hoc programs running on your computer, web browser or smartphone.
- Capable of scanning QR codes to inject both .pkx files or event wondercards.
- Contains an offline wondercard database to get events from old distributions.
- Capable of automatic verification and legalization of all your data (internet connection required).
- Optional interfacing with an Android app to handle verification and legalization without a network connection
Installation
This software works on CFW and Rosalina-based Homebrew Launchers. An internet connection is required when first launching PKSM.
- CFW - Install the PKSM.cia file with your favourite installer, then launch the application from the Home Menu.
- Rosalina HBL - Copy the PKSM.3dsx file into sdmc:/3ds/PKSM/, then launch PKSM from a Rosalina-based Homebrew Launcher.
Initial launch will require your system to be connected to the internet. This is needed to download the additional assets required for the application to launch. If your system is not connected to the internet, PKSM will return back to your menu.
User guide
Refer to the PKSM wiki for documentation.
Supported games
As of v10.0.0 the following games are supported:
- Gen 1 - Pokémon Red/Green, Pokémon Blue, Pokémon Yellow
- Gen 2 - Pokémon Gold/Silver, Pokémon Crystal
- Gen 3 - Pokémon Ruby/Sapphire, Pokémon FireRed/LeafGreen, Pokémon Emerald
- Gen 4 - Pokémon Diamond/Pearl, Pokémon Platinum, Pokémon HeartGold/SoulSilver
- Gen 5 - Pokémon Black/White, Pokémon Black 2/White 2
- Gen 6 - Pokémon X/Y, Pokémon Omega Ruby/Alpha Sapphire
- Gen 7 - Pokémon Sun/Moon, Pokémon Ultra Sun/Ultra Moon, Pokémon Let's Go Pikachu/Let's Go Eevee
- Gen 8 - Pokémon Sword, Shield (v1.3 only) (supported DLCs: Isle of Armor, Crown Tundra
Gen 3 games work either through emulators (via Extra Saves) or through VC injects (via custom Title IDs).
LGPE saves can be accessed by bridging PKSM on 3DS to Checkpoint on Switch. SWSH saves can be accessed through the same bridging function, but PKSM's support may be unstable due to SWSH version updates changing the sizes of save files.
Applications compatible with PKSM
- PKHeX: Generates .pk7, .pk6, .wc7, .wc6 QR codes scannable from PKSM. Runs on PC.
- MysteryGiftBot: Generates .wc7 QR codes scannable from PKSM. Runs on Twitter.
- PKSM-Scripts: A toolkit to develop and compile .pksm and .c scripts.
- The GPSS: An online Pokémon sharing platform.
- GPSS Mobile: Mobile interface for the GPSS and related features. Android only.
Working path
- Additional assets are located at
/3ds/PKSM/assets. - Automatic save backups are located at
/3ds/PKSM/backups. - Extra storage data is located at
/3ds/PKSM/banks. - .pkx and .wcx dumps are located in
/3ds/PKSM/dumps. - Custom scripts are located in
/3ds/PKSM/scripts. - Custom background songs are located in
/3ds/PKSM/songs.
FAQ
Controls
D-Pad/C-Pad - Scroll through games or saves
A - Select game or save
B - Deselect game
X - Show PKSM Settings
Y - Show Absent games
Select (hold) - Show help overlay
Start - Exit PKSM
Home - Return to Home Menu
Screenshots
Media
PKSM: Complete Guide to Generating Pokemon on Nintendo 3DS - Sun and Moon, ORAS, X &Y! (Homebrew) (by OPERATIONiDROID).
Known issues
Please refer to the issue page.
Changelog
v10.1.1
- This release fixes the bag editor item list bug, as well as the commit hash missing from the version in the top right corner of the screen.
v10.1.0
- Fixed #1372
- Fixed #1373
- Fixed #1374
- Fixed #1381
- Fixed #1384
- Fixed #1391
- Fixed #1392
- Fixed #1394
- Fixed GPSS download codes not working.
v10.0.0
- Gen 1 & 2 support!
- Huge thank you to @SNBeast for his work on this!
- GPSS Upgrades:
- GPSS now works with the current version of the FlagBrew website upgrades.
- Language updates:
- The way we structured our language files has changed to hopefully make translators' lives easier.
- Storage:
- Adds dumping selected groups from within the bank storage screen.
- View of Pokémon will color stats according to nature increase/decrease:
- Hyper Trained stats and hidden abilities will also be colored.
- Add many G8 sprites; now they won't all be eggs.
- Adds a "save and launch" button to allow immediately launching games with changes.
- Fixes:
- G3 bag item counts now don't go insane on every change.
- Cloning now works properly in blue-cursor mode.
- Many miscellaneous bug fixes.
Note: the ELF file here is for ease of finding it for future debugging. It is unlikely anyone downloading PKSM will need it.
v9.2.0
- The Generation 3 and 8 hex editors are now filled in.
- The QR scanner framerate is now much higher and supports Generation 3 QRs.
- This should not affect scanning time.
- Fixes and behind-the-scenes changes.
- Fix a few Pokémon form names.
- Add valid size for SWSH v1.0->1.2, not just 1.1->1.2.
- Fix Platinum (and possibly HGSS) unsaved box data.
- Actually create defaults folder if it's not already.
- Fix Archive::init failure with error 0xC92044E6.
- Note: this fixes the underlying issue. People that currently have this issue should seek help in our Discord server if they care about the Pokémon in their PKSM bank.
- Fixed defaults not saving changes between application restarts.
- Fix an issue with the Ranger Manaphy Wonder Card.
- Fix G3 nickname case when generating.
- As PKSM does have an auto-updater, you likely will not have to update manually.
Credits
- Bernardo for creating PKSM.
- piepie62 and Admiral-Fish for the immense amount of dedication they put into the project.
- dsoldier for the gorgeous graphic work.
- SpiredMoth, trainboy2019 and all the scripters for making PKSM-Scripts great.
- Archit Date for CoreConsole and PKHeX AutoLegalityMod.
- Allen for the GPSS, CoreConsole’s successor, CoreAPI and GPSS Mobile.
- LiquidFenrir for the PoC of session stealing that led to Gen 3 support and GPSS Mobile.
- The whole FlagBrew team for collaborating with us.
- kwsch and SciresM for PKHeX, memecrypto and documentation.
- fincs and WinterMute for citro2d and devkitARM.
- kamronbatman and ProjectPokemon.org for EventsGallery.
- nayuki for QR-Code-generator.
- jpoirier, zsaleeba, and Jan Švejda for the base and most improvements in our picoC fork.
- dlbeer for quirc.
- Griffin For FlagBot and all the help it has been on the server.
- SNBeast For Generation 1 and 2 support.
- All the translators.
- Subject21_J and all the submitters for PKSM’s icon.
- Allen, piepie62, SpiredMoth and all the contributors for the documentation.
- All the past contributors to the project.
- All the patrons and the huge amount of supporters that this project has gained over the year.
External links
- Official website - https://flagbrew.org
- GitHub - https://github.com/FlagBrew/PKSM
- Discord - https://discord.gg/bGKEyfY