Flying-squid

[] (https://gitter.im/mhsjlw/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [] (https://img.shields.io/github/issues/mhsjlw/flying-squid.svg) [] (https://circleci.com/gh/mhsjlw/flying-squid) [] (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
World generation
Anvil loading
Multi-world

Test server

rom1504.fr (Port 25565) using auto-squid

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

2.6 KiB Raw Blame History