Skip to content

Commit 2c18873

Browse files
committed
Document JSON syncing and fix README typos
1 parent ebffba9 commit 2c18873

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CHANGES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Rojo Change Log
22

33
## Current Master (0.4.0)
4-
* Began protocol version 1, which shifts more responsibility onto the server
4+
* Protocol version 1, which shifts more responsibility onto the server
55
* This is a **major breaking** change!
66
* The server now has a content of 'filter plugins', which transform data at various stages in the pipeline
77
* 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.

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,11 @@ Rojo has a number of desirable features *right now*:
2626

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

30-
Soon, Rojo will be able to:
31+
Later this year, Rojo will be able to:
3132

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

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

106-
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.
107+
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.
107108

108109
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.
109110

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

122124
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.

0 commit comments

Comments
 (0)