# Poké Classic Framework

https://pkmnclassic.net/

Poké Classic Framework is a replacement server and class library for Pokémon
Generations 4 and 5. Poké Classic Network is the name of the server itself.

## How to connect

AltWFC is configured to automatically direct you to my servers. Follow the
[instructions](https://github.com/polaris-/dwc_network_server_emulator/wiki) 
at their wiki to connect.

## What works

* GTS
* Battle Videos
* Dressup (PtHGSS)
* Box uploads (PtHGSS)
* Musical photos (BW1/2)
* Wi-Fi Battle Tower and Subway

Direct communications are handled by 
[AltWFC](https://github.com/polaris-/dwc_network_server_emulator) and are
outside the scope of this project. They work at the time of writing but 
haven't been tested that thoroughly.

## What doesn't

* Trainer Rankings (PtHGSS)
* Wi-Fi Plaza (PtHGSS)
* Game Sync
* Rating Battles / Competitions

## What's planned

* A much more awesome website
* Cheat detection
* Stat checking in a similar manner as Pokécheck
* Game Sync (I will need help with this!)

## How you can help

If there's something you want to see, the best thing is to discuss it with me
and prepare a pull request. You should also check for open issues marked
[Help Wanted](https://github.com/mm201/pkmn-classic-framework/labels/help%20wanted).
Not all of them require programming skill.

The most significant way you can help is simply by using it. The GTS is nothing
without users. Get on there and start trading!

## Credits

* [Project Pokémon](https://projectpokemon.org/) for most of the original fake
GTS reverse engineering work, file format and data structure descriptions, and
many ID number tables, including items and trendy phrases.
* [Pipian](http://www.pipian.net/ierukana/) for more reverse engineering help,
including the Battle Tower and Wi-fi Plaza.
* [Nagato](https://github.com/polaris-), for help reverse engineering the Game
Sync protocol.
* [Billy](https://billy.wales/) for help with GameSpy protocols and interfacing
with Wiimmfi.
* Nagato and other contributors to the
[AltWFC](https://github.com/barronwaffles/dwc_network_server_emulator) project,
which this project depends on for basic Nintendo Wi-Fi fuctionality.
* [Eevee](https://veekun.com/) for her Veekun Pokédex and large sprite rips.
* [Bulbapedia](https://bulbapedia.bulbagarden.net/wiki/Main_Page) for most item
sprites and Generation 3 item/text conversion tables.
* [kaphotics](https://twitter.com/kaphotics) for the Pokémon mini sprite rips
from ORAS.
* [sosnek](https://github.com/sosnek) for help with held item validation.
* [msikma](https://github.com/msikma/pokesprite) and 
[monsanto](https://github.com/smogon/sprites) for their sprite databases.
* GatorShark and Magical for their
[Spinda spot documentation](https://gatorshark.webs.com/SpindaDocumentation.htm)
and [Python implementation](https://github.com/magical/spinda), respectively.
