@zardoy/flying-squid
v0.0.51
Published
A minecraft server written in TS
Downloads
560
Maintainers
Readme
Space Squid
TypeScript fork of Flying Squid with a focus on better DX experince for plugins!
Minecraft lightweight server written in TypeScript (JS).
- Supports latest versions (up to ~1.20)
- Easily customizable in every aspect
Installation
Node.js
If you have Node.js installed, you can install pnpm
or npm
:
npm i -g @zardoy/flying-squid
flying-squid
It's recommended to also install pm2
for process auto-restart on crashes and system reboots.
Roadmap
| Feature | Status | | ---------------- | --------------------------------------------------------------------- | | WebSocket | Not started | | Plugin API | Done. Needs polishing | | World Generation | Few simple generators available. Needs more | | World Saving | ✅ Doesn't support latest versions | | World Loading | ✅ Full support for all versions, but writing can broke existing saves | | Redstone | Not started | | Command Blocks | ✅ Needs all commands implementation (50%) | | Pvp | Not started | | Mobs | ✅ Needs spawning, ai, a few physics fixes |
Alternatives
development
- Clone, setup Node.js (at least v18.6.0)
- Install dependencies:
npm install
orpnpm install
- Run
npm run dev
,npm run start
for without watch ornpm run watch
for watch mode (for prismarine-web-client) 2.1. If using Bun (experimental) instead:bun --watch src/app.js
orbun --hot src/app.js
(preview)