open-index/open-npm huggingface dataset:
npm package: @nymph-ai/minecraft-assets
Description: Provide minecraft assets (nymph-ai fork)
Author: Romain Beaumont
Latest version: 1.21.11-nymph.3

# node-minecraft-assets
[![NPM version](https://img.shields.io/npm/v/minecraft-assets.svg)](http://npmjs.com/package/minecraft-assets)
[![Build Status](https://github.com/PrismarineJS/node-minecraft-assets/workflows/CI/badge.svg)](https://github.com/PrismarineJS/node-minecraft-assets/actions?query=workflow%3A%22CI%22)
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-brightgreen.svg)](https://gitter.im/PrismarineJS/general)
[![Irc](https://img.shields.io/badge/chat-on%20irc-brightgreen.svg)](https://irc.gitter.im/)

[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/node-minecraft-assets)

Provide easy access to [minecraft-assets](https://github.com/nymph-ai/minecraft-assets) in node.js

## Example

```js
const mcAssets=require("minecraft-assets")("1.8.8")

console.log("https://raw.githubusercontent.com/rom1504/minecraft-assets/master/data/1.8.8/"+mcAssets.getTexture("wheat_seeds")+".png")

console.log(mcAssets.textureContent["wheat_seeds"].texture)
```

## Documentation

 * See [doc/api.md](doc/api.md)
 * See [doc/history.md](doc/history.md)

## NPM install (alias)

This fork publishes as `@nymph-ai/minecraft-assets`. To keep existing
`require("minecraft-assets")` usage, install via an npm alias:

```bash
npm install minecraft-assets@npm:@nymph-ai/minecraft-assets
```

## Local dev with submodules

For local development, keep the `minecraft-assets` submodule checked out:

```bash
git submodule update --init --recursive
```

## Local publishing env file

This repo tracks a blank `.env`. To keep your local token out of `git status`,
configure the env filter once:

```bash
bash scripts/setup-git-filters.sh
```

## Release workflow

To bump the npm version for a Minecraft release and commit:

```bash
make release MC_VERSION=1.21.11
```

Automated releases require a GitHub secret named `NYMPH_AI_RELEASE_TOKEN`
with permission to push to `nymph-ai/node-minecraft-assets`.