initial commit

.github/workflows/auto-update.yml

@@ -0,0 +1,37 @@
+name: NPM Release
+on:
+  # schedule:
+  #   - cron: "0 0 */3 * *" # Every 2 days
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: pnpm/[email protected]
+        with:
+          version: latest
+          run_install: |
+            args: [--no-frozen-lockfile, --strict-peer-dependencies]
+      - run: git checkout gh-pages ./data/
+      - id: shouldContinue
+        run: pnpx tsx src/checkNeedsPublish.ts
+      - run: echo $OUTPUT
+        env:
+          OUTPUT: ${{ steps.shouldContinue.outputs.shouldContinue }}
+      - name: Set publishing config
+        run: pnpm config set '//registry.npmjs.org/:_authToken' "${NODE_AUTH_TOKEN}"
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - run: pnpx zardoy-release npm --auto-update
+        if: steps.shouldContinue.outputs.shouldContinue == 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: peaceiris/actions-gh-pages@v3
+        if: steps.shouldContinue.outputs.shouldContinue == 'true'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: data
+          force_orphan: true

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: NPM Release
+on:
+  push:
+    branches: [main]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: pnpm/[email protected]
+        with:
+          version: latest
+          run_install: |
+            args: [--no-frozen-lockfile, --strict-peer-dependencies]
+      - run: git checkout gh-pages ./data/
+      - name: Set publishing config
+        run: pnpm config set '//registry.npmjs.org/:_authToken' "${NODE_AUTH_TOKEN}"
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - run: pnpx zardoy-release npm
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: data
+          force_orphan: true

.gitignore

@@ -0,0 +1,32 @@
+# Learn more about paths on https://github.com/github/gitignore/blob/master/Node.gitignore
+
+node_modules
+
+build
+dist
+out
+.next
+.nuxt
+.cache
+temp
+# raw
+data/
+# npm
+dist/
+
+coverage
+*.lcov
+.nyc_output
+
+logs
+*.log
+experiment-*
+.DS_Store
+.env.local
+.env.*.local
+
+.vscode-test
+.vscode-test-web
+.eslintcache
+Thumbs.db
+.idea/

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/CVS": true,
+        "**/.DS_Store": true,
+        "**/Thumbs.db": true,
+        "temp": true,
+    }
+}

LICENSE

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2024 Vitaly Turovsky, contributors
+
+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.

README.MD

@@ -0,0 +1,23 @@
+# MC Assets
+
+![banner](./assets/mc-assets.png)
+
+```bash
+npm i mc-assets
+```
+
+**NEXT-GEN Minecraft Assets Library**
+
+## Features
+
+- **Automatic Updates** - This library is automatically updated and published to npm.
+- **Fully Typed** - Today is nothing can be done without TypeScript. We ship best type definitions possible.
+- **Early Access** - It always includes the latest pre and rc (release candidate) version.
+- **Version Accurate** - Includes all released versions starting from 1.7.10.
+- **Memory Efficient** - Small installation size, for the fastest download & loading time.
+- **Simple & Complete API** - Works in browsers out of the box and provides parsers for all the data this library provides.
+
+This module was originally designed as standalone package for [https://mcraft.fun](mcraft.fun) (repo) project so it is easier to maintain, but now it became a library that I think can cover any use case where you need to work with minecraft assets. Minecraft assets means block states, models info and texture contents, it doesn't cover minecraft data use cases.
+
+> Bundled modules & block states are version-accurate starting from 1.13.0 (post-flattening) version.
+> Tested on Node.js 18 and above.