Rbxmx-to-ts NPM

rbxmx to TS

A powerful CLI to create .d.ts files for .rbxmx files

Getting Started

Prerequisites

You must have node installed if you are installing through npm. It must be at least version 16.12.0.

Installation

Node

Use npm to install rbxmx-to-ts.

npm install rbxmx-to-ts --global

Binaries

Binaries are avaliable under the release. To download them, go to the release page, and download the version for your operating system.

While support is provided for the binaries, it is suggested to use npm if you are not familiar with using the other installion options.

Usage

rbxmx-to-ts has been designed to have a very simple usage. If rbxmxc is just run, it'll parase all the .rbxmx files from the root folder and all its subdirectories. The full list of options are below:

Usage: rbxmxc [options]

Options:
  -v, --version         output the version number
  -w, --watch           watch for file changes
  -f, --file <file...>  path(s) to an rbxmx file - if this is not selected it will select all rbxmx files from the root folder and all its subdirectories
  -e, --export           export the types instead of declaring globally
  -h, --help            display help for command

Contributing

We love contributions! Pull requests are warmly welcomed and highly appriciated. For major changes, please open an issue first or discuss on the discord to let us know what you would like to change.