.gitignore

@@ -9,4 +9,5 @@ distTest
 world/*
 !world/.gitkeep
 package-lock.json
-/README.md
+worlds*
+native/

Dockerfile

@@ -1,9 +1,8 @@
-FROM node:16-slim
+FROM node:18-slim
 
 WORKDIR /app
-COPY package.json ./
-RUN npm config set bin-links false
-RUN npm install
-COPY . .
+# COPY package.json scripts src ./
+# todo shouldn't copy non-existent our outdated dist
+COPY package.json dist
 
-ENTRYPOINT [ "node", "app.js", "-c", "/config" ]
+ENTRYPOINT node dist/app.js -c /config

README.md

@@ -0,0 +1,47 @@
+# Space Squid
+
+> TypeScript fork of [Flying Squid](https://github.com/PrismarineJS/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`:
+
+```bash
+npm i -g @zardoy/flying-squid
+```
+
+```bash
+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
+
+0. Clone, setup Node.js (at least v18.6.0)
+1. Install dependencies: `npm install` or `pnpm install`
+2. Run `npm run dev`, `npm run start` for without watch or `npm run watch` for watch mode (for prismarine-web-client)
+2.1. If using [Bun](https://bun.sh) (experimental) instead: `bun --watch src/app.js` or `bun --hot src/app.js` (preview)

package.json

@@ -14,6 +14,9 @@
   "scripts": {
     "start": "tsc && node dist/app.js",
     "build": "tsc && node scripts/genTypes.mjs",
+    "dev": "tsx watch src/app.js",
+    "watch": "concurrently \"tsc -w\" \"nodemon --watch dist/index.js scripts/genTypes.mjs\"",
+    "make-exe": "pkg dist/app.js --targets node18-win-x64",
     "build-npm": "tsc -p tsconfig.npm.json && node scripts/genTypes.mjs",
     "prepare": "pnpm build",
     "lint": "eslint src/**",
@@ -24,7 +27,7 @@
     "test-essential": "echo todo",
     "test-all": "echo todo",
     "test": "echo TODO",
-    "pretest": "npm run lint"
+    "pretest": "echo TODO-soon"
   },
   "keywords": [
     "browser",
@@ -36,19 +39,17 @@
     "node": ">=8"
   },
   "dependencies": {
+    "@tootallnate/once": "2.0.0",
     "change-case": "^4.1.2",
-    "colors": "1.4.0",
-    "diamond-square": "^1.2.0",
+    "chalk": "^5.3.0",
+    "diamond-square": "github:zardoy/diamond-square",
     "emit-then": "^2.0.0",
-    "event-promise": "^0.0.1",
     "exit-hook": "^2.2.1",
     "flatmap": "^0.0.3",
     "long": "^5.1.0",
-    "minecraft-data": "^3.42.1",
+    "minecraft-data": "3.67.0",
     "minecraft-protocol": "^1.44.0",
     "mkdirp": "^2.1.3",
-    "moment": "^2.10.6",
-    "needle": "^2.5.0",
     "node-gzip": "^1.1.2",
     "node-rsa": "^1.1.1",
     "prismarine-chunk": "^1.35.0",
@@ -58,23 +59,33 @@
     "prismarine-provider-anvil": "github:zardoy/prismarine-provider-anvil#everything",
     "prismarine-windows": "^2.8.0",
     "prismarine-world": "^3.6.2",
+    "rambda": "^9.2.0",
     "random-seed": "^0.3.0",
     "range": "^0.0.3",
     "readline": "^1.3.0",
+    "sanitize-filename": "^1.6.3",
     "typed-emitter": "1.4.0",
     "uuid-1345": "^1.0.1",
     "vec3": "^0.1.8",
     "yaml": "^2.4.1",
     "yargs": "^17.0.1"
   },
   "devDependencies": {
+    "concurrently": "^8.2.2",
     "expect": "^29.1.2",
-    "flying-squid": "file:.",
     "longjohn": "^0.2.12",
     "minecraft-wrap": "^1.2.3",
     "mineflayer": "^4.0.0",
     "mocha": "^10.0.0",
-    "typescript": "^5.3.3",
+    "nodemon": "^3.1.4",
+    "pkg": "^5.8.1",
+    "tsx": "^4.10.1",
+    "typescript": "^5.6.3",
     "vitest": "^0.34.6"
+  },
+  "pnpm": {
+    "overrides": {
+      "protodef": "npm:@zardoy/protodef"
+    }
   }
 }

scripts/genTypes.mjs

@@ -4,9 +4,20 @@ import fs from 'fs'
 const targetFile = './dist/types.d.ts';
 const plugins = fs.readdirSync('./dist/lib/modules').filter(f => f !== 'index')
 let types = ''
-types = plugins.filter(module => module.endsWith('.d.ts')).map(module => `import "./lib/plugins/${module}"`).join('\n') + '\n' + types
+types = plugins.filter(module => module.endsWith('.d.ts')).map(module => `import "./lib/modules/${module}"`).join('\n') + '\n' + types
 fs.writeFileSync(targetFile, types, 'utf8')
 
 let indexTs = fs.readFileSync('./dist/index.d.ts', 'utf8')
 indexTs = `import './types';` + indexTs
 fs.writeFileSync('./dist/index.d.ts', indexTs, 'utf8')
+
+const modules = fs.readdirSync('./dist/lib/modules').filter(f => f !== 'index' && f.endsWith('.js')).map(f => f.replace('.js', ''))
+const modulesReqLines = modules.map(m => `'${m}': require('./${m}')`).join(',\n')
+const modulesFileJs = `
+module.exports = {
+    builtinPlugins: {
+        ${modulesReqLines}
+    }
+}
+`
+fs.writeFileSync('./dist/lib/modules/index.js', modulesFileJs, 'utf8')

src/app.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 
-const argv = require('yargs/yargs')(process.argv.slice(2))
+const yargs = require('yargs/yargs')(process.argv.slice(2))
+
+const argv = yargs
   .usage('Usage: $0 <command> [options]')
   .help('h')
   .option('config', {
@@ -23,13 +25,25 @@ const argv = require('yargs/yargs')(process.argv.slice(2))
     type: 'boolean',
     default: 'false'
   })
+  .option('port', {
+    description: 'Port to run the server on',
+    type: 'number',
+    default: '25565'
+  })
+  .option('ver', {
+    description: 'The version of the server to run (for clients and world)',
+    type: 'string',
+  })
+  .option('world', {
+    description: 'Path to Java world save folder',
+    type: 'string',
+  })
   .argv
 
-const mcServer = require('./index')
-
-//@ts-ignore
 const defaultSettings = require('../config/default-settings.json')
+const mcServer = require('./index')
 
+/** @type {Options} */
 let settings
 
 try {
@@ -42,12 +56,36 @@ settings = Object.assign(settings, defaultSettings, settings)
 if (argv.offline) settings['online-mode'] = false
 if (argv.log) settings.logging = true
 if (argv.op) settings['everybody-op'] = true
+if (argv.port) settings.port = +argv.port
+if (argv.ver) settings.version = argv.ver
+if (argv.world) settings.worldFolder = argv.world === 'false' ? false : argv.world
 
 if (!require('./lib/version').supportedVersions.includes(settings.version)) {
-  throw new Error(`Version ${settings.version} is not supported.`)
+  // throw new Error(`Version ${settings.version} is not supported.`)
+  console.warn(`Version ${settings.version} is not supported.`)
+}
+
+if (globalThis.server) {
+  globalThis.__hot_reload = true
+  settings.oldServerData = globalThis.server
 }
 
-module.exports = globalThis.server = mcServer.createMCServer(settings)
+const server = mcServer.createMCServer(settings)
+
+globalThis.server = {
+  _server: server._server,
+  cleanupFunctions: server.cleanupFunctions,
+  players: server.players,
+  oldData: {}
+}
+module.exports = server
+
+const saveData = ['time']
+server.on('tick', () => {
+  for (const data of saveData) {
+    globalThis.server.oldData[data] = server[data]
+  }
+})
 
 process.on('unhandledRejection', err => {
   console.log(err.stack)

src/blockRenames.test.ts

@@ -0,0 +1,11 @@
+import { test, expect } from 'vitest'
+import { getRenamedData } from './blockRenames'
+
+test('works', () => {
+  expect(getRenamedData('blocks', 'short_grass', '1.20.3', '1.8.8')).toEqual('tallgrass')
+  expect(getRenamedData('blocks', ['standing_sign', 'grass'], '1.8.8', '1.16')).toEqual(['oak_sign', 'grass_block'])
+  expect(getRenamedData('blocks', ['stone'], '1.8.8', '1.8.8')).toEqual(['stone'])
+  expect(getRenamedData('blocks', ['stone'], '1.20.3', '1.20.3')).toEqual(['stone'])
+  expect(getRenamedData('blocks', ['stone'], '1.8.8', '1.20.4')).toEqual(['stone'])
+  expect(getRenamedData('blocks', ['planks'], '1.8.8', '1.20.4')).toEqual(['oak_planks'])
+})

src/blockRenames.ts

@@ -1,13 +1,9 @@
 import itemBlockRenames from './itemBlockRenames.json'
+import { versionToNumber } from './utils'
 
 // postflatenning
 // todo regen 1.13 the flatenning data
 
-const versionToNumber = (ver: string) => {
-  const [x, y = '0', z = '0'] = ver.split('.')
-  return +`${x.padStart(2, '0')}${(parseInt(y).toString().padStart(2, '0'))}${parseInt(z).toString().padStart(2, '0')}`
-}
-
 // const allRenamesMapFromLatest = Object.fromEntries(
 //   ['blocks', 'items'].map(x =>
 //     [
@@ -29,7 +25,7 @@ export const adoptBlockOrItemNamesFromLatest = (type: 'blocks' | 'items', blockO
   const mapVersions = Object.keys(itemBlockRenames).sort((a, b) => dir * (versionToNumber(a) - versionToNumber(b)))
   const upperBoundVer = dir > 0 ? verTo : verFrom
   const lowerBoundVer = dir > 0 ? verFrom : verTo
-  for (const mapVersion of mapVersions) {
+  for (const mapVersion of mapVersions.filter(x => versionToNumber(x) <= upperBoundVer && versionToNumber(x) >= lowerBoundVer)) {
     if (dir > 0 && versionToNumber(mapVersion) >= upperBoundVer) break
     if (dir < 0 && versionToNumber(mapVersion) <= lowerBoundVer) break
     const nextMapData = itemBlockRenames[mapVersion][type]