• About
• Installation
  • Requirements
  • Installation steps
• Package resources
• API
• Special thanks
• More Rock Band related projects

About

RBToolsJS is a highly-typed NodeJS module with methods to manipulate several Rock Band game files, joining several functions that might help you processing these files. RBToolsJS also uses Python scripts to manipulate many kinds of files, like image and texture files.

Installation

Requirements

• NodeJS
• Python v3 & PIP: RBToolsJS uses Python scripts to manipulate many kinds of files, like image and texture files.

Installation steps

Follow the steps below to install and set up the project on your local machine:

• Install Python v3 with PIP.

• Execute the /install_python_packages.py script to install necessary Python packages:

python install_python_packages.py

• Clone the repository: If you have git installed, se the following command to clone the repository to your local machine:

git clone https://github.com/ruggeryiury/rbtools-js.git

• Install project dependencies: Navigate to the project directory and install the necessary packages by running:

npm install

Make sure that the packages folder are in the project's root folder to install all packages correctly. The reason for this is because there are some packages that is made by me and they're not uploaded to the NPM server, existing only locally.

• Config your environment file (OPTIONAL): Create a env file in the root of where you downloaded/cloned this repository and put these values:

  • RBTOOLS_DEV: Setting this variable to 1 changes the root path of the package to use src rather than the dist folder. This value is only need in development when doing new scripts to avoid building and copying the scripts to the dist folder.

Package resources

RBToolsJS comes with a few binary executables, such as:

• NVIDIA Texture Tool
• Wiimms Image Tool
• MakeMogg
• EDATTool

Also, RBToolsJS uses modified Python scripts from:

• TPL Module (from Wii.py)
• STFS Module (from py360)
• MOGG Module (from moggulator)
• Swap RB Art Bytes (from RB3DX Dependencies)

At last, RBToolsJS comes with a few special Node packages, such as:

• Path-JS: A path utility suite that gathers several functions related to a specific path.
• Set Default Options: Utility function to merge default options with user-defined ones.

API

The main exports of this package consists on classes that represents a file type to be processed. All secondary methods used on these classes is also available to import from rbtools/lib.

API DOCUMENTATION COMING SOON

Special thanks

• raphaelgoulart: Close friend and always helping me in some sort.
• Onyxite: General helping and for the creation of Onyx Toolkit!
• TrojanNemo: General helping and for the creation of Nautilus!
• LocalH: General helping and providing me the moggulator python script.
• Emma: General helping!

More Rock Band related projects

• My Customs Projects: All my customs projects.
• PRO Guitar/Bass Guide: My famous PRO Guitar/Bass guide.