https://github.com/prismarinejs/flying-squid
Create Minecraft servers with a powerful, stable, and high level JavaScript API.
https://github.com/prismarinejs/flying-squid
game minecraft minecraft-server protocol server voxel
Last synced: 12 months ago
JSON representation
Create Minecraft servers with a powerful, stable, and high level JavaScript API.
- Host: GitHub
- URL: https://github.com/prismarinejs/flying-squid
- Owner: PrismarineJS
- License: mit
- Created: 2015-08-25T23:30:19.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2025-06-20T07:18:07.000Z (12 months ago)
- Last Synced: 2025-06-24T15:24:38.380Z (12 months ago)
- Topics: game, minecraft, minecraft-server, protocol, server, voxel
- Language: JavaScript
- Homepage: https://prismarinejs.github.io/flying-squid/
- Size: 1.11 MB
- Stars: 574
- Watchers: 16
- Forks: 99
- Open Issues: 105
-
Metadata Files:
- Readme: docs/README.md
- License: LICENSE
Awesome Lists containing this project
README
flying-squid
================
[](http://npmjs.com/package/flying-squid)
[](https://github.com/PrismarineJS/flying-squid/actions?query=workflow%3A%22CI%22)
[](https://discord.gg/GsEFRM8)
[](https://gitter.im/PrismarineJS/general)
[](https://irc.gitter.im/)
Create Minecraft servers with a powerful, stable, and high level JavaScript API.
## Features
* Support for Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.21
* 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
## Building / Running
Before running or building it is recommended that you configure the server in `config/settings.json`
```bash
npm install
node app.js
```
You can also install flying-squid globally with `sudo npm install -g flying-squid` and then run it with `flying-squid` command.
### Docker
Docker allows for a higher level of isolation, compatibility and consistency. You can learn how to install Docker [here](https://www.docker.com/get-started).
Quick start a simple server to test out flying-squid:
```bash
docker run -p 25565:25565 prismarinejs/flying-squid
```
With specific configuration and a container name:
```bash
docker run -p 25565:25565 -v $(pwd)/config:/config --name my-flying-squid prismarinejs/flying-squid
```
[docker-compose](https://docs.docker.com/compose/) is useful to quickly launch & stop a single container with a specific configuration.
`docker-compose.yaml`:
```yaml
version: '3.8'
services:
flying-squid:
image: prismarinejs/flying-squid
volumes:
- ${PWD}/config:/config
ports:
- "25565:25565"
volumes:
flying-squid:
```
```bash
docker-compose -f path/to/docker-compose.yaml up
```
Or do it all locally:
```bash
docker build -t local-flying-squid .
docker run -p 25565:25565 local-flying-squid
```
or
```bash
docker-compose up
```
## World generation
There are several modules than can be used to generate the world. The default one is called diamond-square
* [node-voxel-worldgen](https://github.com/mhsjlw/node-voxel-worldgen): a voxel world generator written in Rust, compatible with flying-squid and allows basic minecraft-like generation including caves.
* [diamond-square](https://github.com/PrismarineJS/diamond-square): a diamond square minecraft generation.
* superflat: a superflat worldgen with configurable blocks and biome.
To install a world generation, all you have to do is npm install it and then change the generation option in settings.json.
## Plugins
* [flying-squid-irc](https://github.com/rom1504/flying-squid-irc) a bridge between a irc chan and the minecraft server.
Currently used between our test server (rom1504.fr) and our gitter room (through the official gitter irc bridge)
* [flying-squid-schematic](https://github.com/rom1504/flying-squid-schematic) Flying-squid plugin providing /listSchemas and /loadSchema commands.
You can add schema through a simple http api and then add them in your world by just calling /loadSchema in game.
* [flying-squid-essentials](https://github.com/DeudlyYT/Flying-Squid-Essentials) Plugin that in a future will be like Essentials of bukkit/spigot.
All the basic commands that a server should have
* [squidcord](https://github.com/dada513/SquidCord) a bridge between a discord channel and the minecraft server.
* [authme](https://github.com/TheAlan404/flying-squid-authme) an auth plugin for `online-mode=false` servers.
## Documentation
For development see the [API documentation](API.md), [CONTRIBUTE.md](CONTRIBUTE.md) and [HISTORY.md](HISTORY.md)
## Using as a lib
flying-squid is also a server lib. Here is a basic example of usage:
```js
const mcServer = require('flying-squid')
mcServer.createMCServer({
'motd': 'A Minecraft Server \nRunning flying-squid',
'port': 25565,
'max-players': 10,
'online-mode': true,
'logging': true,
'gameMode': 1,
'difficulty': 1,
'worldFolder': 'world',
'generation': {
'name': 'diamond_square',
'options': {
'worldHeight': 80
}
},
'kickTimeout': 10000,
'plugins': {
},
'modpe': false,
'view-distance': 10,
'player-list-text': {
'header': 'Flying squid',
'footer': 'Test server'
},
'everybody-op': true,
'max-entities': 100,
'version': '1.18'
})
```
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).
For further examples, see the [examples page](https://PrismarineJS.github.io/flying-squid/#/examples).
## Contributors
- [@mhsjlw](https://github.com/mhsjlw) creator of flying-squid
- [@roblabla](https://github.com/roblabla) for helping out with the protocols
- [@rom1504](https://github.com/rom1504) for massive contributions to the code
- [@demipixel](https://github.com/demipixel)
- The PrismarineJS team for creating prismarine-chunk and node-minecraft-protocol
- [wiki.vg](http://wiki.vg/Protocol) for documenting minecraft protocols
- All of our other awesome contributors!