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

PKSM 3DS: Difference between revisions

From GameBrew
No edit summary
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox-3DS-Homebrews
{{Infobox 3DS Homebrews
| title = PKSM
|title=PKSM
| image = https://dlhb.gamebrew.org/3dshomebrew/PKSM.png|250px
|image=Pksm2.png
| type = Utilities
|description=Save editor for Pokemon generations 4 to 7.
| version=v9.2.0
|author=FlagBrew
| lastupdated = 2020/07/26
|lastupdated=2024/04/04
| licence = GNU GPLv3
|type=Save Managers and Editors
| author = Bernardo Giordano
|version=10.1.1
| website = https://github.com/FlagBrew/PKSM
|license=GPL-3.0
| download = https://dlhb.gamebrew.org/3dshomebrew/PKSM9.2.0.7z
|download=https://github.com/FlagBrew/PKSM/releases
| source = https://github.com/FlagBrew/PKSM
|website=https://flagbrew.org/projects/PKSM
|source=https://github.com/FlagBrew/PKSM
|donation=https://www.patreon.com/FlagBrew
}}
}}
<youtube>5rK7yYAKI4g</youtube>
<!--do not add mirror-->
PKSM is a multipurpose and portable save manager for Pokemon generations IV to VII, programmed in C++.


Multipurpose and portable save manager for 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.


* Supports original cartridges and digital copies of games from DPPt to SwSh
==Features==
* Allows on-the-fly modifications to all of your data
* Supports original cartridges and digital copies of games from DPPt to SwSh.
* Allows internal and resizable offline storage to store your Pokemon
* Allows on-the-fly modifications to all of your data.
* Capable of running custom scripts to allow injection of arbitrary data into your saves
* Allows internal and resizable offline storage to store your Pokemon.
* Interfaces with multiple ad-hoc programs running on your computer, web browser or smartphone
* Capable of running custom scripts to allow injection of arbitrary data into your saves.
* Capable of scanning QR codes to inject both .pkx files or event wondercards
* Interfaces with multiple ad-hoc programs running on your computer, web browser or smartphone.
* Contains an offline wondercard database to get events from old distributions
* Capable of scanning QR codes to inject both .pkx files or event wondercards.
* Capable of automatic verification and legalization of all your data
* Contains an offline wondercard database to get events from old distributions.
* 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.
* 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.
* 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.


This software works on CFW and Rosalina-based Homebrew Launchers. An internet connection is required when first launching PKSM.
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.


==Entrypoint Instructions==
==User guide==
* CFW Install the PKSM.cia file provided in the release page with your favourite installer. You can now launch the application from the Home Menu
Refer to the [https://github.com/FlagBrew/PKSM/wiki PKSM wiki] for documentation.
* Rosalina HBL Copy the PKSM.3dsx file provided in the release page into your SD card. You can now 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.


==Applications compatible with PKSM==
===Supported games===
* PKHeX: Generates .pk7, .pk6, .wc7, .wc6 QR codes scannable from PKSM. Runs on PC.
As of v10.0.0 the following games are supported:
* MysteryGiftBot: Generates .wc7 QR codes scannable from PKSM. Runs on Twitter.
* Gen 1 - Pokémon Red/Green, Pokémon Blue, Pokémon Yellow
* PKSM-Scripts: a toolkit to develop and compile .pksm and .c scripts.
* Gen 2 - Pokémon Gold/Silver, Pokémon Crystal
* The GPSS: an online Pokemon sharing platform
* 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 [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===
* [https://github.com/kwsch/PKHeX PKHeX]: Generates .pk7, .pk6, .wc7, .wc6 QR codes scannable from PKSM. Runs on PC.
* [https://twitter.com/mysterygiftbot MysteryGiftBot]: Generates .wc7 QR codes scannable from PKSM. Runs on Twitter.
* [https://github.com/FlagBrew/PKSM-Scripts PKSM-Scripts]: A toolkit to develop and compile .pksm and .c scripts.
* [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===
* Additional assets are located at <code>/3ds/PKSM/assets</code>.
* Automatic save backups are located at <code>/3ds/PKSM/backups</code>.
* Extra storage data is located at <code>/3ds/PKSM/banks</code>.
* .pkx and .wcx dumps are located in <code>/3ds/PKSM/dumps</code>.
* Custom scripts are located in <code>/3ds/PKSM/scripts</code>.
* Custom background songs are located in <code>/3ds/PKSM/songs</code>.


* Additional assets are located at /3ds/PKSM/assets
===FAQ===
* Automatic save backups are located at /3ds/PKSM/backups
[https://github.com/FlagBrew/PKSM/wiki/FAQs PKSM FAQs]
* Extra storage data is located at /3ds/PKSM/banks
 
* .pkx and .wcx dumps are located in /3ds/PKSM/dumps
==Controls==
* Custom scripts are located in /3ds/PKSM/scripts
D-Pad/C-Pad - Scroll through games or saves
* Custom background songs are located in /3ds/PKSM/songs
 
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==
==Screenshots==
https://dlhb.gamebrew.org/3dshomebrew/PKSM-1.jpg
https://dlhb.gamebrew.org/3dshomebrews/pksm12.png
https://dlhb.gamebrew.org/3dshomebrew/PKSM-2.jpg
https://dlhb.gamebrew.org/3dshomebrews/pksm13.png
https://dlhb.gamebrew.org/3dshomebrew/PKSM-3.jpg
https://dlhb.gamebrew.org/3dshomebrew/PKSM-4.jpg
https://dlhb.gamebrew.org/3dshomebrew/PKSM-5.jpg
https://dlhb.gamebrew.org/3dshomebrew/PKSM-6.jpg


==Troubleshooting==
https://dlhb.gamebrew.org/3dshomebrews/pksm11.png
https://dlhb.gamebrew.org/3dshomebrews/pksm10.png


Before submitting an issue, have a look through the issues page, because your question may have already been answered in the past.
https://dlhb.gamebrew.org/3dshomebrews/pksm6.png
https://dlhb.gamebrew.org/3dshomebrews/pksm7.png


Please only submit consistent issues (submitting your environment and which version of PKSM you're running, for example). Duplicate issues will be closed without any reply.
https://dlhb.gamebrew.org/3dshomebrews/pksm8.png
https://dlhb.gamebrew.org/3dshomebrews/pksm9.png


We'll not reply to issues related to versions of PKSM different from the latest stable release currently available.
==Media==
[https://www.youtube.com/watch?v=5rK7yYAKI4g PKSM: Complete Guide to Generating Pokemon on Nintendo 3DS - Sun and Moon, ORAS, X &Y! (Homebrew)] (by OPERATIONiDROID).


You can get real-time support by joining FlagBrew's discord server.
==Known issues==
Please refer to the [https://github.com/FlagBrew/PKSM/issues issue page].


==Building==
==Changelog==
PKSM has the following dependencies:
'''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 &amp; 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 &quot;save and launch&quot; 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.


The latest version of ctrulib, citro3d, citro2d, 3ds-curl, 3ds-pkg-config, 3ds-bzip2, 3ds-mpg123, 3dstools, and tex3ds with their dependancies. All of these should be installed from devKitPro pacman.
Note: the ELF file here is for ease of finding it for future debugging. It is unlikely anyone downloading PKSM will need it.


Your system's pkg-config
'''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.


3dstool, bannertool and makerom, if you want to be able to compile a .cia build of PKSM.
[https://github.com/FlagBrew/PKSM/releases Release notes.]


The latest version of Python 3.x and the GitPython library.
==Credits==
* [https://github.com/BernardoGiordano/ Bernardo] for creating PKSM.
* [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.
* [https://github.com/SpiredMoth SpiredMoth], [https://github.com/trainboy2019 trainboy2019] and all the scripters for making PKSM-Scripts great.
* [https://github.com/architdate Archit Date] for CoreConsole and PKHeX AutoLegalityMod.
* [https://github.com/FM1337 Allen] for the GPSS, CoreConsole’s successor, CoreAPI and GPSS Mobile.
* [https://github.com/LiquidFenrir LiquidFenrir] for the PoC of session stealing that led to Gen 3 support and GPSS Mobile.
* The whole [https://github.com/FlagBrew FlagBrew] team for collaborating with us.
* [https://github.com/kwsch kwsch] and [https://github.com/SciresM SciresM] for PKHeX, memecrypto and documentation.
* [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.
* 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.


node.js, pandoc, wkhtmltopdf and github-wikito-converter to be able to build the HTML documentation.
==External links==
* Official website - https://flagbrew.org
* GitHub - https://github.com/FlagBrew/PKSM
* Discord - https://discord.gg/bGKEyfY
<!--mirror: https://dlhb.gamebrew.org/3dshomebrews/pksm.7z-->


To compile, clone the repository with all submodules (git clone --recursive https://github.com/FlagBrew/PKSM.git if initially cloning, git submodule init and git submodule update if running from an existing clone) and run make all.


==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 and CoreConsole's successor, CoreAPI
* 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
* 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
* Without you, this project wouldn't have existed. Thank you.


==License==
[[Category:Support the author]]
This project is licensed under the GNU GPLv3. Additional Terms 7.b and 7.c of GPLv3 apply to this. See LICENSE for details.

Latest revision as of 02:19, 17 August 2024

PKSM
Pksm2.png
General
AuthorFlagBrew
TypeSave Managers and Editors
Version10.1.1
LicenseGPL-3.0
Last Updated2024/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

PKSM FAQs

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

pksm12.png pksm13.png

pksm11.png pksm10.png

pksm6.png pksm7.png

pksm8.png pksm9.png

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

v10.0.0

  • Gen 1 & 2 support!
    • Huge thank you to @SNBeast for his work on this!
  • GPSS 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.

Release notes.

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.
  • SpiredMothtrainboy2019 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.
  • jpoirierzsaleeba, 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

Advertising: