dan/flying-squid
1
0
Fork 0
mirror of https://github.com/danbulant/flying-squid synced 2026-07-05 03:00:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix updated README.md

Browse source
This commit is contained in:
Lucas Simon 2018-06-02 15:39:08 -07:00
parent 02903c8148
commit 60a92f23ce
1 changed files with 19 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/README.md
View file

@ -8,10 +8,10 @@ flying-squid
[![Github issues](https://img.shields.io/github/issues/PrismarineJS/flying-squid.svg)](https://img.shields.io/github/issues/PrismarineJS/flying-squid.svg) [![Github issues](https://img.shields.io/github/issues/PrismarineJS/flying-squid.svg)](https://img.shields.io/github/issues/PrismarineJS/flying-squid.svg)
[![Build Status](https://img.shields.io/circleci/project/PrismarineJS/flying-squid/master.svg)](https://circleci.com/gh/PrismarineJS/flying-squid) [![Build Status](https://img.shields.io/circleci/project/PrismarineJS/flying-squid/master.svg)](https://circleci.com/gh/PrismarineJS/flying-squid)
A semi-functional minecraft server in Node.js Create Minecraft servers with a powerful, stable, and high level JavaScript API.
## Features ## Features
* Support for Minecraft 1.8 * Support for Minecraft 1.8 and 1.12
* Players can see the world * Players can see the world
* Players see each other in-game and in tab * Players see each other in-game and in tab
* Digging * Digging
@ -65,28 +65,28 @@ For development see the [API documentation](https://PrismarineJS.github.io/flyin
flying-squid is also a server lib. Here is a basic example of usage: flying-squid is also a server lib. Here is a basic example of usage:
```js ```js
const mcServer = require("flying-squid"); const mcServer = require('flying-squid')
mcServer.createMCServer({ mcServer.createMCServer({
"motd": "A Minecraft Server \nRunning flying-squid", 'motd': 'A Minecraft Server \nRunning flying-squid',
"port": 25565, 'port': 25565,
"max-players": 10, 'max-players': 10,
"online-mode": true, 'online-mode': true,
"logging": true, 'logging': true,
"gameMode": 1, 'gameMode': 1,
"generation": { 'generation': {
"name": "diamond_square", 'name': 'diamond_square',
"options":{ 'options': {
"worldHeight": 80 'worldHeight': 80
} }
}, },
"kickTimeout": 10000, 'kickTimeout': 10000,
"plugins": { 'plugins': {
}, },
"modpe": false, 'modpe': false,
"view-distance": 10 'view-distance': 10
}); })
``` ```
You can add server plugins and player plugins in your package, following [CONTRIBUTE.md](https://github.com/PrismarineJS/flying-squid/blob/master/docs/CONTRIBUTE.md). You can add server plugins and player plugins in your package, following [CONTRIBUTE.md](https://github.com/PrismarineJS/flying-squid/blob/master/docs/CONTRIBUTE.md).
@ -95,6 +95,7 @@ For further examples, see the [examples page.](https://PrismarineJS.github.io/fl
## Contributors ## Contributors
- [@mhsjlw](https://github.com/mhsjlw) creator of flying-squid
- [@roblabla](https://github.com/roblabla) for helping out with the protocols - [@roblabla](https://github.com/roblabla) for helping out with the protocols
- [@rom1504](https://github.com/rom1504) for massive contributions to the code - [@rom1504](https://github.com/rom1504) for massive contributions to the code
- [@demipixel](https://github.com/demipixel) - [@demipixel](https://github.com/demipixel)