Navigation: Exiled | PS Server repository | PS Client repository | PS Dex repository
This is the source code for the Pokémon Showdown server Exiled, 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. The Exiled server also comes with some custom additions not found on the main repo. This repo will still have all the features from the main 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. Note that some internet providers don't let you host a server at all, in which case you'll have to rent a VPS to use as a server.
./pokemon-showdown
(Requires Node.js 8+)
Pokémon Showdown requires you to have Node.js installed, 8.x or later (7.7 or later can work, but you might as well be on the latest stable).
$ git clone https://github.com/DeathlyPlays/Exiled.git
cd exiled && npm install
node app.jsNext, 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.
You will probably want to configure your servers settings to your liking.
Here's some of the configurations you can change in config/config.js
-
port - The port to run the server on.
-
serverIp - The ip of your server, used to parse custom avatars.
-
tellrank - The minimum rank to use /tell for offline messaging.
-
serverName - Sets the name for several things to whatever you set it as.
Once your server is up, you probably want to make yourself an Administrator (~) on it.
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.
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.
PS has a built-in chat service. Join our main server to talk to us!
You can also visit the Pokémon Showdown forums for discussion and help.
If you'd like to contribute to programming and don't know where to start, feel free to check out Ideas for New Developers.
Exiled's and Pokémon Showdown's server is distributed under the terms of the MIT License.
This server is brought to you and maintained by the following people:
Owners
Contributors
Special thanks