complete reorganization : client plugins, server plugins

.gitignore

@@ -1,23 +1 @@
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules

app.js

@@ -1,19 +1,6 @@
-var mc = require('minecraft-protocol');
+var mcServer=require("./index");
-var states = mc.states;
+
 var settings = require('./config/settings');
-var World = require('prismarine-chunk');
-var fs = require('fs');
-var timeStarted = Math.floor(new Date() / 1000).toString();
-var playersConnected = [];
-var uuidToPlayer = {};
-var vec3 = require("vec3");
-
-
-function toFixedPosition(p)
-{
-  return new vec3(Math.floor(p.x*32),Math.floor(p.y*32),Math.floor(p.z*32))
-}
-
 
 var options = {
   motd: settings.motd,
@@ -22,291 +9,6 @@ var options = {
   'online-mode': settings.onlineMode
 };
 
-var world = new World();
+mcServer.createMCServer(options);
-for (var x = 0; x < 16;x++) {
-  for (var z = 0; z < 16; z++) {
-    world.setBlockType(x, 50, z, 2);
-    for (var y = 0; y < 256; y++) {
-      world.setSkyLight(x, y, z, 15);
-    }
-  }
-}
-
-var entityMaxId=0;
-
-var server = mc.createServer(options);
-
-  if(settings.logging == true) {
-    createLog();
-  }
-
-function transformUuid(s)
-{
-  return s.split("-").map(function(item) { return parseInt(item, 16); });
-}
-
-server.on('login', function(client) {
-  if(uuidToPlayer[client.uuid])
-  {
-    client.end("You are already connected");
-    return;
-  }
-  entityMaxId++;
-  client.id=entityMaxId;
-	playersConnected.push(client);
-  uuidToPlayer[client.uuid]=client;
 
 
-  // send init data so client will start rendering world
-  client.write('login', {
-    entityId: client.id,
-    levelType: 'default',
-    gameMode: 0,
-    dimension: 0,
-    difficulty: 0,
-    reducedDebugInfo: false,
-    maxPlayers: server.maxPlayers
-  });
-
-    var packetData = {
-    x: 0,
-    z: 0,
-    groundUp: true,
-    bitMap: 0xffff,
-    chunkData: world.dump()
-  };
-
-  client.write('map_chunk', packetData);
-
-    client.write('position', {
-      x: 6,
-      y: 53,
-      z: 6,
-      yaw: 0,
-      pitch: 0,
-      flags: 0x00
-    });
-
-    console.log("[INFO]: position written, player spawning...");
-    log("[INFO]: position written, player spawning...");
-
-    client.write('update_time', {
-      age: [0,0],
-      time: [0,1]
-    });
-
-    client.write('game_state_change', {
-      reason: 3,
-      gameMode: 0
-    });
-
-  client.on('chat', function(data) {
-    var message = '<'+client.username+'>' + ' ' + data.message;
-    playerChat(message, client.username);
-    console.log("[INFO] " + message);
-    log("[INFO] " + message);
-  });
-
-  client.on('packet', function(packet) {
-    // we don't really need to see the server pass an object every 10nth of a second so I will just disable this
-    //console.log("[INFO] " + packet);
-    //log("[INFO] " + packet);
-  });
-
-  function getOtherClients()
-  {
-    return playersConnected.filter(function(otherClient){return otherClient!=client});
-  }
-
-  var otherClients=getOtherClients();
-
-  otherClients.forEach(function(otherClient) {
-    otherClient.write('player_info', {
-      action: 0,
-      data: [{
-        UUID: transformUuid(client.uuid),
-        name: client.username,
-        properties: [],
-        gamemode: 0,
-        ping: 1,
-        hasDisplayName: true,
-        displayName: client.username
-      }]
-    });
-  });
-
-    client.write('player_info', {
-      action: 0,
-      data: playersConnected
-        .map(function(otherClient) {
-          return {
-            UUID: transformUuid(otherClient.uuid),
-            name: otherClient.username,
-            properties: [],
-            gamemode: 0,
-            ping: 1,
-            hasDisplayName: true,
-            displayName: otherClient.username
-          };
-        })
-    });
-
-
-  otherClients.forEach(function(otherClient) {
-      var pos=uuidToPlayer[otherClient.uuid].position;
-      client.write('named_entity_spawn', {
-        entityId: otherClient.id,
-        playerUUID: transformUuid(otherClient.uuid),
-        x: pos ? pos.x : 6*32,
-        y: pos ? pos.y : 53*32,
-        z: pos ? pos.z : 6*32,
-        yaw: 0,
-        pitch: 0,
-        currentItem: 0,
-        metadata: []
-      });
-      otherClient.write('named_entity_spawn', {
-        entityId: client.id,
-        playerUUID: transformUuid(client.uuid),
-        x: 6*32,
-        y: 53*32,
-        z: 6*32,
-        yaw: 0,
-        pitch: 0,
-        currentItem: 0,
-        metadata: []
-      });
-  });
-
-  broadcast(client.username + ' joined the game.', "yellow");
-  var addr = client.socket.remoteAddress + ':' + client.socket.remotePort;
-  console.log("[INFO]: " + client.username + ' connected', '(' + addr + ')');
-  log("[INFO]: " + client.username + ' connected', '(' + addr + ')');
-
-  client.on('end', function() {
-    broadcast(client.username + ' joined the game.', "yellow");
-    console.log("[INFO]: " + client.username+' disconnected', '('+addr+')');
-    log("[INFO]: " + client.username+' disconnected', '('+addr+')');
-  });
-
-  client.on('position', function(packet) {
-    var position = new vec3(packet.x,packet.y,packet.z);
-    var onGround=packet.onGround;
-    sendRelativePositionChange(client,toFixedPosition(position),onGround);
-  });
-
-
-  function writeOthers(packetName,packetFields)
-  {
-    getOtherClients().forEach(function (otherClient) {
-      otherClient.write(packetName, packetFields);
-    });
-  }
-
-
-  function sendRelativePositionChange(client,newPosition,onGround) {
-    if (uuidToPlayer[client.uuid].position) {
-      var diff = newPosition.minus(uuidToPlayer[client.uuid].position);
-      if (diff.distanceTo(new vec3(0, 0, 0)) != 0) {
-
-        writeOthers('rel_entity_move', {
-          entityId: client.id,
-          dX: diff.x,
-          dY: diff.y,
-          dZ: diff.z,
-          onGround: onGround
-        });
-      }
-    }
-    uuidToPlayer[client.uuid].position = newPosition;
-    uuidToPlayer[client.uuid].onGround=onGround;
-  }
-
-  client.on('error', function(error) {
-    console.log('[ERR] ' + error.stack);
-    log('[ERR]: Client: ' + error.stack);
-  });
-
-});
-
-server.on('error', function(error) {
-  console.log('[ERR] ', error.stack);
-  log('[ERR]: Server:', error.stack);
-});
-
-server.on('listening', function() {
-  console.log('[INFO]: Server listening on port', server.socketServer.address().port);
-  log('[INFO]: Server listening on port', server.socketServer.address().port);
-});
-
-// function broadcast(message, username) {
-//   var client, translate;
-//   translate = username ? 'chat.type.announcement' : 'chat.type.text';
-//   username = username || 'Server';
-//   for (var clientId in server.clients) {
-//     if (!server.clients.hasOwnProperty(clientId)) continue;
-
-//     client = server.clients[clientId];
-//     var msg = {
-//       translate: translate,
-//       "with": [
-//         username
-//       ]
-//     };
-//     if (typeof message === "string") {
-//       msg["with"].push(message);
-//     } else {
-//       Object.keys(message).forEach(function(key) {
-//         if (key === "text") {
-//           msg["with"].push(message[key]);
-//         } else {
-//           msg[key] = message[key];
-//         }
-//       });
-//     }
-
-//     client.write('success', { message: JSON.stringify(msg) });
-//   }
-
-function createLog() {
-	fs.writeFile("logs/" + timeStarted + ".log", "[INFO]: Started logging...\n", function(err, data) {
-	if (err) return console.log(err);
-	});
-}
-
-function log(message) {
-  if(settings.logging == true) {
-	 fs.appendFile("logs/" + timeStarted + ".log", message + "\n", function (err) { });
-  }
-}
-
-function playerChat(message, exclude, username) {
-  var client;
-  //translate = username ? 'chat.type.text' : 'chat.type.text';
-  username = username  || '';
-  for(var clientId in server.clients) {
-    if(!server.clients.hasOwnProperty(clientId)) continue;
-
-    client = server.clients[clientId];
-    if(client !== exclude) {
-      var msg = {
-        "text": username + message
-      };
-      client.write('chat', { message: JSON.stringify(msg), position: 0 });
-    }
-  }
-}
-
-function broadcast(message, color) {
-  var client;
-  for(var clientId in server.clients) {
-    if(!server.clients.hasOwnProperty(clientId)) continue;
-
-    client = server.clients[clientId];
-      var msg = {
-        "text": message,
-        "color": color
-      };
-      client.write('chat', { message: JSON.stringify(msg), position: 0 });
-  }
-}

index.js

@@ -0,0 +1,54 @@
+var mc = require('minecraft-protocol');
+var EventEmitter = require('events').EventEmitter;
+var util = require('util');
+var path = require('path');
+var requireIndex = require('requireindex');
+var serverPlugins = requireIndex(path.join(__dirname, 'lib', 'serverPlugins'));
+var clientPlugins = requireIndex(path.join(__dirname, 'lib', 'clientPlugins'));
+
+module.exports = {
+  createMCServer:createMCServer
+};
+
+function createMCServer(options) {
+  options = options || {};
+  var mcServer = new MCServer();
+  mcServer.connect(options);
+  return mcServer;
+}
+
+function MCServer() {
+  EventEmitter.call(this);
+  this._server = null;
+}
+util.inherits(MCServer, EventEmitter);
+
+MCServer.prototype.connect = function(options) {
+  var self = this;
+  self._server = mc.createServer(options);
+
+  for(var pluginName in serverPlugins) {
+    serverPlugins[pluginName](self, options);
+  }
+
+  if(options.logging == true) {
+    self.createLog();
+  }
+
+  self._server.on('error', function(error) {
+    console.log('[ERR] ', error.stack);
+    self.log('[ERR]: Server:', error.stack);
+  });
+
+  self._server.on('listening', function() {
+    console.log('[INFO]: Server listening on port', self._server.socketServer.address().port);
+    self.log('[INFO]: Server listening on port', self._server.socketServer.address().port);
+  });
+
+  self._server.on('login', function (client) {
+    for(var pluginName in clientPlugins) {
+      clientPlugins[pluginName](self, client, options);
+    }
+    self.login(client);
+  });
+};

lib/clientPlugins/login.js

@@ -0,0 +1,229 @@
+var log = require("../serverPlugins/log").log;
+
+module.exports=inject;
+
+function transformUuid(s)
+{
+  return s.split("-").map(function(item) { return parseInt(item, 16); });
+}
+
+
+function inject(serv,client)
+{
+  serv.login=login;
+
+  function addPlayer()
+  {
+    serv.entityMaxId++;
+    client.id = serv.entityMaxId;
+    serv.playersConnected.push(client);
+    console.log(client.uuid);
+    serv.uuidToPlayer[client.uuid] = client;
+  }
+
+  function sendLogin()
+  {
+    // send init data so client will start rendering world
+    client.write('login', {
+      entityId: client.id,
+      levelType: 'default',
+      gameMode: 0,
+      dimension: 0,
+      difficulty: 0,
+      reducedDebugInfo: false,
+      maxPlayers: serv._server.maxPlayers
+    });
+  }
+  function sendMap()
+  {
+    client.write('map_chunk', {
+      x: 0,
+      z: 0,
+      groundUp: true,
+      bitMap: 0xffff,
+      chunkData: serv.world.dump()
+    });
+  }
+
+  function sendInitialPosition()
+  {
+    client.write('position', {
+      x: 6,
+      y: 53,
+      z: 6,
+      yaw: 0,
+      pitch: 0,
+      flags: 0x00
+    });
+  }
+
+  function updateTime()
+  {
+    client.write('update_time', {
+      age: [0, 0],
+      time: [0, 1]
+    });
+  }
+
+  function updateGameState()
+  {
+    client.write('game_state_change', {
+      reason: 3,
+      gameMode: 0
+    });
+  }
+
+  function announceLogin()
+  {
+    client.on('chat', function (data) {
+      var message = '<' + client.username + '>' + ' ' + data.message;
+      playerChat(message, client.username);
+      console.log("[INFO] " + message);
+      serv.log("[INFO] " + message);
+    });
+  }
+
+  function fillTabList()
+  {
+    serv.otherClients(client).forEach(function (otherClient) {
+      otherClient.write('player_info', {
+        action: 0,
+        data: [{
+          UUID: transformUuid(client.uuid),
+          name: client.username,
+          properties: [],
+          gamemode: 0,
+          ping: 1,
+          hasDisplayName: true,
+          displayName: client.username
+        }]
+      });
+    });
+
+    client.write('player_info', {
+      action: 0,
+      data: serv.playersConnected
+        .map(function (otherClient) {
+          return {
+            UUID: transformUuid(otherClient.uuid),
+            name: otherClient.username,
+            properties: [],
+            gamemode: 0,
+            ping: 1,
+            hasDisplayName: true,
+            displayName: otherClient.username
+          };
+        })
+    });
+  }
+
+  function spawn()
+  {
+    serv.otherClients(client).forEach(function (otherClient) {
+      var pos = serv.uuidToPlayer[otherClient.uuid].position;
+      client.write('named_entity_spawn', {
+        entityId: otherClient.id,
+        playerUUID: transformUuid(otherClient.uuid),
+        x: pos ? pos.x : 6 * 32,
+        y: pos ? pos.y : 53 * 32,
+        z: pos ? pos.z : 6 * 32,
+        yaw: 0,
+        pitch: 0,
+        currentItem: 0,
+        metadata: []
+      });
+      otherClient.write('named_entity_spawn', {
+        entityId: client.id,
+        playerUUID: transformUuid(client.uuid),
+        x: 6 * 32,
+        y: 53 * 32,
+        z: 6 * 32,
+        yaw: 0,
+        pitch: 0,
+        currentItem: 0,
+        metadata: []
+      });
+    });
+  }
+
+  function announceJoin()
+  {
+    broadcast(client.username + ' joined the game.', "yellow");
+    var addr = client.socket.remoteAddress + ':' + client.socket.remotePort;
+    console.log("[INFO]: " + client.username + ' connected', '(' + addr + ')');
+    serv.log("[INFO]: " + client.username + ' connected', '(' + addr + ')');
+  }
+
+
+  function playerChat(message, exclude, username) {
+    var client;
+    //translate = username ? 'chat.type.text' : 'chat.type.text';
+    username = username  || '';
+    for(var clientId in server.clients) {
+      if(!serv._server.clients.hasOwnProperty(clientId)) continue;
+
+      client = serv._server.clients[clientId];
+      if(client !== exclude) {
+        var msg = {
+          "text": username + message
+        };
+        client.write('chat', { message: JSON.stringify(msg), position: 0 });
+      }
+    }
+  }
+
+
+
+
+  function broadcast(message, color) {
+    var client;
+    for(var clientId in serv._server.clients) {
+      if(!serv._server.clients.hasOwnProperty(clientId)) continue;
+
+      client = serv._server.clients[clientId];
+      var msg = {
+        "text": message,
+        "color": color
+      };
+      client.write('chat', { message: JSON.stringify(msg), position: 0 });
+    }
+  }
+
+
+  function login()
+  {
+    if (serv.uuidToPlayer[client.uuid]) {
+      client.end("You are already connected");
+      return;
+    }
+    addPlayer();
+    sendLogin();
+    sendMap();
+    sendInitialPosition();
+
+    console.log("[INFO]: position written, player spawning...");
+    serv.log("[INFO]: position written, player spawning...");
+
+    updateTime();
+    updateGameState();
+    announceLogin();
+    fillTabList();
+    spawn();
+
+    announceJoin();
+
+
+    var addr = client.socket.remoteAddress + ':' + client.socket.remotePort;
+    client.on('end', function () {
+      broadcast(client.username + ' joined the game.', "yellow");
+      console.log("[INFO]: " + client.username + ' disconnected', '(' + addr + ')');
+      serv.log("[INFO]: " + client.username + ' disconnected', '(' + addr + ')');
+    });
+
+
+    client.on('error', function (error) {
+      console.log('[ERR] ' + error.stack);
+      serv.log('[ERR]: Client: ' + error.stack);
+    });
+  }
+}

lib/clientPlugins/updatePositions.js

@@ -0,0 +1,35 @@
+var vec3 = require("vec3");
+
+module.exports=inject;
+
+function toFixedPosition(p)
+{
+  return new vec3(Math.floor(p.x*32),Math.floor(p.y*32),Math.floor(p.z*32))
+}
+
+function inject(serv,client)
+{
+  client.on('position', function (packet) {
+    var position = new vec3(packet.x, packet.y, packet.z);
+    var onGround = packet.onGround;
+    sendRelativePositionChange(client, toFixedPosition(position), onGround);
+  });
+
+  function sendRelativePositionChange(client, newPosition, onGround) {
+    if (serv.uuidToPlayer[client.uuid].position) {
+      var diff = newPosition.minus(serv.uuidToPlayer[client.uuid].position);
+      if (diff.distanceTo(new vec3(0, 0, 0)) != 0) {
+
+        serv.writeOthers(client,'rel_entity_move', {
+          entityId: client.id,
+          dX: diff.x,
+          dY: diff.y,
+          dZ: diff.z,
+          onGround: onGround
+        });
+      }
+    }
+    serv.uuidToPlayer[client.uuid].position = newPosition;
+    serv.uuidToPlayer[client.uuid].onGround = onGround;
+  }
+}

lib/serverPlugins/communication.js

@@ -0,0 +1,16 @@
+module.exports=inject;
+
+function inject(serv)
+{
+  serv.writeOthers=function(client,packetName, packetFields) {
+    serv.otherClients(client).forEach(function (otherClient) {
+      otherClient.write(packetName, packetFields);
+    });
+  };
+
+  serv.otherClients = function(client) {
+    return serv.playersConnected.filter(function (otherClient) {
+      return otherClient != client
+    });
+  };
+}

lib/serverPlugins/log.js

@@ -0,0 +1,24 @@
+module.exports=inject;
+
+var fs = require('fs');
+var timeStarted = Math.floor(new Date() / 1000).toString();
+
+function inject(serv,settings) {
+
+  serv.log=log;
+  serv.createLog=createLog;
+
+  function log(message) {
+    if (settings.logging == true) {
+      fs.appendFile("logs/" + timeStarted + ".log", message + "\n", function (err) {
+      });
+    }
+  }
+
+
+  function createLog() {
+    fs.writeFile("logs/" + timeStarted + ".log", "[INFO]: Started logging...\n", function (err, data) {
+      if (err) return console.log(err);
+    });
+  }
+}

lib/serverPlugins/players.js

@@ -0,0 +1,8 @@
+module.exports=inject;
+
+function inject(serv)
+{
+  serv.entityMaxId=0;
+  serv.playersConnected=[];
+  serv.uuidToPlayer={};
+}

lib/serverPlugins/world.js

@@ -0,0 +1,17 @@
+var World = require('prismarine-chunk');
+
+module.exports=inject;
+
+function inject(serv) {
+
+  serv.world=new World();
+
+  for (var x = 0; x < 16;x++) {
+    for (var z = 0; z < 16; z++) {
+      serv.world.setBlockType(x, 50, z, 2);
+      for (var y = 0; y < 256; y++) {
+        serv.world.setSkyLight(x, y, z, 15);
+      }
+    }
+  }
+}

package.json

@@ -20,7 +20,8 @@
     "mocha": "~2.2.5",
     "chai": "~3.2.0",
     "prismarine-chunk": "~0.1.0",
-    "vec3":"0.1.3"
+    "vec3":"0.1.3",
+    "requireindex": "~1.0.0"
   },
   "repository": {
     "type": "git",