| config | ||
| doc | ||
| examples | ||
| logs | ||
| src | ||
| test | ||
| .gitignore | ||
| .npmignore | ||
| app.js | ||
| circle.yml | ||
| gulpfile.js | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| TODO.md | ||
Flying-squid
[
]
(https://gitter.im/mhsjlw/flying-squid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[
]
(https://img.shields.io/github/issues/mhsjlw/flying-squid.svg)
[
]
(https://circleci.com/gh/mhsjlw/flying-squid)
[
]
(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 servers
- rom1504.fr (Port 25565) using auto-squid
- 45.55.46.77 (Port 25565) using autonomous-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
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, contribute.md and history.md
Using as a lib
Flying-squid is also a server lib. Here is a basic example of usage :
var mcServer=require("flying-squid");
mcServer.createMCServer({
motd: "Basic flying-squid server",
'max-players': 10,
port: 25565,
'online-mode': true,
gameMode:0,
commands: {},
logging:false
});
You can add server plugins and player plugins in your package, following contribute.md.
Contributors
- @roblabla for helping out with the protocols
- @rom1504 for massive contributions to the code
- The PrismarineJS team for creating prismarine-chunk and node-minecraft-protcol
- wiki.vg for documenting minecraft protocols