node package manager

brp

brp (excuse me!)

The command line tool that lets you build resource packs

circle-ci dependencies dev-dependencies code-climate js-standard-style


Brp (pronounced like burp) is a simplified build tool for Minecraft resource packs heavily influenced by Gulp. (This might as well be a fork!) Brp strives to accomplish the following goals:

  • Offer an ecosystem for building resource packs (not editing!)
  • Overcome shortcomings in the resource pack format
  • Embrace modularity and encourage 'remix' packs

Features

Brp ships with the following features right out-of-the-box:

  • Project structure based on file prefixes

Install

Make sure you have the latest version of Node installed first!

npm install brp -g

This should allow you to use brp on the command line. If it doesn't work for you, try fixing your PATH environment variable and restart your computer.

Alternatively, you can launch the cli from a local installation without installing brp globally.

cd $(npm bin)
./brp

Standard Project Structure

[project root]/
├── tmp/                # Temporary files created by brp plugins
├── dist/               # Zipped resource packs ready for distribution
├── src/                # Project source files (with prefixes)
└── brpfile.js          # Contains the project's build configuration information

Most projects will also contain files required by other applications, such as .gitignore and package.json.

Gotchas

  • Only the first prefix found in a path will be used. For example, a file with the path assets/#first/#second test.png will be reduced to assets/#second test.png with the prefix first.