phoriah / rbxmk

A tool for processing Roblox files.

rbxmk is a command-line tool for manipulating Roblox files.

rbxmk is useful for development workflows that involve the combination of many separate files. If your project is organized as Lua files for scripting and model files for assets, rbxmk makes it simple to combine them into a final product, be it a game, plugin, model, module, and so on. rbxmk is also suitable for more simple actions, such as downloading models or publishing games.

Download

The current version of rbxmk is v0.9.1. The following builds are available for download:

Windows	Mac	Linux
Windows 64-bit	macOS	Linux 64-bit
Windows 32-bit		Linux 32-bit

See the Release page for more information on the current version.

rbxmk is fully featured, but thorough testing of all features is still a work in progress. Please practice redundancy and use backups to reduce the risk of data loss. Be sure to report issues as you encounter them!

Usage

rbxmk is a command-line tool, and so requires a command-line interface to use.

rbxmk primarily uses Lua scripts to produce and retrieve data, transform it, and send it off to a variety of sources. The main subcommand is run, which executes a script:

echo 'print("Hello world!")' > hello-world.lua
rbxmk run hello-world.lua
# Hello world!

The Documentation page provides a complete reference on how rbxmk is used, as well as the API of the Lua environment provided by rbxmk.

Examples

The examples directory contains examples of rbxmk scripts.

• Convert an asset URL in the clipboard to a model in the clipboard
• Download an asset to a local file

Installation

In addition to prebuilt releases, rbxmk can be installed manually.

1. Install Go
2. Install Git
3. Using a shell with Git (such as Git Bash), run the following command:

go install github.com/anaminus/rbxmk/rbxmk@latest

If you installed Go correctly, this will install the latest version of rbxmk to $GOPATH/bin, which will allow you run it directly from a shell.

A specific version of rbxmk may be installed by replacing latest with a version number (e.g. v0.9.1).

Development

To compile and install the bleeding-edge version, the best way is to clone the repository:

git clone https://github.com/anaminus/rbxmk
cd rbxmk/rbxmk
go install

More information is available in the INSTALL document.

An effort is made to ensure that the latest commit will at least compile. However, it is not guaranteed that everything will be in a production-ready state.

License

The source code for rbxmk is available under the MIT license.