<commit_before>Flying-squid
================

[![NPM version](https://img.shields.io/npm/v/flying-squid.svg)](http://npmjs.com/package/flying-squid)
[![Join the chat at https://gitter.im/mhsjlw/flying-squid](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mhsjlw/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![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/flying-squid.svg)](https://img.shields.io/github/issues/mhsjlw/flying-squid.svg)
[![Build Status](https://img.shields.io/circleci/project/mhsjlw/flying-squid/master.svg)](https://circleci.com/gh/mhsjlw/flying-squid) [![Gratipay](https://img.shields.io/gratipay/mhsjlw.svg)](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 server!
We created an auto updating test server (see the repository [here](https://github.com/mhsjlw/autonomous-squid))

Connection address: 172.16.17.32 (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](https://github.com/mhsjlw/autonomous-squid)

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

## Dev Documentation
For development see [api.md](doc/api.md), [contribute.md](doc/contribute.md) and [history.md](doc/history.md)

## Using as a lib

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

```js<commit_msg>add instruction for global installation<commit_after>Flying-squid
================

[![NPM version](https://img.shields.io/npm/v/flying-squid.svg)](http://npmjs.com/package/flying-squid)
[![Join the chat at https://gitter.im/mhsjlw/flying-squid](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mhsjlw/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![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/flying-squid.svg)](https://img.shields.io/github/issues/mhsjlw/flying-squid.svg)
[![Build Status](https://img.shields.io/circleci/project/mhsjlw/flying-squid/master.svg)](https://circleci.com/gh/mhsjlw/flying-squid) [![Gratipay](https://img.shields.io/gratipay/mhsjlw.svg)](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 server!
We created an auto updating test server (see the repository [here](https://github.com/mhsjlw/autonomous-squid))

Connection address: 172.16.17.32 (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](https://github.com/mhsjlw/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](doc/api.md), [contribute.md](doc/contribute.md) and [history.md](doc/history.md)

## Using as a lib

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

```js
{'fraction_non_alphanumeric': 0.15467535723238907, 'fraction_numerical': 0.011030333416896465, 'mean_word_length': 5.10091743119266, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 28, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1707433', 'n_tokens_mistral': 1511, 'n_tokens_neox': 1368, 'n_words': 288}