Pokémon Showdown ========================================================================
Navigation: [Website][1] | Server repository | [Client repository][2] | [Dex repository][3]
[1]: http://pokemonshowdown.com/ [2]: https://github.com/smogon/pokemon-showdown-client [3]: https://github.com/Zarel/Pokemon-Showdown-Dex
Introduction ------------------------------------------------------------------------
Pokémon Showdown is many things:
- A website you can use for Pokémon battling
- A JavaScript library for simulating Pokémon battles and getting Pokédex data
- Some command-line tools for simulating Pokémon battles (which can be used in non-JavaScript programs)
- A web API for the web site for Pokémon battling
- A game server for hosting your own Pokémon Showdown community and game modes
Pokémon Showdown simulates singles, doubles and triples battles in all the games out so far (Generations 1 through 9).
Documentation quick links ------------------------------------------------------------------------
- [PROTOCOL.md][4] - How the client and server communicate with each other.
- [sim/SIM-PROTOCOL.md][5] - The part of the protocol used for battles and battle messages.
- [CONTRIBUTING.md][6] - Useful code standards to understand if you want to send pull requests to PS (not necessary if you're just using the code and not planning to contribute back).
- [ARCHITECTURE.md][7] - A high-level overview of how the code works.
- [Bot FAQ][8] - An FAQ compiled by Kaiepi regarding making Pokemon Showdown bots - mainly chatbots and battle bots.
Community ------------------------------------------------------------------------
PS has a built-in chat service. Join our main server to talk to us!
You can also visit the [Pokémon Showdown forums][9] for discussion and help.
[9]: https://www.smogon.com/forums/forums/pok%C3%A9mon-showdown.209/
If you'd like to contribute to programming and don't know where to start, feel free to check out [Ideas for New Developers][10].
[10]: https://github.com/smogon/pokemon-showdown/issues/2444
License ------------------------------------------------------------------------
Pokémon Showdown's server is distributed under the terms of the [MIT License][11].
[11]: ./LICENSE
Credits ------------------------------------------------------------------------
Owner
- Guangcong Luo [Zarel] - Development, Design, Sysadmin
- Andrew Werner [HoeenHero] - Development
- Annika L. [Annika] - Development
- Chris Monsanto [chaos] - Development, Sysadmin
- Kris Johnson [dhelmise] - Development
- Leonard Craft III [DaWoblefet] - Research (game mechanics)
- Mathieu Dias-Martins [Marty-D] - Research (game mechanics), Development
- Mia A [Cassiopeia] - Development
- See http://pokemonshowdown.com/credits