Create README.md

JonnyD · Jan 30, 2014 · 3538304 · 3538304
1 parent 49a5f50
commit 3538304
Showing 1 changed file with 109 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,109 @@
+Skynet (beta)
+================
+
+A Minecraft bot for logging player activity on multiplayer servers.
+
+![](https://raw.github.com/JonnyD/Skynet/master/screenshot.png)
+
+## Installation
+
+ * [Install mineflayer] (https://github.com/superjoe30/mineflayer) (`npm install mineflayer`)
+ * Install moment (`npm install moment`)
+ * Install mysql (`npm install mysql`)
+ * Install async (`npm install async`)
+ * Create the database using the [following code] (http://sqlfiddle.com/#!2/32e4e9):
+
+```sql
+
+CREATE DATABASE IF NOT EXISTS `skynet`;
+USE `skynet`;
+
+CREATE TABLE IF NOT EXISTS `player` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `username` varchar(32) NOT NULL,
+  `timestamp` timestamp NOT NULL DEFAULT 0,
+  `last_login` timestamp NOT NULL DEFAULT 0,
+  `last_logout` timestamp NOT NULL DEFAULT 0,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `username` (`username`),
+  UNIQUE KEY `unique_username` (`username`),
+  KEY `index_username` (`username`)
+);
+
+CREATE TABLE IF NOT EXISTS `event_type` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(32) NOT NULL,
+  PRIMARY KEY (`id`)
+);
+
+CREATE TABLE IF NOT EXISTS `event` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `event_type_id` int(11) NOT NULL,
+  `player_id` int(32) NOT NULL,
+  `timestamp` timestamp NOT NULL DEFAULT 0,
+  PRIMARY KEY (`id`),
+  KEY `fk_event_type` (`event_type_id`),
+  KEY `fk_event_player` (`player_id`)
+);
+
+ALTER TABLE `event`
+  ADD CONSTRAINT `fk_event_player` FOREIGN KEY (`player_id`) REFERENCES `player` (`id`),
+  ADD CONSTRAINT `fk_event_type` FOREIGN KEY (`event_type_id`) REFERENCES `event_type` (`id`);
+
+CREATE TABLE IF NOT EXISTS `session` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `player_id` int(11) NOT NULL,
+  `login` int(11) NOT NULL,
+  `login_timestamp` timestamp NULL DEFAULT 0,
+  `logout` int(11) DEFAULT NULL,
+  `logout_timestamp` timestamp NULL DEFAULT 0,
+  `duration` int(11) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `unique_login` (`login`),
+  UNIQUE KEY `unique_logout` (`logout`),
+  KEY `index_player` (`player_id`)
+);
+
+ALTER TABLE `session`
+  ADD CONSTRAINT `fk_login_event` FOREIGN KEY (`login`) REFERENCES `event` (`id`),
+  ADD CONSTRAINT `fk_logout_event` FOREIGN KEY (`logout`) REFERENCES `event` (`id`),
+  ADD CONSTRAINT `fk_session_player` FOREIGN KEY (`player_id`) REFERENCES `player` (`id`);
+
+```
+
+* Update Skynet.js with your own MySQL connection settings:
+
+```js
+ var connection = mysql.createConnection({
+  host     : 'localhost',
+  user     : 'root',
+  password : '',
+  database : 'skynet'
+});
+connection.connect();
+```
+
+ * Update Skynet.js with your own Minecraft server settings:
+
+```js
+ var options = {
+  host: "mc.civcraft.vg", // optional
+  port: 25565,       // optional
+  username: "", // email and password are required only for
+  password: "",          // online-mode=true servers
+};
+ ```
+* If the server you are connecting to uses the plugin Herochat to manage its chat, overwrite 
+ mineflayer/lib/plugins/chat.js with [patch/chat.js] (https://github.com/JonnyD/Skynet/blob/master/patch/chat.js)
+
+### Website API
+ * See [Skynet-Web] (https://github.com/JonnyD/Skynet-Web)
+
+## Examples
+* [http://civplanet.com] (http://civplanet.com)
+
+## Todo
+TODO
+
+## Credits
+Created by [Jonathan Devine](http://jonnydevine.com) but standing on the shoulders of giants: thanks to [superjoe30] (https://github.com/superjoe30/mineflayer), [caolan] (https://github.com/caolan/async), [ttk2] (https://github.com/ttk2), [nickelpro] (https://github.com/nickelpro/spock) ... and more