flying-squid/README.md
2015-08-24 10:59:04 -04:00

22 lines
1.1 KiB
Markdown

Minecraft Server
================
[![Minecraft version](https://img.shields.io/badge/minecraft%20version-1.8-brightgreen.svg)](http://wiki.vg/Protocol)
[![Github issues](https://img.shields.io/github/issues/mhsjlw/node-minecraft-server.svg)](https://img.shields.io/github/issues/mhsjlw/node-minecraft-server.svg)
[![Build Status](https://img.shields.io/circleci/project/mhsjlw/node-minecraft-server/master.svg)](https://circleci.com/gh/mhsjlw/node-minecraft-server) [![Gratipay](https://img.shields.io/gratipay/mhsjlw.svg)](https://gratipay.com/~mhsjlw/)
A semi-functional minecraft server in Node.js
## Building / Running
Before running or building it is recommended that you configure the server in config/settings.json
npm install
node app.js
## Documentation
Documentation for how to operate and how to customize your server are coming soon!
## Contributors
- @roblabla for helping out with the protocols
- The PrismarineJS team for creating prismarine-chunk and node-minecraft-protcol
- [wiki.vg](http://wiki.vg/Protocols) for documenting minecraft protocols