flying-squid/README.md
Romain Beaumont 282dab7f7e Release 0.1.0
2015-08-30 20:20:22 +02:00

2.4 KiB

Flying-squid

NPM version Join the chat at https://gitter.im/mhsjlw/flying-squid License Minecraft version Github issues Build Status Gratipay

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 server!

We created an auto updating test server (see the repository here)

Connection address: 45.55.62.8 (Port 25565, default port)

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

Documentation

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

Dev Documentation

For development see api.md and contribute.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 craftyjs 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