mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-04-25 07:22:09 -05:00
94 lines
3.8 KiB
Markdown
94 lines
3.8 KiB
Markdown
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
|
|
|
|
[](https://github.com/smogon/pokemon-showdown/actions?query=workflow%3A%22Node.js+CI%22)
|
|
[](https://david-dm.org/smogon/pokemon-showdown)
|
|
[](https://david-dm.org/smogon/pokemon-showdown?type=dev)
|
|
[](https://lgtm.com/projects/g/smogon/pokemon-showdown/alerts)
|
|
|
|
|
|
Introduction
|
|
------------------------------------------------------------------------
|
|
|
|
Pokémon Showdown is many things:
|
|
|
|
- A **web site** you can use for Pokémon battling
|
|
|
|
- http://pokemonshowdown.com/
|
|
|
|
- A **JavaScript library** for simulating Pokémon battles and getting Pokédex data
|
|
|
|
- https://github.com/smogon/pokemon-showdown/blob/master/sim/README.md
|
|
|
|
- Some **command-line tools** for simulating Pokémon battles (which can be used in non-JavaScript programs)
|
|
|
|
- https://github.com/smogon/pokemon-showdown/blob/master/COMMANDLINE.md
|
|
|
|
- A **game server** for hosting your own Pokémon Showdown community and game modes
|
|
|
|
- https://github.com/smogon/pokemon-showdown/blob/master/server/README.md
|
|
|
|
Pokémon Showdown simulates singles, doubles and triples battles in all the games out so far (Generations 1 through 8).
|
|
|
|
|
|
Documentation quick links
|
|
------------------------------------------------------------------------
|
|
|
|
* [PROTOCOL.md][4] - The protocol used by the server to communicate with clients.
|
|
* [SIM-PROTOCOL.md][5] - 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).
|
|
* [Bot FAQ][7] - An FAQ compiled by Kaiepi [Kaiepi] regarding making Pokemon Showdown bots - mainly chatbots and battle bots.
|
|
|
|
[4]: https://github.com/smogon/pokemon-showdown/blob/master/PROTOCOL.md
|
|
[5]: https://github.com/smogon/pokemon-showdown/blob/master/sim/SIM-PROTOCOL.md
|
|
[6]: https://github.com/smogon/pokemon-showdown/blob/master/CONTRIBUTING.md
|
|
[7]: https://gist.github.com/Kaiepi/becc5d0ecd576f5e7733b57b4e3fa97e
|
|
|
|
|
|
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][8] for discussion and help.
|
|
|
|
[8]: 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][9].
|
|
|
|
[9]: https://github.com/smogon/pokemon-showdown/issues/2444
|
|
|
|
|
|
License
|
|
------------------------------------------------------------------------
|
|
|
|
Pokémon Showdown's server is distributed under the terms of the [MIT License][10].
|
|
|
|
[10]: https://github.com/smogon/pokemon-showdown/blob/master/LICENSE
|
|
|
|
|
|
Credits
|
|
------------------------------------------------------------------------
|
|
|
|
Owner
|
|
|
|
- Guangcong Luo [Zarel] - Development, Design, Sysadmin
|
|
|
|
Staff
|
|
|
|
- Andrew Werner [HoeenHero] - Development
|
|
- Annika L. [Annika] - Development
|
|
- Chris Monsanto [chaos] - Development, Sysadmin
|
|
- Leonard Craft III - Research (game mechanics)
|
|
- Mathieu Dias-Martins [Marty-D] - Research (game mechanics), Development
|
|
|
|
Contributors
|
|
|
|
- See http://pokemonshowdown.com/credits
|