Improve version support and add support for 1.19 and 1.20. (#411)

rom1504 · web-flow · commit 216fbb9bd1e2 · 2023-12-17T22:30:04.000+01:00
* Improve version support and add support for 1.19 and 1.20.

* add new versions to ci.yml

* update

* Rename readme file.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -22,7 +22,7 @@ jobs:
 
     strategy:
       matrix:
-        mcVersion: ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.1', '1.16.4', '1.17.1', '1.18.1']
+        mcVersion: ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.1', '1.16.4', '1.17.1', '1.18.1', '1.19.1', '1.20.1']
       fail-fast: false
 
     steps:
diff --git a/.gitignore b/.gitignore
@@ -4,12 +4,10 @@ package-lock.json
 versions/
 public/index.js*
 public/worker.js*
-public/supportedVersions.json
 public/textures/
 public/blocksStates/
 examples/standalone/public/index.js
 examples/standalone/public/worker.js
-examples/standalone/public/supportedVersions.json
 examples/standalone/public/textures/
 examples/standalone/public/blocksStates/
 *.DS_Store
diff --git a/.npmignore b/.npmignore
@@ -4,6 +4,5 @@ package-lock.json
 versions/
 examples/standalone/public/index.js
 examples/standalone/public/worker.js
-examples/standalone/public/supportedVersions.json
 examples/standalone/public/textures/
 examples/standalone/public/blocksStates/
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ Web based viewer for servers and bots
 
 [<img src="https://prismarinejs.github.io/prismarine-viewer/test_1.18.1.png" alt="viewer" width="300">](https://prismarinejs.github.io/prismarine-viewer/)
 
+Supports versions 1.8.8, 1.9.4, 1.10.2, 1.11.2, 1.12.2, 1.13.2, 1.14.4, 1.15.2, 1.16.1, 1.16.4, 1.17.1, 1.18.1, 1.19.1, 1.20.1.
+
 ## Install
 
 ```bash
diff --git a/examples/core/headless.js b/examples/core/headless.js
@@ -17,7 +17,9 @@ const start = (bot, { viewDistance = 6, output = 'output.mp4', frames = 200, wid
   const renderer = new THREE.WebGLRenderer({ canvas })
   const viewer = new Viewer(renderer)
 
-  viewer.setVersion(bot.version)
+  if (!viewer.setVersion(bot.version)) {
+    return false
+  }
   viewer.setFirstPersonCamera(bot.entity.position, bot.entity.yaw, bot.entity.pitch)
 
   // Load world
diff --git a/examples/electron/client/localViewer.js b/examples/electron/client/localViewer.js
@@ -28,7 +28,9 @@ class LocalViewer {
 
     // Create viewer
     this.viewer = new Viewer(this.renderer)
-    this.viewer.setVersion(this.version)
+    if (!this.viewer.setVersion(this.version)) {
+      return false
+    }
     // Attach controls to viewer
     this.controls = new MapControls(this.viewer.camera, this.renderer.domElement)
     // Enable damping (inertia) on movement
diff --git a/examples/exporter/3dmodel.js b/examples/exporter/3dmodel.js
@@ -31,7 +31,9 @@ const main = async () => {
 
   await schem.paste(world, new Vec3(0, 60, 0))
 
-  viewer.setVersion(version)
+  if (viewer.setVersion(version)) {
+    return false
+  }
 
   // Load world
   const worldView = new WorldView(world, viewDistance, center)
diff --git a/examples/exporter/screenshot.js b/examples/exporter/screenshot.js
@@ -32,7 +32,9 @@ const main = async () => {
 
   await schem.paste(world, new Vec3(0, 60, 0))
 
-  viewer.setVersion(version)
+  if (viewer.setVersion(version)) {
+    return false
+  }
 
   // Load world
   const worldView = new WorldView(world, viewDistance, center)
diff --git a/examples/standalone/index.js b/examples/standalone/index.js
@@ -29,7 +29,9 @@ async function main () {
 
   // Create viewer
   const viewer = new Viewer(renderer)
-  viewer.setVersion(version)
+  if (viewer.setVersion(version)) {
+    return false
+  }
   // Attach controls to viewer
   const controls = new MapControls(viewer.camera, renderer.domElement)
 
diff --git a/examples/standalone/webpack.config.js b/examples/standalone/webpack.config.js
@@ -35,7 +35,6 @@ const config = {
         { from: '../../public/blocksStates/', to: './blocksStates/' },
         { from: '../../public/textures/*.png', to: './textures/' },
         { from: '../../public/worker.js', to: './' },
-        { from: '../../public/supportedVersions.json', to: './' }
       ]
     })
   ],
diff --git a/examples/web_client/index.js b/examples/web_client/index.js
@@ -44,7 +44,9 @@ async function main () {
 
     // Create viewer
     const viewer = new Viewer(renderer)
-    viewer.setVersion(version)
+    if (viewer.setVersion(version)) {
+      return false
+    }
 
     worldView.listenToBot(bot)
     worldView.init(bot.entity.position)
diff --git a/examples/web_client/webpack.config.js b/examples/web_client/webpack.config.js
@@ -61,7 +61,6 @@ const config = {
         { from: '../../public/blocksStates/', to: './blocksStates/' },
         { from: '../../public/textures/', to: './textures/' },
         { from: '../../public/worker.js', to: './' },
-        { from: '../../public/supportedVersions.json', to: './' }
       ]
     }),
     new webpack.optimize.ModuleConcatenationPlugin(),
diff --git a/index.js b/index.js
@@ -3,5 +3,5 @@ module.exports = {
   standalone: require('./lib/standalone'),
   headless: require('./lib/headless'),
   viewer: require('./viewer'),
-  supportedVersions: ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.1', '1.16.4', '1.17.1', '1.18.1']
+  supportedVersions: require('./viewer').supportedVersions
 }
diff --git a/lib/headless.js b/lib/headless.js
@@ -19,7 +19,9 @@ module.exports = (bot, { viewDistance = 6, output = 'output.mp4', frames = -1, w
   const renderer = new THREE.WebGLRenderer({ canvas })
   const viewer = new Viewer(renderer)
 
-  viewer.setVersion(bot.version)
+  if (viewer.setVersion(bot.version)) {
+    return false
+  }
   viewer.setFirstPersonCamera(bot.entity.position, bot.entity.yaw, bot.entity.pitch)
 
   // Load world
diff --git a/lib/index.js b/lib/index.js
@@ -35,7 +35,9 @@ window.addEventListener('resize', () => {
 })
 
 socket.on('version', (version) => {
-  viewer.setVersion(version)
+  if (viewer.setVersion(version)) {
+    return false
+  }
 
   firstPositionUpdate = true
   viewer.listen(socket)
diff --git a/viewer/README.md b/viewer/README.md
@@ -24,6 +24,8 @@ sets the minecraft version
 
 * version is a string such as "1.16.4"
 
+Returns false and stop there if the version is not supported
+
 #### addColumn (x, z, chunk)
 
 Adds a column
diff --git a/viewer/index.js b/viewer/index.js
@@ -3,5 +3,6 @@ module.exports = {
   WorldView: require('./lib/worldView').WorldView,
   MapControls: require('./lib/controls').MapControls,
   Entity: require('./lib/entity/Entity'),
-  getBufferFromStream: require('./lib/simpleUtils').getBufferFromStream
+  getBufferFromStream: require('./lib/simpleUtils').getBufferFromStream,
+  supportedVersions: require('./lib/version').supportedVersions
 }
diff --git a/viewer/lib/version.js b/viewer/lib/version.js
@@ -1,4 +1,4 @@
-const supportedVersions = require('../../public/supportedVersions.json')
+const supportedVersions = ['1.8.8', '1.9.4', '1.10.2', '1.11.2', '1.12.2', '1.13.2', '1.14.4', '1.15.2', '1.16.1', '1.16.4', '1.17.1', '1.18.1', '1.19.1', '1.20.2']
 
 const lastOfMajor = {}
 for (const version of supportedVersions) {
@@ -24,7 +24,11 @@ function minor (version) {
 
 function getVersion (version) {
   if (supportedVersions.indexOf(version) !== -1) return version
+  const major = toMajor(version)
+  if (lastOfMajor[major] === undefined) {
+    return null
+  }
   return lastOfMajor[toMajor(version)]
 }
 
-module.exports = { getVersion }
+module.exports = { getVersion, supportedVersions }
diff --git a/viewer/lib/viewer.js b/viewer/lib/viewer.js
@@ -31,11 +31,18 @@ class Viewer {
 
   setVersion (version) {
     version = getVersion(version)
+    if (version === null) {
+      const msg = `${version} is not supported`
+      window.alert(msg)
+      console.log(msg)
+      return false
+    }
     console.log('Using version: ' + version)
     this.version = version
     this.world.setVersion(version)
     this.entities.clear()
     this.primitives.clear()
+    return true
   }
 
   addColumn (x, z, chunk) {
diff --git a/viewer/prerender.js b/viewer/prerender.js
@@ -14,7 +14,9 @@ if (!fs.existsSync(blockStatesPath)) {
   fs.mkdirSync(blockStatesPath)
 }
 
-for (const version of mcAssets.versions) {
+const supportedVersions = require('./lib/version').supportedVersions
+
+for (const version of supportedVersions) {
   const assets = mcAssets(version)
   const atlas = makeTextureAtlas(assets)
   const out = fs.createWriteStream(path.resolve(texturesPath, version + '.png'))
@@ -27,5 +29,3 @@ for (const version of mcAssets.versions) {
 
   fs.copySync(assets.directory, path.resolve(texturesPath, version), { overwrite: true })
 }
-
-fs.writeFileSync(path.resolve(__dirname, '../public/supportedVersions.json'), '[' + mcAssets.versions.map(v => `"${v}"`).toString() + ']')

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,6 @@ const config = {`
`35`	`35`	`{ from: '../../public/blocksStates/', to: './blocksStates/' },`
`36`	`36`	`{ from: '../../public/textures/*.png', to: './textures/' },`
`37`	`37`	`{ from: '../../public/worker.js', to: './' },`
`38`		`- { from: '../../public/supportedVersions.json', to: './' }`
`39`	`38`	`]`
`40`	`39`	`})`
`41`	`40`	`],`