Coder Social home page Coder Social logo

rbx-export's Introduction

Roblox API Discord

About

rbx-export is a small and helpful tool written in Javascript, and intended for use in Nodejs. It allows you to easily convert a Roblox model to a file/folder structure, which is ideal to upload to Github or other code sharing services.

it's intended to make sharing code easier. If people want it, I may also add the ability to convert output files back.

It's a one file package, and uses xml2js to read in the files.

Prerequisites

First, install node.js if you haven't already.

To install the package, run the following command to get it from NPM:

NPM

# Run this to install rbx-export locally to your repository. 
$ npm install rbx-export --save

# Run this instead to install rbx-export globally so you can use it anywhere.
$ npm install rbx-export -g

Using it

Exporting your model

In order to use this, you must first export the model you'd like to convert.

Getting your .rbxmx file

If you've already got your model file, skip this step.

  1. Open Roblox studio
  2. Navigate to the model you want to export
  3. Right click on it, and click "Save to file"
  4. When the dialogue pops up, select an appropriate save location and Change "Save as" to Roblox XML Model Files (*.rbxmx)

If you don't do Step 4, it will not work!

Using this module

This module exports a single function, which takes two parameters: rbx-export(location, output)

  • location: String - Path to the file you want to convert
  • output: String - What the output should be called. Defaults to "Output"
Example usage
const exporter = require("rbx-export");
exporter("inputModel.rbmx");

What this module does

It takes your file, and searches through the items, then turns them into files.

How scripts are saved:

  • Script - scriptName.server.lua
  • ModuleScript - scriptName.lua
  • LocalScript - scriptName.client.lua

However, if it is something else, such as a part, it will be saved as Item name.Class name, and the content will be a dump of it's properties. If an item has children, they will be saved within a folder under the same name, minus an extension.

This format is an adaptable standard. Expect it to change extensively.

Support

Got questions? Feel free to open an issue, or email me: [email protected]. Alternatively, you can find me in the Roblox API server.


This module won't be updated - there are many more useful (though more heavy-duty) converters available that can both ways..

rbx-export's People

Contributors

dependabot[bot] avatar neztore avatar star1954 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

wjoe21 star1954

rbx-export's Issues

Data loss: Script's lose their associated data

Scripts that rely on being disabled etc. will not function. as these properties are lost, I presume this could be remedied by adding a separate properties file like all other instances or a special comment at the top of said scripts.
I am more in favour of the first solution.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.