mirror of
https://github.com/danbulant/flying-squid
synced 2026-06-18 14:01:13 +00:00
50 lines
No EOL
2.9 KiB
Markdown
50 lines
No EOL
2.9 KiB
Markdown
flying-squid
|
|
================
|
|
|
|
[](http://npmjs.com/package/flying-squid)
|
|
[](https://gitter.im/PrismarineJS/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](LICENSE)
|
|
[](http://wiki.vg/Protocol)
|
|
[](https://img.shields.io/github/issues/PrismarineJS/flying-squid.svg)
|
|
[](https://circleci.com/gh/PrismarineJS/flying-squid)
|
|
|
|
A semi-functional minecraft server in Node.js
|
|
|
|
## Test server
|
|
|
|
* rom1504.fr (Port 25565) using [auto-squid](https://github.com/rom1504/auto-squid)
|
|
|
|
## 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.
|
|
|
|
## 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
|
|
|
|
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.
|
|
Http api available in the test instance at [flying-squid.rom1504.fr](http://flying-squid.rom1504.fr)
|
|
* [flying-squid-modpe](https://github.com/PrismarineJS/flying-squid-modpe) load modpe plugins
|
|
* [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
|
|
|
|
## Getting Started
|
|
|
|
Check out our [examples](/examples) and the rest of the documentation to get started writing custom plugins or contributing to the development! |