/flying-squid

A minecraft server written in node.js, modularized

Primary LanguageJavaScriptMIT LicenseMIT

Flying-squid

NPM version [Join the chat at https://gitter.im/mhsjlw/flying-squid] (https://gitter.im/mhsjlw/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) License Minecraft version [Github issues] (https://img.shields.io/github/issues/mhsjlw/flying-squid.svg) [Build Status] (https://circleci.com/gh/mhsjlw/flying-squid) [Gratipay] (https://gratipay.com/~mhsjlw/)

A semi-functional minecraft server in Node.js

Features

  • Support minecraft 1.8
  • Players can see the world
  • Players see each other in-game and in tab
  • Digging
  • Placing blocks
  • Player movement

Test servers

Building / Running

It requires gulp so if you don't have it installed do so by running : npm install gulp -g Before running or building it is recommended that you configure the server in config/settings.json

npm install
node app.js

Or try our autoupdating flying-squid server autonomous-squid

You can also install flying-squid globally with sudo npm install -g flying-squid and then run it with flying-squid command.

Documentation

Documentation for how to operate and how to customize your server are coming soon!

Dev Documentation

For development see api.md, contribute.md and history.md

Using as a lib

Flying-squid is also a server lib. Here is a basic example of usage :

var mcServer=require("flying-squid");

mcServer.createMCServer({
  motd: "Basic flying-squid server",
  'max-players': 10,
  port: 25565,
  'online-mode': true,
  gameMode:0,
  commands: {},
  logging:false
});

You can add server plugins and player plugins in your package, following contribute.md.

Contributors

  • @roblabla for helping out with the protocols
  • @rom1504 for massive contributions to the code
  • The PrismarineJS team for creating prismarine-chunk and node-minecraft-protcol
  • wiki.vg for documenting minecraft protocols