Skip to content

Commit

Permalink
Document JSON syncing and fix README typos
Browse files Browse the repository at this point in the history
  • Loading branch information
LPGhatguy committed Feb 22, 2018
1 parent 44c46ef commit 135c287
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Rojo Change Log

## Current Master (0.4.0)
* Began protocol version 1, which shifts more responsibility onto the server
* Protocol version 1, which shifts more responsibility onto the server
* This is a **major breaking** change!
* The server now has a content of 'filter plugins', which transform data at various stages in the pipeline
* The server now exposes Roblox instance objects instead of file contents, which lines up with how `rojo pack` will work, and paves the way for more robust syncing.
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ Rojo has a number of desirable features *right now*:

* Work on scripts from the filesystem, in your favorite editor
* Version your place, library, or plugin using Git or another VCS
* Sync JSON-format models from the filesystem into your game

Soon, Rojo will be able to:
Later this year, Rojo will be able to:

* Sync Roblox objects (including models) bi-directionally between the filesystem and Roblox Studio
* Sync rbxmx-format Roblox models bi-directionally between the filesystem and Roblox Studio
* Create installation scripts for libraries to be used in standalone places
* Similar to [rbxpacker](https://github.com/LPGhatguy/rbxpacker), another one of my projects
* Add strongly-versioned dependencies to your project
Expand Down Expand Up @@ -103,7 +104,7 @@ For example, if you want to map your `src` directory to an object named `My Cool

The `path` parameter is relative to the project file.

The `target` starts at `game` and crawls down the tree. If any objects don't exist along the way, they'll be created as `Folder` instances.
The `target` parameter is a path to a Roblox object to link the partition to. It starts at `game` and crawls down the tree. If any objects don't exist along the way, they'll be created as `Folder` instances.

Run `rojo serve` in the directory containing this project, then press the "Sync In" or "Toggle Polling" buttons in the Roblox Studio plugin to move code into your game.

Expand All @@ -117,6 +118,7 @@ Creation of Roblox instances follows a simple set of rules. The first rule that
| `*.server.lua` | `Script` | `Source` will contain the file's contents |
| `*.client.lua` | `LocalScript` | `Source` will contain the file's contents |
| `*.lua` | `ModuleScript` | `Source` will contain the file's contents |
| `*.model.json` | *Varies* | See [this file](test-project/src/hello.model.json) for an example model |
| `*` | `StringValue` | `Value` will contain the file's contents |

Any folders on the filesystem will turn into `Folder` objects unless they contain a file named `init.lua`, `init.server.lua`, or `init.client.lua`. Following the convention of Lua, those objects will instead be whatever the `init` file would turn into.
Expand Down

0 comments on commit 135c287

Please sign in to comment.