dan/flying-squid
1
0
Fork 0
mirror of https://github.com/danbulant/flying-squid synced 2026-05-21 13:18:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
flying-squid/docs
History
Lucas Simon 80b6042187 Rename /doc to /docs and move docsify site to it
2018-06-02 15:23:09 -07:00
..
classes Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
other Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
_coverpage.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
_sidebar.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
CONTRIBUTE-kr.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
CONTRIBUTE.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
examples.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
HISTORY.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
index.html Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00
README.md Rename /doc to /docs and move docsify site to it 2018-06-02 15:23:09 -07:00

README.md

flying-squid

NPM version Join the chat at https://gitter.im/PrismarineJS/flying-squid License Minecraft version Github issues Build Status

A semi-functional minecraft server in Node.js

Test server

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

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 a voxel world generator written in Rust, compatible with flying-squid and allows basic minecraft-like generation including caves.
  • 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 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 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
  • flying-squid-modpe load modpe plugins
  • 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 and the rest of the documentation to get started writing custom plugins or contributing to the development!