prismarine-registry 0.1.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: possible bug
+assignees: ''
+
+---
+
+- [ ] The [readme](https://github.com/PrismarineJS/prismarine-template/README.md) doesn't contain a resolution to my issue 
+- [ ] The [example](https://github.com/PrismarineJS/prismarine-template/example.js) doesn't contain a resolution to my issue 
+
+<!-- To mark the checkbox, insert `x` into it: [x] -->
+
+## Versions
+ - node: #.#.#
+ - prismarine-template: #.#.#
+
+## Detailed description of a problem
+A clear and concise description of what the problem is.
+
+## Your current code
+```js
+console.log("Hello world.")
+```
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Additional context
+Add any other context about the problem here.
+---

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: new feature
+assignees: ''
+
+---
+
+## Is your feature request related to a problem? Please describe.
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+Add any other context or screenshots about the feature request here.

package/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,46 @@
+---
+name: Question
+about: Ask a question
+title: ''
+labels: question
+assignees: ''
+
+---
+
+- [ ] The [readme](https://github.com/PrismarineJS/prismarine-template/README.md) doesn't contain a resolution to my issue 
+- [ ] The [example](https://github.com/PrismarineJS/prismarine-template/example.js) doesn't contain a resolution to my issue 
+
+
+<!-- To mark the checkbox, insert `x` into it: [x] -->
+
+## Versions
+
+ - mineflayer: #.#.#
+ - server: vanilla/spigot/paper #.#.#
+ - node: #.#.#
+
+## Clear question
+
+A clear question, with as much context as possible.
+What are you building? What problem are you trying to solve?
+
+## What did you try yet?
+
+Did you try any method from the API?
+Did you try any example? Any error from those?
+
+## Your current code
+
+Please put here any custom code you tried yet.
+
+```js
+
+/*
+Some code here, replace this
+*/
+
+```
+
+## Additional context
+
+Add any other context about the problem here.

package/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

package/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: npm-publish
+on:
+  push:
+    branches:
+      - master # Change this to your default branch
+jobs:
+  npm-publish:
+    name: npm-publish
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@master
+    - name: Set up Node.js
+      uses: actions/setup-node@master
+      with:
+        node-version: 14.0.0
+    - id: publish
+      uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_AUTH_TOKEN }}
+    - name: Create Release
+      if: steps.publish.outputs.type != 'none'
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ steps.publish.outputs.version }}
+        release_name: Release ${{ steps.publish.outputs.version }}
+        body: ${{ steps.publish.outputs.version }}
+        draft: false
+        prerelease: false

package/.gitpod

@@ -0,0 +1,4 @@
+image:
+  file: .gitpod.DockerFile
+tasks:
+- command: npm install

package/.gitpod.DockerFile

@@ -0,0 +1,8 @@
+FROM gitpod/workspace-full:latest
+
+RUN bash -c ". .nvm/nvm.sh \
+    && nvm install 14 \
+    && nvm use 14 \
+    && nvm alias default 14"
+
+RUN echo "nvm use default &>/dev/null" >> ~/.bashrc.d/51-nvm-fix 

package/HISTORY.md

@@ -0,0 +1,5 @@
+## History
+
+### 1.0.0
+
+* initial implementation

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 PrismarineJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# prismarine-registry
+[![NPM version](https://img.shields.io/npm/v/prismarine-registry.svg)](http://npmjs.com/package/prismarine-registry)
+[![Build Status](https://github.com/PrismarineJS/prismarine-registry/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-registry/actions?query=workflow%3A%22CI%22)
+[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
+[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-registry)
+
+Registry for storing indexed data
+
+## Usage
+
+```js
+const registry = require('prismarine-registry')('1.18')
+
+registry.biomes.set(2, 'minecraft:ocean', { data: 'about an ocean biome' })
+console.assert(registry.biomes.getIndex('minecraft:ocean') === 2)
+console.log(registry.biomes.get('minecraft:ocean')) // Should get { data: 'about an ocean biome' }
+```
+
+## API
+
+Calling the default default export for `prismarine-registry` with a minecraft version will create a new set of registries.
+
+to create a registry for version 1.18,
+
+```js
+const registry = require('prismarine-registry')('1.18')
+```
+
+and to add something to the registry,
+```js
+registry.biomes.set(2, 'minecraft:ocean', { data: 'about an ocean biome' })
+```
+
+or to push with an auto-incrementing ID,
+
+```js
+registry.biomes.add('minecraft:ocean', { data: 'about an ocean biome' })
+```
+
+to get something from registry with an index,
+
+```js
+registry.biomes.getValueAt(index) => value
+registry.biomes.getName(index) => string name
+
+```
+
+A individual registry looks like this:
+
+```ts
+  interface Registry {
+    // Sets a value at a string key and numerical index
+    set(index: number, key: string, value): void
+    // Returns at what index the key was set
+    add(key: string, value): number
+
+    // Gets the value at a string key or numerical index
+    get(keyOrIndex: number | string)
+    // Get the value for the string key
+    getValue(key: string)
+    // Get value for the number index
+    getValueAt(index: number)
+
+    getName(index: number): string
+    getIndex(key: string): number
+  }
+```

package/example/mcpc-biomes.js

@@ -0,0 +1,5 @@
+const registry = require('prismarine-registry')('1.18')
+
+registry.biomes.set(2, 'minecraft:ocean', { data: 'about an ocean biome' })
+console.assert(registry.biomes.getIndex('minecraft:ocean') === 2)
+console.log(registry.biomes.get('minecraft:ocean')) // Should get { data: 'about an ocean biome' }

package/example.js

@@ -0,0 +1,3 @@
+const template = require('prismarine-template')
+
+template.helloWorld()

package/index.d.ts

@@ -0,0 +1,32 @@
+declare module "prismarine-registry" {
+  interface Registry {
+    // Sets a value at a string key and numerical index
+    set(index: number, key: string, value): void
+    // Returns at what index the key was set
+    add(key: string, value): number
+
+    // Gets the value at a string key or numerical index
+    get(keyOrIndex: number | string)
+    // Get the value for the string key
+    getValue(key: string)
+    // Get value for the number index
+    getValueAt(index: number)
+
+    getName(index: number): string
+    getIndex(key: string): number
+  }
+
+  interface BedrockRegistry {
+    biomes: Registry
+    items: Registry
+    recipes: Registry
+    commands: Registry
+  }
+
+  interface JavaRegistry {
+    biomes: Registry
+    recipes: Registry
+  }
+  
+  export default function(mcVersion: string): JavaRegistry & BedrockRegistry
+}

package/index.js

@@ -0,0 +1,9 @@
+if (typeof process !== 'undefined' && parseInt(process.versions.node.split('.')[0]) < 14) {
+  console.error('Your node version is currently', process.versions.node)
+  console.error('Please update it to a version >= 14.x.x from https://nodejs.org/')
+  process.exit(1)
+}
+
+module.exports.helloWorld = function () {
+  console.log('Hello world !')
+}

package/lib/bedrock/index.js

@@ -0,0 +1,6 @@
+const Registry = require('../registry')
+
+module.exports = (version) => ({
+  biomes: new Registry(),
+  items: new Registry()
+})

package/lib/index.js

@@ -0,0 +1,7 @@
+module.exports = (version) => {
+  if (version.startsWith('bedrock_')) {
+    return require('./bedrock')(version)
+  } else {
+    return require('./pc')(version)
+  }
+}

package/lib/pc/index.js

@@ -0,0 +1,6 @@
+const Registry = require('../registry')
+
+module.exports = (version) => ({
+  biomes: new Registry(),
+  recipes: new Registry()
+})

package/lib/registry.js

@@ -0,0 +1,39 @@
+class Registry {
+  constructor () {
+    this.data = {}
+    this.palette = []
+  }
+
+  set (index, key, value) {
+    this.palette[index] = key
+    this.data[key] = value
+  }
+
+  add (key, value) {
+    this.palette.push(key)
+    this.data[key] = value
+    return this.palette.length - 1
+  }
+
+  get (keyOrIndex) {
+    return typeof keyOrIndex === 'number' ? this.getValueAt(keyOrIndex) : this.getValue(keyOrIndex)
+  }
+
+  getValue (key) {
+    return this.data[key]
+  }
+
+  getValueAt (index) {
+    return this.data[this.palette[index]]
+  }
+
+  getName (index) {
+    return this.palette[index]
+  }
+
+  getIndex (key) {
+    return this.palette.indexOf(key)
+  }
+}
+
+module.exports = Registry

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "prismarine-registry",
+  "version": "0.1.0",
+  "description": "Prismarine Registry",
+  "main": "lib/index.js",
+  "scripts": {
+    "test": "mocha --reporter spec --exit",
+    "pretest": "npm run lint",
+    "lint": "standard",
+    "fix": "standard --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PrismarineJS/prismarine-registry.git"
+  },
+  "keywords": [
+    "prismarine",
+    "template"
+  ],
+  "author": "Romain Beaumont",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/PrismarineJS/prismarine-registry/issues"
+  },
+  "homepage": "https://github.com/PrismarineJS/prismarine-registry#readme",
+  "devDependencies": {
+    "debug": "^4.3.3",
+    "minecraft-protocol": "^1.30.0",
+    "minecraft-wrap": "^1.4.0",
+    "mocha": "^9.1.3",
+    "prismarine-registry": "file:.",
+    "standard": "^16.0.1"
+  }
+}

package/test/basic.js

@@ -0,0 +1,39 @@
+/* eslint-env mocha */
+
+const Registry = require('prismarine-registry')
+const assert = require('assert')
+
+describe('basic registry works', () => {
+  const registry = Registry('1.18')
+
+  const oceanIndex = 1
+  const oceanStringKey = 'ocean'
+  const oceanData = 'Some data about Ocean'
+
+  registry.biomes.set(oceanIndex, oceanStringKey, oceanData)
+
+  const gotValueFromKey = registry.biomes.getValue(oceanStringKey)
+  const gotValueFromIndex = registry.biomes.getValueAt(oceanIndex)
+
+  const gotNameFromIndex = registry.biomes.getName(oceanIndex)
+  const gotIndexFromName = registry.biomes.getIndex('ocean')
+
+  assert(gotValueFromIndex === oceanData)
+  assert(gotValueFromKey === oceanData)
+
+  assert(gotNameFromIndex === 'ocean')
+  assert(gotIndexFromName === 1)
+
+  // console.log('Registry', registry)
+  // console.log('Got value from key', gotValueFromKey)
+  // console.log('Got value from index', gotValueFromIndex)
+  // console.log('Got name from index', gotNameFromIndex)
+  // console.log('Got index from name', gotIndexFromName)
+
+  const exampleRecipe = { type: 'minecraft:crafting_shaped', recipeId: 'minecraft:smooth_stone_slab', data: { width: 3, height: 1, group: '', ingredients: [[[{ present: true, itemId: 165, itemCount: 1 }]], [[{ present: true, itemId: 165, itemCount: 1 }]], [[{ present: true, itemId: 165, itemCount: 1 }]]], result: { present: true, itemId: 147, itemCount: 6 } } }
+  registry.recipes.add(exampleRecipe.recipeId, exampleRecipe)
+  const x = registry.recipes.get(exampleRecipe.recipeId)
+  assert.deepStrictEqual(x, exampleRecipe)
+
+  console.log(registry)
+})

package/test/mcpc.js

@@ -0,0 +1,27 @@
+const collectPackets = require('./util/collectMcpcPackets')
+const nbt = require('prismarine-nbt')
+const Registry = require('prismarine-registry')
+
+async function main (version = '1.18') {
+  const registries = Registry(version)
+  const handlers = {
+    login (version, body) {
+      const dimensionCodec = nbt.simplify(body.dimensionCodec)
+      const biomes = dimensionCodec['minecraft:worldgen/biome'].value
+      for (const { name, id, element } of biomes) {
+        registries.biomes.set(id, name, element)
+      }
+    },
+
+    declare_recipes (version, body) {
+      for (const recipe of body.recipes) {
+        registries.recipes.add(recipe.recipeId, recipe)
+      }
+    }
+  }
+
+  collectPackets(version, Object.keys(handlers), (name, body) => handlers[name](version, body))
+}
+
+main()
+module.exports = main

package/test/mcpc.test.js

@@ -0,0 +1,10 @@
+/* eslint-env mocha */
+
+const SUPPORTED_VERSIONS = ['1.18']
+const test = require('./mcpc')
+
+describe('mcpc', () => {
+  for (const version of SUPPORTED_VERSIONS) {
+    it('works on ' + version, () => test(version))
+  }
+})

package/test/util/collectMcpcPackets.js

@@ -0,0 +1,43 @@
+const nmp = require('minecraft-protocol')
+const { startServer } = require('./downloadMcpcServer')
+const debug = require('debug')('prismarine-registry')
+
+async function collectPackets (version, names = ['login'], cb) {
+  const collected = []
+  const server = await startServer(version, 25569)
+  console.log('Started server')
+
+  const client = nmp.createClient({
+    version: version,
+    host: 'localhost',
+    port: 25569,
+    username: 'test'
+  })
+
+  let clientConnected = false
+
+  client.on('connect', () => {
+    console.log('[client] Client connected')
+    clientConnected = true
+  })
+
+  for (const name of names) {
+    client.on(name, (packet) => {
+      cb(name, packet)
+      collected.push(packet)
+    })
+  }
+
+  client.on('packet', (data, { name }) => debug('[client] -> ', name))
+
+  setTimeout(() => {
+    console.log('Stopping server')
+    server.stop()
+    client.end()
+    if (!clientConnected) {
+      throw new Error('Client never connected')
+    }
+  }, 9000)
+}
+
+module.exports = collectPackets

package/test/util/downloadMcpcServer.js

@@ -0,0 +1,28 @@
+const promisify = require('util').promisify
+const wrap = require('minecraft-wrap')
+const downloadServer = promisify(wrap.downloadServer)
+const path = require('path')
+const debug = require('debug')('prismarine-registry')
+
+async function startServer (version, port = 25569) {
+  const MC_SERVER_PATH = path.join(__dirname, `server_${version}`)
+  const MC_SERVER_JAR = path.join(__dirname, `server_${version}.jar`)
+
+  console.log('🔻 Downloading server', version)
+  await downloadServer(version, MC_SERVER_JAR)
+
+  const vServer = new wrap.WrapServer(MC_SERVER_JAR, MC_SERVER_PATH)
+
+  vServer.on('line', function (line) {
+    debug(line)
+  })
+
+  console.log('▶ Starting server', port)
+  await new Promise(resolve => vServer.startServer({ 'online-mode': 'false', 'server-port': port }, resolve))
+
+  vServer.stop = async () => new Promise((resolve, reject) => vServer.stopServer(reject, resolve))
+
+  return vServer
+}
+
+module.exports = { startServer }