Version 4.0.0

README.md

@@ -1,68 +1,93 @@
-# READ PRIOR TO USE
+# READ PRIOR TO USE
-This program is very new and largely untested. In fact, it has not been directly tested on all targeted games (as I do not own all of them.) **I highly recommend backing up saves prior to use.** I am not liable for any data loss/corruption resulting from use of this program.
+This program is very new and largely untested. In fact, it has not been directly tested on all targeted games (as I do not own all of them.) **I highly recommend backing up saves prior to use.** I am not liable for any data loss/corruption resulting from use of this program.
-
+
-# Description
+If you would like to confirm that Pokéswitch is working with your game/system, feel free to post the name of the game and/or your system configuration on the [GBAtemp thread](https://gbatemp.net/threads/pokeswitch-simple-pokemon-save-editor-for-switch.677289/).
-Pokéswitch is a Pokémon save editor designed to run natively on the Nintendo Switch. It aims to support the following games:
+
-- Pokémon Sword/Shield
+# Description
-- Pokémon Brilliant Diamond/Shining Pearl
+Pokéswitch is a Pokémon save editor designed to run natively on the Nintendo Switch. It aims to support the following games:
-- Pokémon Scarlet/Violet
+- Pokémon Sword/Shield
-- Pokémon Z-A
+- Pokémon Brilliant Diamond/Shining Pearl
-
+- Pokémon Scarlet/Violet
-**Pokéswitch does not perform legality checking.** It implements some basic constraints but generally will not prevent illegal modifications (e.g. most species modifications). Some features, such as name editing, also do not fully support languages aside from English.
+- Pokémon Z-A
-
+
-Modification of the following properties is supported:
+**Pokéswitch does not perform legality checking.** It implements some basic constraints but generally will not prevent illegal modifications (e.g. most species modifications). Some features, such as name editing, also do not fully support languages aside from English.
-- Name
+
-- Species
+Modification of the following properties is supported:
-- Level
+- Name
-- Gender
+- Species
-- Nature
+- Level
-- Stat Nature
+- Gender
-- Ability
+- Nature
-- Shininess (for Pokémon originating in Sword/Shield via SID manipulation and for Pokémon originating in the other supported games via PID manipulation)
+- Stat Nature
-- IVs
+- Ability
-- EVs
+- Shininess (for Pokémon originating in Sword/Shield via legacy SID manipulation and for Pokémon originating in the other supported games via PID manipulation)
-- HT Profile
+- Hold Item
-- Original Tera Type (for Scarlet/Violet)
+- IVs
-- Effective Tera Type (for Scarlet/Violet)
+- EVs
-- PID
+- HT Profile
-- EC
+- Moves
-- OT
+- Maximum PP
-- TID
+- Relearn Moves
-- SID
+- TR Flags (for Sword/Shield)
-
+- TM Flags (for Scarlet/Violet)
-Pokéswitch also supports (bulk) moving, cloning, exporting, and releasing Pokémon. It can import PKM files of the appropriate type (e.g. PK8 for Sword/Shield) and import/export saves.
+- Plus Moves (for Z-A)
-
+- Form (for most Pokémon with persistent alternate forms)
-# Usage
+- Original Tera Type (for Scarlet/Violet)
-Copy `Pokeswitch.nro` to `/switch` (or wherever else) on your microSD card and launch it via HBL. Select the "Information" option from the main menu to view controls. (Note that the main menu will not be available if no supported savedata is present on the system.)
+- Effective Tera Type (for Scarlet/Violet)
-
+- PID
-# Images
+- EC
-![main_menu](https://github.com/user-attachments/assets/a86d6f1a-c212-4794-9645-eca2f39067b1)
+- OT
-
+- TID
-![box](https://github.com/user-attachments/assets/1523becd-1a67-4818-9300-88a570f79abc)
+- SID
-
+
-# Notes
+Pokéswitch also supports (bulk) moving, cloning, exporting, and releasing Pokémon. It can import PKM files of the appropriate type (e.g. PK8 for Sword/Shield) and import/export saves.
-
+
-## Shinification in Sword/Shield
+# Usage
-Shinifying a Pokémon you caught in Sword/Shield will result in you no longer being recognized as their original trainer due to modification of the Pokémon's SID. This method is used for Pokémon originating in these games because most PIDs generated therein are correlated with several other properties and thus cannot be arbitrarily modified (while maintaining legality).
+Copy `Pokeswitch.nro` to `/switch` (or wherever else) on your microSD card and launch it via HBL title override (issues may occur in applet mode). Select the "Information" option from the main menu to view controls. (Note that the main menu will not be available if no supported savedata is present on the system.)
-
+
-## Moving Multiple Pokémon (via Multiselect)
+# Images
-If all selected Pokémon are in the same box and the target slot is compatible, their positions relative to one another will be preserved. If not, the selection will be flattened in the order in which it was added to.
+![main_menu](https://github.com/user-attachments/assets/e755ad37-8d1b-4a38-85d1-bda982f742d1)
-
+
-# FAQs
+![box](https://github.com/user-attachments/assets/1e3747f0-cc20-451c-a394-c50d7914836c)
-
+
-## Do I need a hacked Switch to use this?
+# Notes
-Yes, see the [NH Switch Guide](https://switch.hacks.guide/) for information regarding system exploitability.
+
-
+## Shinification in Sword/Shield
-## Can I use this to transfer Pokémon between the supported series?
+Shinifying a Pokémon you caught in Sword/Shield will result in you no longer being recognized as their original trainer due to modification of the Pokémon's legacy SID. This method is used for Pokémon originating in these games because most PIDs generated therein are correlated with several other properties and thus cannot be arbitrarily modified (while maintaining legality).
-No. If you need to transfer Pokémon, I would recommend using Pokémon Home, as it generates tracking data server-side. Replicating this is not possible, and transferring a Pokémon between series without a valid Home tracker would render it illegal.
+
-
+## Moving Multiple Pokémon (via Multiselect)
-## How do I import a PKM file?
+If all selected Pokémon are in the same box and the target slot is compatible, their positions relative to one another will be preserved. If not, the selection will be flattened in the order in which it was added to.
-In Select Mode (blue cursor), press A on any empty box slot, then select the PKM file to import.
+
-
+## Shiftable Fields
-## Why didn't you make this ~6 years ago?
+A selected move's maximum PP can be modified via the L/R buttons.
-I thought someone would make something like this but no one ever did
+
-
+## TR/TM/Plus Move Handling
-# Acknowledgements
+Some games store flags related to a Pokémon's moves. Of the supported games, these are Sword/Shield (for TRs), Scarlet/Violet (for TMs), and Z-A (for Plus Moves). When modifying species/form, Pokéswitch will attempt to configure these flags to legal values.
-The UI was created with (a slightly modified version of) [Plutonium](https://github.com/XorTroll/Plutonium) by [XorTroll](https://github.com/XorTroll).
+
-
+For Sword/Shield and Scarlet/Violet, Pokéswitch will also attempt to set the appropriate TR or TM flag, respectively, when setting a move which could only (aside from nonstandard means) be legally known at the current level via the aforementioned.
-The Nintendo Switch development platform, [libnx](https://github.com/switchbrew/libnx), was provided by [Switchbrew](https://switchbrew.org/wiki/Main_Page).
+
+For Z-A, Pokéswitch will also attempt to configure natural Plus Move flags when modifying level.
+
+These flags will be cleared during the aforementioned handling only if they are not recognized to be legal. They can also be modified manually in a Pokémon's summary.
+
+# FAQs
+
+## Do I need a hacked Switch to use this?
+Yes, see the [NH Switch Guide](https://switch.hacks.guide/) for information regarding system exploitability.
+
+## Can I use this to transfer Pokémon between the supported series?
+No. If you need to transfer Pokémon, I would recommend using Pokémon Home, as it generates tracking data server-side. Replicating this is not possible, and transferring a Pokémon between series without a valid Home tracker would render it illegal.
+
+## How do I import a PKM file?
+In Select Mode (blue cursor), press A on any empty box slot, then select the PKM file to import.
+
+## A service initialization error is returned upon launch. Is there a fix for this?
+This might be resolved by launching via HBL title override (HBL opened by holding the R button while launching a game, rather than the Album). If it is not, feel free to post the specific issue on the [GBAtemp thread](https://gbatemp.net/threads/pokeswitch-simple-pokemon-save-editor-for-switch.677289/).
+
+## Why didn't you make this ~6 years ago?
+I thought someone would make something like this but no one ever did
+
+# Acknowledgements
+The UI was created with (a slightly modified version of) [Plutonium](https://github.com/XorTroll/Plutonium) by [XorTroll](https://github.com/XorTroll).
+
+The Nintendo Switch development platform, [libnx](https://github.com/switchbrew/libnx), was provided by [Switchbrew](https://switchbrew.org/wiki/Main_Page).