mirror of
https://github.com/smogon/pokemon-showdown.git
synced 2026-04-30 04:36:56 -05:00
Add some basic documentation
This commit is contained in:
parent
b9699e9347
commit
46809b812f
22
README.md
Normal file
22
README.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
Showdown
|
||||||
|
========================================================================
|
||||||
|
|
||||||
|
Showdown is a simulator of Pokemon battles. It currently only supports Generation 5 (Pokemon Black and Pokemon White).
|
||||||
|
|
||||||
|
Installing
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Showdown requires Node.js (and perhaps also Socket.IO).
|
||||||
|
|
||||||
|
Copy config/config-example.js into config/config.js, and edit as you please.
|
||||||
|
|
||||||
|
After this, start Node:
|
||||||
|
|
||||||
|
cd <location of PS>
|
||||||
|
node app.js
|
||||||
|
|
||||||
|
Visit your server at `http://play.pokemonshowdown.com/?server=SERVER&serverport=PORT`
|
||||||
|
|
||||||
|
Replace SERVER with your server domain or IP, and PORT with the server's port (default is 8000).
|
||||||
|
|
||||||
|
Currently, this workflow works for testing Pokemon Showdown and testing your patches before submitting pull requests, but I wouldn't recommend running a production server this way. I'll make it easier to host your own server in the future.
|
||||||
13
config/config-example.js
Normal file
13
config/config-example.js
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
// The server port - the port to run Pokemon Showdown under
|
||||||
|
exports.port = 8000;
|
||||||
|
|
||||||
|
// The server ID - a unique ID describing this Showdown server
|
||||||
|
exports.serverid = 'showdown';
|
||||||
|
|
||||||
|
// The server token - a token to access the login database and ladder on pokemonshowdown.com
|
||||||
|
// This token must be registered for accessing the ladder, but you will still be able to login with an unregistered token.
|
||||||
|
exports.servertoken = '';
|
||||||
|
|
||||||
|
// login server URL - don't forget the http:// and the trailing slash
|
||||||
|
// this is the URL of the user database and ladder mentioned earlier
|
||||||
|
exports.loginserver = 'http://play.pokemonshowdown.com/';
|
||||||
Loading…
Reference in New Issue
Block a user