/HOME-Live-Plugin

PKHeX Plugin to view and dump Pokémons from your Pokémon HOME application.

Primary LanguageC#GNU General Public License v3.0GPL-3.0

About

This program is meant to dump and view infos from those Pokèmon that are deposited into the Pokémon HOME application. This program is not intended to edit/inject Pokémon Infos directly into HOME and it will never allow to. Do not ask for any injection features.

Powered by PKHeX.Core and SysBot.Base

Features:

  • Handle (dump, load, view) PKH/EKH/PH1/EH1/PH2/EH2/PH3/EH3 (Pokémon Home format) files.
  • Generate PB7/PK8/PB8/PA8/PK9 (Pokémon Game-Specific format) files from Pokémon Home data/files.

Use Cases example:

  • Dump & preserve all your Pokémon Home PKM files, and/or load the files in PKHeX
  • Get access to all the Pokémon that are stuck beyond the first Pokémon Home Box if the Pokémon Home subscription is no longer active.
  • Generate a cloned Pokémon to be used on any of the Core game series while preserving the original data into your Pokémon Home account (this will preserve unique Go, Home, or Bank stamps).

If you need support, please write in the Project Pokémon thread. Alternatively, feel free to join my Discord server.

Notes

The creators of this tool are not responsible for any adverse outcomes or side effects of using this tool.

We do not condone use of cheating and modified data to take advantage of others. Trading converted files without disclosure could be considered scam.

Disclosure about the Dumper feature:

The Plugin creates a 1:1 dump for the encrypted Pokémon HOME data. If requested by the user, PKHeX can decrypt the dumped files. Please be aware that the Pokémon HOME data structure might change in the future.

Disclosure about the Viewer feature:

PKHeX simulates a conversion from the Pokémon HOME data format to a standard PKM file based on the current game mode loaded.

This process is unofficial and there is always the chance that it does not accurately replicate an official transfer.

If you proceed with this tool, you accept the following:

  • The PKM files from the conversion can not be considered legitimate, even if the original encounter was. The files will be legal at best.

  • Do NOT use the obtained files to report legality issues with PKHeX. Join the Manu's Discord server for support.

Prerequisites

The Home Live Plugins can not be used in EmuNand or emulators.

How to use

Download the DLL from Project Pokémon or from the GitHub Release page.

For Windows users, right click on the DLL, go to properties and select Unblock.

Move the DLL to your PKHeX' plugins folder, if you don't have it, create it near the PKHeX executable.

Open PKHeX in Let's Go/Sword/Shield/Brilliant Diamond/Shining Pearl/Legends Arceus/Scarlet/Violet mode with a blank/default save file, and click on Tools->Home Live Dumper or Tools -> Home Live Viewer to open the Plugins.

Open the Pokémon HOME application from your Nintendo Switch and tap the screen at least once. The app must be succesfully connected to internet and to your Pokémon Home Account before proceeding.

Enter your IP Address into the Plugins, select the Boxes/Slots you want to show or dump, and click "Connect".

Credits

architdate for the contributions in the initial stage of this plugin.

olliz0r and berichan for sys-botbase.

fishguy6564 and Koi-3088 for usb-botbase.

SciresM for his researches into the Pokémon Home encryption data method, implemented in his PKHeX fork.

kwsch for PKHeX and SysBot.NET

architdate, Lusamine, all the ALM team and all the people involved in the developing/testing of the PKHeX-Plugins, thanks to which this project would never exist.

PP-theSLAYER for the mutual support on the HOME research.

License

gplv3-with-text-136x68

Copyright © 2024 Manu098vm

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.