Initial commit 2: adding the files

Author: Quinella

.gitignore

@@ -0,0 +1,8 @@
+/node_modules
+/node_modules/*
+npm-debug.log
+config.js
+
+.hg
+.bzr
+.svn

LICENSE

@@ -1,6 +1,9 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Robin
+Copyright (c) 2013 Robin Vandenbrande and other contributors
+
+For some parts of the code taken from Pokemon Showdown:
+Copyright (c) 2013 Guangcong Luo and other Pokemon Showdown contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -1,4 +1,49 @@
 Pokemon-Showdown-Bot
 ====================
 
-A simple chat bot for Pokémon Showdown
+A simple and very basic chat bot for [Pokémon Showdown][1].
+
+  [1]: http://www.pokemonshowdown.com/
+
+
+Installation
+------------
+
+**This is not recommended for beginners!**
+Why? Because I'm too lazy to explain everything in detail.
+
+Pokémon Showdown Bot requires [node.js][2] to run.
+This bot has not been tested on every `node.js` version possible, but has the same version requirements as [Pokémon Showdown][3]: either v0.6.3 through v0.8.22, or v0.10.2 and up.
+Install `node.js` if you don't have it yet, try the last stable version.
+
+Next up is cloning this bot. This can be done in two ways: cloning it via `git` or downloading as ZIP.
+Downloading it as ZIP is the easy and lazy way, but is a lot less handy to update than cloning this repository.
+
+To install dependencies, run:
+
+    npm install
+
+Copy `config-example.js` to `config.js` and edit the needed variables.
+To change the commands that the bot responds to, edit `commands.js`.
+
+Now, to start the bot, use:
+
+    npm main.js
+
+Some information will be shown, and will automatically join the room(s) you specified if no error occurs.
+
+  [2]: http://nodejs.org/
+  [3]: https://github.com/Zarel/Pokemon-Showdown
+
+Development
+-----------
+
+Everyone is more than welcome to contribute to the bot.
+However, please refrain from adding more example commands.
+
+License
+-------
+
+Pokémon Showdown Bot is distributed under the terms of the [MIT License][4].
+
+  [4]: https://github.com/Quinella/Pokemon-Showdown-Bot/blob/master/LICENSE

commands.js

@@ -0,0 +1,58 @@
+/**
+ * This is the file where the bot commands are located
+ *
+ * @license MIT license
+ */
+
+var http = require('http');
+var sys = require('sys');
+
+exports.commands = {
+	/**
+	 * It is recommended that you keep the following functions
+	 */
+	about: function(arg, by, room, con) {
+		var text = '**Pokémon Showdown Bot** by: Quinella';
+		this.say(con, room, text);
+	},
+	reload: function(arg, by) {
+		if (!this.hasRank(by, '#~')) return false;
+		try {
+			this.uncacheTree('./commands.js');
+			Commands = require('./commands.js').commands;
+		} catch (e) {
+			error('failed to reload: ' + sys.inspect(e));
+		}
+	},
+
+	/**
+	 * Example commands below.
+	 * Feel free to remove them and add your own.
+	 */
+	tell: 'say',
+	say: function(arg, by, room, con) {
+		if (!this.hasRank(by, '+%@&#~')) return false;
+		this.say(con, room, arg + ' (' + by + ' said this)');
+	},
+
+	joke: function(arg, by, room, con) {
+		var self = this;
+
+		var reqOpt = {
+			hostname: 'api.icndb.com',
+			path: '/jokes/random',
+			method: 'GET'
+		};
+		var req = http.request(reqOpt, function(res) {
+			res.on('data', function(chunk) {
+				try {
+					var data = JSON.parse(chunk);
+					self.say(con, room, data.value.joke);
+				} catch (e) {
+					self.say(con, room, 'Sorry, couldn\'t fetch a random joke... :(');
+				}
+			});
+		});
+		req.end();
+	}
+};

config-example.js

@@ -0,0 +1,48 @@
+// The WEBSOCKET server and port the bot should connect to.
+// Most of the time this isn't the same as the URL, check the `Request URL` of
+// the websocket.
+// If you really don't know how to do this... Run `node getserver.js URL`.
+// Fill in the URL of the client where `URL` is.
+// For example: `node getserver.js http://example-server.psim.us/`
+exports.server = 'sim.psim.us';
+exports.port = 8000;
+
+// This is the server id.
+// To know this one, you should check where the AJAX call 'goes' to when you
+// log in.
+// For example, on the Smogon server, it will say somewhere in the URL
+// ~~showdown, meaning that the server id is 'showdown'.
+// If you really don't know how to check this... run the said script above.
+exports.serverid = 'showdown';
+
+// The nick and password to log in with
+// If no password is required, leave pass empty
+exports.nick = 'Example bot nick';
+exports.pass = '';
+
+// The rooms that should be joined.
+// Joining Smogon's Showdown's Lobby is not allowed.
+exports.rooms = ['example room name', 'another example'];
+
+// The character text should start with to be seen as a command.
+// Note that using / and ! might be 'dangerous' since these are used in
+// Showdown itself.
+// Using only alphanumeric characters and spaces is not allowed.
+exports.commandcharacter = '.';
+
+// Whether this file should be watched for changes or not.
+// If you change this option, the server has to be restarted in order for it to
+// take effect.
+exports.watchconfig = false;
+
+// Secondary websocket protocols should be defined here, however, Showdown
+// doesn't support that yet, so it's best to leave this empty.
+exports.secprotocols = [];
+
+// What should be logged?
+// 0 = error, ok, info, debug, recv, send
+// 1 = error, ok, info, debug (recommended for development)
+// 2 = error, ok, info (recommended for production)
+// 3 = error, ok
+// 4 = error
+exports.debuglevel = 2;

getserver.js

@@ -0,0 +1,56 @@
+var sys = require('sys');
+var url = require('url');
+var http = require('http');
+
+if (process.argv[2]) {
+	var args = process.argv.slice(2);
+	var serverUrl = args.join(' ');
+	if (serverUrl.indexOf('://') !== -1) {
+		serverUrl = url.parse(serverUrl).host;
+	}
+	if (serverUrl.slice(-1) === '/') {
+		serverUrl = serverUrl.slice(0, -1);
+	}
+
+	console.log('Getting data for ' + serverUrl + '...');
+	console.log('This may take some time, depending on Showdown\'s speed.');
+
+	var received = false;
+	var requestOptions = {
+		hostname: 'play.pokemonshowdown.com',
+		port: 80,
+		path: '/crossdomain.php?host=' + serverUrl + '&path=',
+		method: 'GET'
+	};
+	var req = http.request(requestOptions, function(res) {
+		res.setEncoding('utf8');
+		res.on('data', function(chunk) {
+			if (received) {
+				return;
+			}
+			received = true;
+			
+			var search = 'var config = ';
+			var index = chunk.indexOf(search);
+			if (index !== -1) {
+				var data = chunk.substr(index);
+				data = data.substr(search.length, data.indexOf(';') - search.length);
+				data = JSON.parse(data);
+				console.log('---------------');
+				console.log('host: ' + data.host);
+				console.log('port: ' + data.port);
+				console.log('serverid: ' + data.id);
+			} else {
+				console.log('ERROR: failed to get data!');
+			}
+		});
+	});
+	
+	req.on('error', function (err) {
+		console.log('ERROR: ' + sys.inspect(err));
+	});
+	
+	req.end();
+} else {
+	console.log('ERROR: no URL specified!');
+}