No description
Find a file
2015-11-05 17:58:49 -08:00
config Merge pull request #72 from JWo1F/commands 2015-10-13 00:17:55 +02:00
doc I love my docs 2015-11-05 17:58:49 -08:00
examples fix basic.js, fix #74 2015-10-11 14:25:47 +02:00
logs Added logs folder 2015-08-24 09:07:10 -04:00
src Lots of stuff. 2015-11-05 17:41:16 -08:00
test fix test 2015-10-26 03:10:16 +01:00
.gitignore fix basic.js, fix #74 2015-10-11 14:25:47 +02:00
.npmignore go to es6 + use real prismarine-chunk and prismarine-world 2015-10-02 00:12:09 +02:00
app.js fix test 2015-10-26 03:10:16 +01:00
circle.yml Create circle.yml 2015-08-25 16:28:58 -04:00
gulpfile.js go to es6 + use real prismarine-chunk and prismarine-world 2015-10-02 00:12:09 +02:00
index.js go to es6 + use real prismarine-chunk and prismarine-world 2015-10-02 00:12:09 +02:00
LICENSE Create LICENSE 2015-08-25 17:35:16 -04:00
package.json Added lots of communication stuff 2015-10-24 21:02:26 -07:00
README.md update example in README 2015-10-13 14:39:45 +02:00
TODO.md Some things got done in the roadmap 2015-10-26 18:33:54 +01:00

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 for Minecraft 1.8
  • Players can see the world
  • Players see each other in-game and in tab
  • Digging
  • Placing blocks
  • Player movement

Test server

Building / Running

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": "A Minecraft Server \nRunning flying-squid",
  "port": 25565,
  "maxPlayers": 10,
  "onlineMode": true,
  "logging": true,
  "gameMode": 1,
  "generation": {
    "name":"diamond_square",
    "options":{
      "worldHeight":80
    }
  },
  "modpe": 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