An open API service indexing awesome lists of open source software.

https://github.com/chnapy/pkvault

Centralized pkm storage management & Pokedex app
https://github.com/chnapy/pkvault

pkhex pokedex pokemon save-editor storage

Last synced: about 1 month ago
JSON representation

Centralized pkm storage management & Pokedex app

Awesome Lists containing this project

README

          


PKVault logo

PKVault


DEMO


RELEASES
 | 
PROJECT POKEMON TOOL PAGE
 | 
PROJECT POKEMON DISCUSSION PAGE

PKVault is a Pokemon storage & save manipulation tool based on [PKHeX](https://github.com/kwsch/PKHeX).
Similar to Pokemon Home, offline as online.

This tool can be used as:

- 📥 Desktop app
- Windows -> [PKVault.exe](https://github.com/Chnapy/PKVault/releases/latest)
- Linux & SteamDeck -> [pkvault.AppImage](https://github.com/Chnapy/PKVault/releases/latest) / [pkvault.deb](https://github.com/Chnapy/PKVault/releases/latest) / [pkvault.flatpak](https://github.com/Chnapy/PKVault/releases/latest) / [pkvault](https://github.com/Chnapy/PKVault/releases/latest)

- 🐳 Docker web-app
- `image: ghcr.io/chnapy/pkvault` -> check [below for usage](#docker-usage)

![Platforms](https://img.shields.io/badge/Platform-Windows%20|%20Linux%20|%20SteamDeck%20|%20Docker-informational)
![License](https://img.shields.io/badge/License-GPLv3-blue.svg)


PKVault snapshot 1
PKVault snapshot 2
PKVault snapshot 3
PKVault snapshot 4
PKVault snapshot 5

## Bulk features

- Storage & save manipulation
- compatible with all pokemon games, from first generation to **Pokemon Legends: Z-A**
- move pokemons between saves
- convert pokemon to any generation (ex. G7 to G2)
- store pokemons outside saves using banks & boxes
- allow use of multiple "variants" for stored pokemons
- move/delete actions
- edit pokemon moves, EVs & nickname
- evolve pokemons requiring trade or trade + held-item (ex. Kadabra -> Alakazam)
- link a save pokemon with all his variants, sharing data like exp & EVs
- use of external PKM files, outside PKVault environment
- backup all saves & storage before any save action
- backups listing
- backups restore always possible
- Centralized Pokedex based on all listed saves
- views with forms & genders
- multiple filters: species name, seen/caught/owned, types, ...
- possible living dex
- possible shiny dex
- Dynamic saves listing based on paths & globs

## Docker usage

You can use a plug'n'play docker image, compatible `Linux x86_64` and `Linux ARM` (like Raspberry Pis).

`docker-compose.yml` example:

```yml
services:
pkvault:
image: ghcr.io/chnapy/pkvault:latest # or specific version, like 1.5.1
restart: unless-stopped
ports:
- "3000:3000"
environment:
- LOG_FILE_COUNT_LIMIT=10 # removes extra log files, default: 10
- BACKUP_FILE_COUNT_LIMIT=30 # removes extra backup files, default: no limit
volumes:
- ./path/to/pkvault/data:/pkvault

# save paths sample
- ./path/to/saves:/data/saves
- ./path/to/other/saves:/data/other-saves

# external-pkms path sample (optional)
- ./path/to/external-pkms:/data/external-pkms
```

> Note: with this config sample, you can use in PKVault settings:
> - Saves files locations:
> - /data/saves/ (or any subpath)
> - /data/other-saves/ (or any subpath)
> - External PKM files locations:
> - /data/external-pkms/ (or any subpath)

Perfect for homelab context.

Or using basic docker run:

```
docker run \
-p 3000:3000 \
-v ./path/to/pkvault/data:/pkvault \
-v ./path/to/saves:/data/saves \
ghcr.io/chnapy/pkvault:latest
```

## [Functional documentation](./docs/functional/en/README.md)

## [Technical documentation](./docs/technical/README.md)

Includes quick start.

## [Contribute](./.github/CONTRIBUTING.md)

## Licenses

This app (PKVault) is licensed under GPLv3 terms, as described in file [LICENSE](./LICENSE).
Your can use this app for your own projects following license restrictions.

- Backend / Desktop
- [PKHeX (Core part)](https://github.com/kwsch/PKHeX/tree/master/PKHeX.Core) - License GPLv3
- PokeApiNet - License MIT
- Versions & all others dependencies can be found into `*.csproj` files

- Frontend
- Font "Pixel Operator" - from [onlinewebfonts](http://www.onlinewebfonts.com) - License CC BY 4.0
- Font "Pokemon Emerald" - from [fontstruct](https://fontstruct.com/fontstructions/show/1975556) by "aztecwarrior28" - License CC BY-SA 3.0
- [HackerNoon's Pixel Icon Library](https://github.com/hackernoon/pixel-icon-library) - License MIT
- Versions & all others dependencies can be found into [frontend/package.json](./frontend/package.json).

All image contents of game-icons, pokemons, types, items, move-categories are Copyright The Pokémon Company.