System Requirements
Pokemon Showdown requires Node.js to run. Make sure you have the correct version installed before proceeding.Pokemon Showdown requires Node.js v22 or later for full compatibility. Earlier versions may not work correctly.
Check Your Node.js Version
Verify your Node.js installation:n package manager:
Installation Steps
Clone the Repository
Download Pokemon Showdown from GitHub:
Using Git is recommended over downloading a ZIP file, as it makes updating your server much easier with the
/updateserver command.Create Configuration File
Copy the example configuration to create your server config:You can edit
config/config.js to customize your server settings. See the Configuration guide for details.Starting the Server
Pokemon Showdown can be started with several options:Default Start
Custom Port
Start on a specific port:Skip Build
Skip the build process if you know your files are up to date:Accessing Your Server
Once your server is running, you can access it through your browser:Local Access
Visit
http://localhost:8000 to connect from the same machine running the server.Remote Access
Visit
http://YOUR-IP:8000 where YOUR-IP is your server’s public IP address.Network Configuration
Port Forwarding
For users to connect to your server from outside your local network, you’ll need to forward the server port (default 8000) through your router.Some internet service providers block server hosting entirely. In this case, you’ll need to rent a VPS (Virtual Private Server) to host your server.
Windows Git Requirements
If you’re on Windows, you may need to link Git’s UNIX commands to your PATH to build Pokemon Showdown:- See Git for Windows FAQ for instructions
Testing Your Installation
You can test your server locally even if you’re behind a NAT without port forwarding:- Start your server
- Visit
http://localhost:8000in your browser - You should see the Pokemon Showdown client interface
Some browser security setups (like NoScript) might prevent local connections. If Firefox doesn’t work, try Chrome.
Command Line Interface
Thepokemon-showdown executable supports several commands:
CLI Options
--skip-build- Skip the TypeScript build process--helpor-h- Display help information--debugor-D- Enable debug mode for battle simulation--replayor-R- Enable replay mode--spectateor-S- Enable spectator mode
Next Steps
Configuration
Customize your server settings, ports, and features
Administration
Set up administrator accounts and manage users
Security
Secure your server for production deployment
Troubleshooting
Node.js Version Errors
If you see an error about Node.js version:Build Errors
If the build fails, try:- Delete the
node_modulesanddistdirectories - Run
npm install - Try starting the server again
Connection Issues
If you can’t connect to your server:- Verify the server is running (check terminal output)
- Confirm you’re using the correct port
- Check firewall settings
- Verify port forwarding if accessing remotely
