mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-05-21 06:37:09 -05:00
0143ae28dd
The new FS module is an abstraction layer over the built-in fs module.
The main reason it exists is because I need an abstraction layer I can
disable writing from. But that'll be in another commit.
Currently, mine is better because:
- paths are always relative to PS's base directory
- Promises (seriously wtf Node Core what are you thinking)
- PS-style API: FS("foo.txt").write("bar") for easier argument order
- mkdirp
This also increases the minimum supported Node version from v6.0 to
v7.7, because we now use async/await. Sorry for the inconvenience!
This also drops the mock-fs-require-fix dependency
mock-fs-require-fix was always kind of a huge hack. It's no longer
necessary, with an FS API that does everything it used to.
This removes a lot of other hacks from test/main.js, which is nice.
183 lines
7.7 KiB
Markdown
183 lines
7.7 KiB
Markdown
Pokémon Showdown
|
|
========================================================================
|
|
|
|
Navigation: [Website][1] | **Server repository** | [Client repository][2] | [Dex repository][3]
|
|
|
|
[1]: http://pokemonshowdown.com/
|
|
[2]: https://github.com/Zarel/Pokemon-Showdown-Client
|
|
[3]: https://github.com/Zarel/Pokemon-Showdown-Dex
|
|
|
|
[](https://travis-ci.org/Zarel/Pokemon-Showdown)
|
|
[](https://david-dm.org/zarel/Pokemon-Showdown)
|
|
[](https://david-dm.org/zarel/Pokemon-Showdown#info=devDependencies)
|
|
|
|
Introduction
|
|
------------------------------------------------------------------------
|
|
|
|
This is the source code for the game server of [Pokémon Showdown][4], a website for Pokémon battling. Pokémon Showdown simulates singles, doubles and triples battles in all the games out so far (Generations 1 through 7).
|
|
|
|
This repository contains the files needed to set up your own Pokémon Showdown server. Note that to set up a server, you'll also need a server computer.
|
|
|
|
You can use your own computer as a server, but for other people to connect to your computer, you'll need to expose a port (default is 8000 but you can choose a different one) to connect to, which sometimes requires [port forwarding][5] (note that this isn't possible on certain internet connections).
|
|
|
|
[4]: http://pokemonshowdown.com/
|
|
[5]: http://en.wikipedia.org/wiki/Port_forwarding
|
|
|
|
|
|
Installing
|
|
------------------------------------------------------------------------
|
|
|
|
./pokemon-showdown
|
|
|
|
(Requires Node.js 8+)
|
|
|
|
|
|
Detailed installation instructions
|
|
------------------------------------------------------------------------
|
|
|
|
Pokémon Showdown requires you to have [Node.js][6] installed, 8.x or later (7.7 or later can work, but you might as well be on the latest stable).
|
|
|
|
Next, obtain a copy of Pokémon Showdown. If you're reading this outside of GitHub, you've probably already done this. If you're reading this in GitHub, there's a "Clone or download" button near the top right (it's green). I recommend the "Open in Desktop" method - you need to install GitHub Desktop which is more work than "Download ZIP", but it makes it much easier to update in the long run (it lets you use the `/updateserver` command).
|
|
|
|
Pokémon Showdown is installed and run using a command line. In Mac OS X, open `Terminal` (it's in Utilities). In Windows, open `Command Prompt` (type `cmd` into the Start menu and it should be the first result). Type this into the command line:
|
|
|
|
cd LOCATION
|
|
|
|
Replace `LOCATION` with the location Pokémon Showdown is in (ending up with, for instance, `cd "~/Downloads/Pokemon-Showdown"` or `cd "C:\Users\Bob\Downloads\Pokemon-Showdown\"`).
|
|
|
|
This will set your command line's location to Pokémon Showdown's folder. You'll have to do this each time you open a command line to run commands for Pokémon Showdown.
|
|
|
|
Copy `config/config-example.js` into `config/config.js`, and edit as you please.
|
|
|
|
Congratulations, you're done setting up Pokémon Showdown.
|
|
|
|
Now, to start Pokémon Showdown, run the command:
|
|
|
|
node pokemon-showdown
|
|
|
|
(If you're not on Windows, we recommend doing `./pokemon-showdown` instead.)
|
|
|
|
You can also specify a port:
|
|
|
|
node pokemon-showdown 8000
|
|
|
|
Visit your server at `http://SERVER:8000`
|
|
|
|
Replace `SERVER` with your server domain or IP. Replace `8000` with your port if it's not `8000` (the default port).
|
|
|
|
Yes, you can test even if you are behind a NAT without port forwarding: `http://localhost:8000` will connect to your local machine. Some browser setups might prevent this sort of connection, however (NoScript, for instance). If you can't get connecting locally to work in Firefox, try Chrome.
|
|
|
|
You will be redirected to `http://SERVER.psim.us`. The reason your server is visited through `psim.us` is to make it more difficult for servers to see a user's password in any form, by handling logins globally. You can embed this in an `iframe` in your website if the URL is a big deal with you.
|
|
|
|
If you truly want to host the client yourself, there is [a repository for the Pokémon Showdown Client][7]. It's not recommended for beginners, though.
|
|
|
|
[6]: https://nodejs.org/
|
|
[7]: https://github.com/Zarel/Pokemon-Showdown-Client
|
|
|
|
|
|
Setting up an Administrator account
|
|
------------------------------------------------------------------------
|
|
|
|
Once your server is up, you probably want to make yourself an Administrator (~) on it.
|
|
|
|
### config/usergroups.csv
|
|
|
|
To become an Administrator, create a file named `config/usergroups.csv` containing
|
|
|
|
USER,~
|
|
|
|
Replace `USER` with the username that you would like to become an Administrator. Do not put a space between the comma and the tilde.
|
|
|
|
This username must be registered. If you do not have a registered account, you can create one using the Register button in the settings menu (it looks like a gear) in the upper-right of Pokémon Showdown.
|
|
|
|
Once you're an administrator, you can promote/demote others easily with the `/globaladmin`, `/globalleader`, `/globalmod`, etc commands.
|
|
|
|
|
|
Browser support
|
|
------------------------------------------------------------------------
|
|
|
|
Pokémon Showdown currently supports, in order of preference:
|
|
|
|
- Chrome
|
|
- Firefox
|
|
- Opera
|
|
- Safari 5+
|
|
- IE11+
|
|
- Chrome/Firefox/Safari for various mobile devices
|
|
|
|
Pokémon Showdown is usable, but expect degraded performance and certain features not to work in:
|
|
|
|
- Safari 4+
|
|
- IE9+
|
|
|
|
Pokémon Showdown is mostly developed on Chrome, and Chrome or the desktop client is required for certain features like dragging-and-dropping teams from PS to your computer. However, bugs reported on any supported browser will usually be fixed pretty quickly.
|
|
|
|
|
|
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]: http://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/Zarel/Pokemon-Showdown/issues/2444
|
|
|
|
|
|
License
|
|
------------------------------------------------------------------------
|
|
|
|
Pokémon Showdown's server is distributed under the terms of the [MIT License][10].
|
|
|
|
[10]: https://github.com/Zarel/Pokemon-Showdown/blob/master/LICENSE
|
|
|
|
|
|
Credits
|
|
------------------------------------------------------------------------
|
|
|
|
Owner
|
|
|
|
- Guangcong Luo [Zarel] - Development, Design, Sysadmin
|
|
|
|
Staff
|
|
|
|
- Chris Monsanto [chaos] - Sysadmin
|
|
- Leonardo Julca [Slayer95] - Development
|
|
- Mathieu Dias-Martins [Marty-D] - Research (game mechanics), Development
|
|
- [The Immortal] - Development
|
|
|
|
Retired Staff
|
|
|
|
- Bill Meltsner [bmelts] - Development, Sysadmin
|
|
- Cathy J. Fitzpatrick [cathyjf] - Development, Sysadmin
|
|
- Hugh Gordon [V4] - Research (game mechanics), Development
|
|
- Juanma Serrano [Joim] - Development, Sysadmin
|
|
|
|
Major Contributors
|
|
|
|
- Bär Halberkamp [bumbadadabum] - Development
|
|
- Kevin Lau [Ascriptmaster] - Development, Art (battle animations)
|
|
- Konrad Borowski [xfix] - Development
|
|
- Quinton Lee [sirDonovan] - Development
|
|
|
|
Contributors
|
|
|
|
- Andrew Goodsell [Zracknel] - Art (battle weather backdrops)
|
|
- Avery Zimmer [Lyren, SolarisFox] - Development
|
|
- Ben Davies [Morfent] - Development
|
|
- Ben Frengley [TalkTakesTime] - Development
|
|
- Cody Thompson [Rising_Dusk] - Development
|
|
- Ian Clail [Layell] - Art (battle graphics, sprites)
|
|
- Jeremy Piemonte [panpawn] - Development
|
|
- Neil Rashbrook [urkerab] - Development
|
|
- Robin Vandenbrande [Quinella] - Development
|
|
- [Ridaz] - Art (battle animations)
|
|
- Tobias Mann [asgdf] - Development
|
|
|
|
Special thanks
|
|
|
|
- See http://pokemonshowdown.com/credits
|