0.0.1 • Published 6 years ago

rosync v0.0.1

Weekly downloads
1
License
Mozilla Public Li...
Repository
-
Last release
6 years ago

RoSync in a command line tool for manually syncing an entire codebase between Roblox Studio and the Filesystem.

Features

RoSync is best characterized as a manual Copy-And-Replace Snapshot Tool, where you can:

  • Take a snapshot of a Roblox Place's entire codebase and save to the file system.
  • Copy a snapshot to a Roblox Place, replacing its entire codebase.

This allows you to version your code within Git or another VCS.

Prerequisites

  1. NodeJS

Installation

  1. Install rosync from NPM: npm install rosync -g
  2. Install RoSync Roblox Studio Plugin
  3. Set game.HttpService.HttpEnabled = true within your Roblox Place

Usage

To sync from Roblox Studio to File System: rosync SOURCE_DIRECTORY -f where SOURCE_DIRECTORY is where you want to store the Snapshot.

To sync from File System to Roblox Studio: rosync SOURCE_DIRECTORY -r where SOURCE_DIRECTORY is the folder containing the Snapshot's "Src" folder.

If you have multiple Roblox Studio instances open, RoSync will ask you to choose one.

A Snapshot saved to disk will be formatted as follows:

SOURCE_DIRECTORY
  ReplicatedStorage
    MyModules
      MyDataModule.lua

  StarterPlayer
    StarterCharacterScripts
      MyChar.local.lua
      MyChar.local.lua.children
        DescendantOfMyChar.local.lua

  ServerScriptService
    MyServerScript.server.lua

Inspiration

This tool follows many of the conventions set forth by Rojo

If you're looking for automatic syncing that will merge your changes, consider:

License

RoSync is available under the terms of the Mozilla Public License, Version 2.0. See LICENSE for details.