Skip to content
/ rbxmk Public

A tool for processing Roblox files.

License

Notifications You must be signed in to change notification settings

Anaminus/rbxmk

Repository files navigation

rbxmk logo

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

rbxmk is useful for development workflows that involve many separate files. If your project is organized into a number of files, such as Lua files for scripting and model files for assets, rbxmk makes it simple to combine these files into a final product, be it a game, plugin, model, and so on.

Download

This project is unstable! Use at your own risk!

The current version of rbxmk is v0.6.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.

Usage

The Documentation page provides a complete reference on how rbxmk is used.

Installation

rbxmk can also 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.6.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

Extra version information can be included by passing the -X flag to the linker:

go install -ldflags="-X $VARIABLE=$VALUE"
  • The main.Prerelease variable appends a prerelease version.
  • The main.Build variable appends build metadata.

For example:

go install -ldflags="-X main.Prerelease=rc.1 -X main.Build=$(echo $(git log -1 --format=%cI | date --utc +%Y%m%d)-$(git rev-parse --short HEAD))"
rbxmk version
# e.g. 0.5.1-rc.1+20210312-2070bf8