Skip to content

README.md

Latest commit

 

History

History
69 lines (46 loc) · 2.5 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.5 KB
Raw

GPSS-in-a-Box

The official GPSS server shut down in January 2026. This is a local replacement you can run on your own machine to keep using GPSS with PKSM on 3DS.

It builds the latest PKHeX legality engine from source, runs everything in Docker, and includes a web viewer for browsing, searching, and exporting Pokemon. One script to set up, one command to run.

Requirements

  • Docker (includes Docker Compose)
  • A 3DS with PKSM installed, on the same Wi-Fi network

Setup

git clone https://github.com/tasken/gpss-in-a-box.git
cd gpss-in-a-box
./setup.sh
./sync-sprites.sh

setup.sh asks a few yes/no questions and handles configuring the server. sync-sprites.sh downloads Pokemon, item, and ball sprites required by the web viewer.

Connect your 3DS

After setup, the script shows your server address. In PKSM:

  1. Open the GPSS screen
  2. Set the server URL to http://<YOUR_IP>:8082/
  3. Make sure to include the / at the end

Usage

docker compose up -d       # Start
docker compose down        # Stop
docker compose logs -f     # Logs
./setup.sh                 # Update or reconfigure
./rebuild.sh               # Rebuild and restart the configured deployment
./sync-sprites.sh          # Download sprites for offline use

Open http://<YOUR_IP>:8082/ in a browser to use the web viewer.

Legality-only mode

If you only need the PKHeX legality engine as an API (no database, no web UI, no GPSS server):

LEGALITY_ONLY=1 docker compose up -d

Send raw Pokemon bytes to POST /api/legality and get back a JSON result. See API.md for details.

Docs

  • API.md - API endpoints and usage examples
  • TECHNICAL.md - how the build works, troubleshooting

License

GPL-3.0 - see LICENSE.

Credits