Release 0.5.0-alpha.12

* Support for .meta.json files other than init

* Localize .meta.json application

.cargo/config

@@ -0,0 +1,2 @@
+[target.x86_64-pc-windows-msvc]
+rustflags = ["-Ctarget-feature=+crt-static"]

.editorconfig

@@ -3,8 +3,16 @@ root = true
 [*]
 end_of_line = lf
 charset = utf-8
+insert_final_newline = false
+trim_trailing_whitespace = true
 
-[*.json]
+[*.{json,js,css}]
 indent_style = space
 indent_size = 2
-trim_trailing_whitespace = true
+
+[*.{md,rs}]
+indent_style = space
+indent_size = 4
+
+[*.lua]
+indent_style = tab

.gitignore

@@ -1 +1,9 @@
 /site
+/target
+/scratch-project
+**/*.rs.bk
+/server/failed-snapshots/
+/*.rbxm
+/*.rbxmx
+/*.rbxl
+/*.rbxlx

.gitmodules

@@ -1,15 +1,18 @@
 [submodule "plugin/modules/roact"]
 	path = plugin/modules/roact
 	url = https://github.com/Roblox/roact.git
-[submodule "plugin/modules/rodux"]
-	path = plugin/modules/rodux
-	url = https://github.com/Roblox/rodux.git
-[submodule "plugin/modules/roact-rodux"]
-	path = plugin/modules/roact-rodux
-	url = https://github.com/Roblox/roact-rodux.git
 [submodule "plugin/modules/testez"]
 	path = plugin/modules/testez
 	url = https://github.com/Roblox/testez.git
 [submodule "plugin/modules/lemur"]
 	path = plugin/modules/lemur
 	url = https://github.com/LPGhatguy/lemur.git
+[submodule "plugin/modules/promise"]
+	path = plugin/modules/promise
+	url = https://github.com/LPGhatguy/roblox-lua-promise.git
+[submodule "plugin/modules/t"]
+	path = plugin/modules/t
+	url = https://github.com/osyrisrblx/t.git
+[submodule "plugin/modules/rbx-dom"]
+	path = plugin/modules/rbx-dom
+	url = http://github.com/LPGhatguy/rbx-dom

.travis.yml

@@ -1,39 +1,54 @@
 matrix:
   include:
-    - language: python
-      env:
-        - LUA="lua=5.1"
+    # Lua tests are currently disabled because of holes in Lemur that are pretty
+    # tedious to fix. It should be fixed by either adding missing features to
+    # Lemur or by migrating to a CI system based on real Roblox instead.
 
-      before_install:
-        - pip install hererocks
-        - hererocks lua_install -r^ --$LUA
-        - export PATH=$PATH:$PWD/lua_install/bin
+    # - language: python
+    #   env:
+    #     - LUA="lua=5.1"
 
-      install:
-        - luarocks install luafilesystem
-        - luarocks install busted
-        - luarocks install luacov
-        - luarocks install luacov-coveralls
-        - luarocks install luacheck
+    #   before_install:
+    #     - pip install hererocks
+    #     - hererocks lua_install -r^ --$LUA
+    #     - export PATH=$PATH:$PWD/lua_install/bin
+
+    #   install:
+    #     - luarocks install luafilesystem
+    #     - luarocks install busted
+    #     - luarocks install luacov
+    #     - luarocks install luacov-coveralls
+    #     - luarocks install luacheck
+
+    #   script:
+    #     - cd plugin
+    #     - luacheck src
+    #     - lua -lluacov spec.lua
+
+    #   after_success:
+    #     - cd plugin
+    #     - luacov-coveralls -e $TRAVIS_BUILD_DIR/lua_install
+
+    - language: rust
+      rust: 1.32.0
+      cache: cargo
 
       script:
-        - cd plugin
-        - luacheck src
-        - lua -lluacov spec.lua
-
-      after_success:
-        - cd plugin
-        - luacov-coveralls -e $TRAVIS_BUILD_DIR/lua_install
+        - cargo test --verbose
+        - cargo test --verbose --all-features
 
     - language: rust
       rust: stable
+      cache: cargo
 
       script:
-        - cd server
         - cargo test --verbose
+        - cargo test --verbose --all-features
+
     - language: rust
       rust: beta
+      cache: cargo
 
       script:
-        - cd server
         - cargo test --verbose
+        - cargo test --verbose --all-features

CHANGELOG.md

@@ -0,0 +1,235 @@
+# Rojo Changelog
+
+## [0.5.0 Alpha 12](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.12) (July 2, 2019)
+* Added `.meta.json` files
+    * `init.meta.json` files replace `init.model.json` files from Rojo 0.4.x ([#183](https://github.com/rojo-rbx/rojo/pull/183))
+    * Other `.meta.json` files allow attaching extra data to other files ([#189](https://github.com/rojo-rbx/rojo/pull/189))
+* Added support for infinite and NaN values in types like `Vector2` when building models and places.
+    * These types aren't supported for live-syncing yet due to limitations around JSON encoding.
+* Added support for using `SharedString` values when building XML models and places.
+* Added support for live-syncing `CollectionService` tags.
+* Added a warning when building binary place files, since they're still experimental and have bugs.
+* Added a warning when trying to use Rojo 0.5.x with a Rojo 0.4.x-only project.
+* Added a warning when a Rojo project contains keys that start with `$`, which are reserved names. ([#191](https://github.com/rojo-rbx/rojo/issues/191))
+* Rojo now throws an error if unknown keys are found most files.
+* Added an icon to the plugin's toolbar button
+* Changed the plugin to use a docking widget for all UI.
+* Changed the plugin to ignore unknown properties when live-syncing.
+    * Rojo's approach to this problem might change later, like with a strict model mode ([#190](https://github.com/rojo-rbx/rojo/issues/190)) or another approach.
+* Upgraded to reflection database from client release 388.
+* Updated Rojo's branding to shift the color palette to make it work better on dark backgrounds
+
+## [0.5.0 Alpha 11](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.11) (May 29, 2019)
+* Added support for implicit property values in JSON model files ([#154](https://github.com/rojo-rbx/rojo/pull/154))
+* `Content` propertyes can now be specified in projects and model files as regular string literals.
+* Added support for `BrickColor` properties.
+* Added support for properties added in client release 384, like `Lighting.Technology` being set to `"ShadowMap"`.
+* Improved performance when working with XML models and places
+* Fixed serializing empty `Content` properties as XML
+* Fixed serializing infinite and NaN floating point properties in XML
+* Improved compatibility with XML models
+* Plugin should now be able to live-sync more properties, and ignore ones it can't, like `Lighting.Technology`.
+
+## 0.5.0 Alpha 10
+* This release was a dud due to [issue #176](https://github.com/rojo-rbx/rojo/issues/176) and was rolled back.
+
+## [0.5.0 Alpha 9](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.9) (April 4, 2019)
+* Changed `rojo build` to use buffered I/O, which can make it up to 2x faster in some cases.
+    * Building [*Road Not Taken*](https://github.com/rojo-rbx/roads) to an `rbxlx` file dropped from 150ms to 70ms on my machine
+* Fixed `LocalizationTable` instances being made from `csv` files incorrectly interpreting empty rows and columns. ([#149](https://github.com/rojo-rbx/rojo/pull/149))
+* Fixed CSV files with entries that parse as numbers causing Rojo to panic. ([#152](https://github.com/rojo-rbx/rojo/pull/152))
+* Improved error messages when malformed CSV files are found in a Rojo project.
+
+## [0.5.0 Alpha 8](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.8) (March 29, 2019)
+* Added support for a bunch of new types when dealing with XML model/place files:
+    * `ColorSequence`
+    * `Float64`
+    * `Int64`
+    * `NumberRange`
+    * `NumberSequence`
+    * `PhysicalProperties`
+    * `Ray`
+    * `Rect`
+    * `Ref`
+* Improved server instance ordering behavior when files are added during a live session ([#135](https://github.com/rojo-rbx/rojo/pull/135))
+* Fixed error being thrown when trying to unload the Rojo plugin.
+* Added partial fix for [issue #141](https://github.com/rojo-rbx/rojo/issues/141) for `Lighting.Technology`, which should restore live sync functionality for the default project file.
+
+## [0.5.0 Alpha 6](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.6) (March 19, 2019)
+* Fixed `rojo init` giving unexpected results by upgrading to `rbx_dom_weak` 1.1.0
+* Fixed live server not responding when the Rojo plugin is connected ([#133](https://github.com/rojo-rbx/rojo/issues/133))
+* Updated default place file:
+    * Improved default properties to be closer to Studio's built-in 'Baseplate' template
+    * Added a baseplate to the project file (Thanks, [@AmaranthineCodices](https://github.com/AmaranthineCodices/)!)
+* Added more type support to Rojo plugin
+* Fixed some cases where the Rojo plugin would leave around objects that it knows should be deleted
+* Updated plugin to correctly listen to `Plugin.Unloading` when installing or uninstalling new plugins
+
+## [0.5.0 Alpha 5](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.5) (March 1, 2019)
+* Upgraded core dependencies, which improves compatibility for lots of instance types
+    * Upgraded from `rbx_tree` 0.2.0 to `rbx_dom_weak` 1.0.0
+    * Upgraded from `rbx_xml` 0.2.0 to `rbx_xml` 0.4.0
+    * Upgraded from `rbx_binary` 0.2.0 to `rbx_binary` 0.4.0
+* Added support for non-primitive types in the Rojo plugin.
+    * Types like `Color3` and `CFrame` can now be updated live!
+* Fixed plugin assets flashing in on first load ([#121](https://github.com/rojo-rbx/rojo/issues/121))
+* Changed Rojo's HTTP server from Rouille to Hyper, which reduced the release size by around a megabyte.
+* Added property type inference to projects, which makes specifying services a lot easier ([#130](https://github.com/rojo-rbx/rojo/pull/130))
+* Made error messages from invalid and missing files more user-friendly
+
+## [0.5.0 Alpha 4](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.4) (February 8, 2019)
+* Added support for nested partitions ([#102](https://github.com/rojo-rbx/rojo/issues/102))
+* Added support for 'transmuting' partitions ([#112](https://github.com/rojo-rbx/rojo/issues/112))
+* Added support for aliasing filesystem paths ([#105](https://github.com/rojo-rbx/rojo/issues/105))
+* Changed Windows builds to statically link the CRT ([#89](https://github.com/rojo-rbx/rojo/issues/89))
+
+## [0.5.0 Alpha 3](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.3) (February 1, 2019)
+* Changed default project file name from `roblox-project.json` to `default.project.json` ([#120](https://github.com/rojo-rbx/rojo/pull/120))
+    * The old file name will still be supported until 0.5.0 is fully released.
+* Added warning when loading project files that don't end in `.project.json`
+    * This new extension enables Rojo to distinguish project files from random JSON files, which is necessary to support nested projects.
+* Added new (empty) diagnostic page served from the server
+* Added better error messages for when a file is missing that's referenced by a Rojo project
+* Added support for visualization endpoints returning GraphViz source when Dot is not available
+* Fixed an in-memory filesystem regression introduced recently ([#119](https://github.com/rojo-rbx/rojo/pull/119))
+
+## [0.5.0 Alpha 2](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.2) (January 28, 2019)
+* Added support for `.model.json` files, compatible with 0.4.x
+* Fixed in-memory filesystem not handling out-of-order filesystem change events
+* Fixed long-polling error caused by a promise mixup ([#110](https://github.com/rojo-rbx/rojo/issues/110))
+
+## [0.5.0 Alpha 1](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.1) (January 25, 2019)
+* Changed plugin UI to be way prettier
+    * Thanks to [Reselim](https://github.com/Reselim) for the design!
+* Changed plugin error messages to be a little more useful
+* Removed unused 'Config' button in plugin UI
+* Fixed bug where bad server responses could cause the plugin to be in a bad state
+* Upgraded to rbx\_tree, rbx\_xml, and rbx\_binary 0.2.0, which dramatically expands the kinds of properties that Rojo can handle, especially in XML.
+
+## [0.5.0 Alpha 0](https://github.com/rojo-rbx/rojo/releases/tag/v0.5.0-alpha.0) (January 14, 2019)
+* "Epiphany" rewrite, in progress since the beginning of time
+* New live sync protocol
+    * Uses HTTP long polling to reduce request count and improve responsiveness
+* New project format
+    * Hierarchical, preventing overlapping partitions
+* Added `rojo build` command
+    * Generates `rbxm`, `rbxmx`, `rbxl`, or `rbxlx` files out of your project
+    * Usage: `rojo build <PROJECT> --output <OUTPUT>.rbxm`
+* Added `rojo upload` command
+    * Generates and uploads a place or model to roblox.com out of your project
+    * Usage: `rojo upload <PROJECT> --cookie "<ROBLOSECURITY>" --asset_id <PLACE_ID>`
+* New plugin
+    * Only one button now, "Connect"
+    * New UI to pick server address and port
+    * Better error reporting
+* Added support for `.csv` files turning into `LocalizationTable` instances
+* Added support for `.txt` files turning into `StringValue` instances
+* Added debug visualization code to diagnose problems
+    * `/visualize/rbx` and `/visualize/imfs` show instance and file state respectively; they require GraphViz to be installed on your machine.
+* Added optional place ID restrictions to project files
+    * This helps prevent syncing in content to the wrong place
+    * Multiple places can be specified, like when building a multi-place game
+* Added support for specifying properties on services in project files
+
+## [0.4.13](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.13) (November 12, 2018)
+* When `rojo.json` points to a file or directory that does not exist, Rojo now issues a warning instead of throwing an error and exiting
+
+## [0.4.12](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.12) (June 21, 2018)
+* Fixed obscure assertion failure when renaming or deleting files ([#78](https://github.com/rojo-rbx/rojo/issues/78))
+* Added a `PluginAction` for the sync in command, which should help with some automation scripts ([#80](https://github.com/rojo-rbx/rojo/pull/80))
+
+## [0.4.11](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.11) (June 10, 2018)
+* Defensively insert existing instances into RouteMap; should fix most duplication cases when syncing into existing trees.
+* Fixed incorrect synchronization from `Plugin:_pull` that would cause polling to create issues
+* Fixed incorrect file routes being assigned to `init.lua` and `init.model.json` files
+* Untangled route handling-internals slightly
+
+## [0.4.10](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.10) (June 2, 2018)
+* Added support for `init.model.json` files, which enable versioning `Tool` instances (among other things) with Rojo. ([#66](https://github.com/rojo-rbx/rojo/issues/66))
+* Fixed obscure error when syncing into an invalid service.
+* Fixed multiple sync processes occurring when a server ID mismatch is detected.
+
+## [0.4.9](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.9) (May 26, 2018)
+* Fixed warning when renaming or removing files that would sometimes corrupt the instance cache ([#72](https://github.com/rojo-rbx/rojo/pull/72))
+* JSON models are no longer as strict -- `Children` and `Properties` are now optional.
+
+## [0.4.8](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.8) (May 26, 2018)
+* Hotfix to prevent errors from being thrown when objects managed by Rojo are deleted
+
+## [0.4.7](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.7) (May 25, 2018)
+* Added icons to the Rojo plugin, made by [@Vorlias](https://github.com/Vorlias)! ([#70](https://github.com/rojo-rbx/rojo/pull/70))
+* Server will now issue a warning if no partitions are specified in `rojo serve` ([#40](https://github.com/rojo-rbx/rojo/issues/40))
+
+## [0.4.6](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.6) (May 21, 2018)
+* Rojo handles being restarted by Roblox Studio more gracefully ([#67](https://github.com/rojo-rbx/rojo/issues/67))
+* Folders should no longer get collapsed when syncing occurs.
+* **Significant** robustness improvements with regards to caching.
+    * **This should catch all existing script duplication bugs.**
+    * If there are any bugs with script duplication or caching in the future, restarting the Rojo server process will fix them for that session.
+* Fixed message in plugin not being prefixed with `Rojo: `.
+
+## [0.4.5](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.5) (May 1, 2018)
+* Rojo messages are now prefixed with `Rojo: ` to make them stand out in the output more.
+* Fixed server to notice file changes *much* more quickly. (200ms vs 1000ms)
+* Server now lists name of project when starting up.
+* Rojo now throws an error if no project file is found. ([#63](https://github.com/rojo-rbx/rojo/issues/63))
+* Fixed multiple sync operations occuring at the same time. ([#61](https://github.com/rojo-rbx/rojo/issues/61))
+* Partitions targeting files directly now work as expected. ([#57](https://github.com/rojo-rbx/rojo/issues/57))
+
+## [0.4.4](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.4) (April 7, 2018)
+* Fix small regression introduced in 0.4.3
+
+## [0.4.3](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.3) (April 7, 2018)
+* Plugin now automatically selects `HttpService` if it determines that HTTP isn't enabled ([#58](https://github.com/rojo-rbx/rojo/pull/58))
+* Plugin now has much more robust handling and will wipe all state when the server changes.
+    * This should fix issues that would otherwise be solved by restarting Roblox Studio.
+
+## [0.4.2](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.2) (April 4, 2018)
+* Fixed final case of duplicated instance insertion, caused by reconciled instances not being inserted into `RouteMap`.
+    * The reconciler is still not a perfect solution, especially if script instances get moved around without being destroyed. I don't think this can be fixed before a big refactor.
+
+## [0.4.1](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.1) (April 1, 2018)
+* Merged plugin repository into main Rojo repository for easier tracking.
+* Improved `RouteMap` object tracking; this should fix some cases of duplicated instances being synced into the tree.
+
+## [0.4.0](https://github.com/rojo-rbx/rojo/releases/tag/v0.4.0) (March 27, 2018)
+* 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.
+* Added `*.model.json` files, which let you embed small Roblox objects into your Rojo tree.
+* Improved error messages in some cases ([#46](https://github.com/rojo-rbx/rojo/issues/46))
+
+## [0.3.2](https://github.com/rojo-rbx/rojo/releases/tag/v0.3.2) (December 20, 2017)
+* Fixed `rojo serve` failing to correctly construct an absolute root path when passed as an argument
+* Fixed intense CPU usage when running `rojo serve`
+
+## [0.3.1](https://github.com/rojo-rbx/rojo/releases/tag/v0.3.1) (December 14, 2017)
+* Improved error reporting when invalid JSON is found in a `rojo.json` project
+    * These messages are passed on from Serde
+
+## [0.3.0](https://github.com/rojo-rbx/rojo/releases/tag/v0.3.0) (December 12, 2017)
+* Factored out the plugin into a separate repository
+* Fixed server when using a file as a partition
+    * Previously, trailing slashes were put on the end of a partition even if the read request was an empty string. This broke file reading on Windows when a partition pointed to a file instead of a directory!
+* Started running automatic tests on Travis CI (#9)
+
+## [0.2.3](https://github.com/rojo-rbx/rojo/releases/tag/v0.2.3) (December 4, 2017)
+* Plugin only release
+* Tightened `init` file rules to only match script files
+    * Previously, Rojo would sometimes pick up the wrong file when syncing
+
+## [0.2.2](https://github.com/rojo-rbx/rojo/releases/tag/v0.2.2) (December 1, 2017)
+* Plugin only release
+* Fixed broken reconciliation behavior with `init` files
+
+## [0.2.1](https://github.com/rojo-rbx/rojo/releases/tag/v0.2.1) (December 1, 2017)
+* Plugin only release
+* Changes default port to 8000
+
+## [0.2.0](https://github.com/rojo-rbx/rojo/releases/tag/v0.2.0) (December 1, 2017)
+* Support for `init.lua` like rbxfs and rbxpacker
+* More robust syncing with a new reconciler
+
+## [0.1.0](https://github.com/rojo-rbx/rojo/releases/tag/v0.1.0) (November 29, 2017)
+* Initial release, functionally very similar to [rbxfs](https://github.com/rojo-rbx/rbxfs)

CHANGES.md

@@ -1,59 +0,0 @@
-# Rojo Change Log
-
-## Current Master
-*No changes*
-
-## 0.4.3 (April 7, 2018)
-* Plugin now automatically selects `HttpService` if it determines that HTTP isn't enabled ([#58](https://github.com/LPGhatguy/rojo/pull/58))
-* Plugin now has much more robust handling and will wipe all state when the server changes.
-	* This should fix issues that would otherwise be solved by restarting Roblox Studio.
-
-## 0.4.2 (April 4, 2018)
-* Fixed final case of duplicated instance insertion, caused by reconciled instances not being inserted into `RouteMap`.
-	* The reconciler is still not a perfect solution, especially if script instances get moved around without being destroyed. I don't think this can be fixed before a big refactor.
-
-## 0.4.1 (April 1, 2018)
-* Merged plugin repository into main Rojo repository for easier tracking.
-* Improved `RouteMap` object tracking; this should fix some cases of duplicated instances being synced into the tree.
-
-## 0.4.0 (March 27, 2018)
-* 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.
-* Added `*.model.json` files, which let you embed small Roblox objects into your Rojo tree.
-* Improved error messages in some cases ([#46](https://github.com/LPGhatguy/rojo/issues/46))
-
-## 0.3.2 (December 20, 2017)
-* Fixed `rojo serve` failing to correctly construct an absolute root path when passed as an argument
-* Fixed intense CPU usage when running `rojo serve`
-
-## 0.3.1 (December 14, 2017)
-* Improved error reporting when invalid JSON is found in a `rojo.json` project
-	* These messages are passed on from Serde
-
-## 0.3.0 (December 12, 2017)
-* Factored out the plugin into a separate repository
-* Fixed server when using a file as a partition
-	* Previously, trailing slashes were put on the end of a partition even if the read request was an empty string. This broke file reading on Windows when a partition pointed to a file instead of a directory!
-* Started running automatic tests on Travis CI (#9)
-
-## 0.2.3 (December 4, 2017)
-* Plugin only release
-* Tightened `init` file rules to only match script files
-	* Previously, Rojo would sometimes pick up the wrong file when syncing
-
-## 0.2.2 (December 1, 2017)
-* Plugin only release
-* Fixed broken reconciliation behavior with `init` files
-
-## 0.2.1 (December 1, 2017)
-* Plugin only release
-* Changes default port to 8000
-
-## 0.2.0 (December 1, 2017)
-* Support for `init.lua` like rbxfs and rbxpacker
-* More robust syncing with a new reconciler
-
-## 0.1.0 (November 29, 2017)
-* Initial release, functionally very similar to [rbxfs](https://github.com/LPGhatguy/rbxfs)

Cargo.toml

@@ -0,0 +1,7 @@
+[workspace]
+members = [
+	"server",
+]
+
+[profile.dev]
+opt-level = 1

DESIGN.md

@@ -1,49 +0,0 @@
-# Rojo Design - Protocol Version 1
-This is a super rough draft that I'm trying to use to lay out some of my thoughts.
-
-## API
-
-### POST `/read`
-Accepts a `Vec<Route>` of items to read.
-
-Returns `Vec<Option<RbxInstance>>`, in the same order as the request.
-
-### POST `/write`
-Accepts a `Vec<{ Route, RbxInstance }>` of items to write.
-
-I imagine that the `Name` attribute of the top-level `RbxInstance` would be ignored in favor of the route name?
-
-## CLI
-The `rojo serve` command uses three major components:
-* A Virtual Filesystem (VFS), which exposes the filesystem as `VfsItem` objects
-* A VFS watcher, which tracks changes to the filesystem and logs them
-* An HTTP API, which exposes an interface to the Roblox Studio plugin
-
-### Transform Plugins
-Transform plugins (or filter plugins?) can interject in three places:
-* Transform a `VfsItem` that's being read into an `RbxInstance` in the VFS
-* Transform an `RbxInstance` that's being written into a `VfsItem` in the VFS
-* Transform a file change into paths that need to be updated in the VFS watcher
-
-The plan is to have several built-in plugins that can be rearranged/configured in project settings:
-
-* Base plugin
-	* Transforms all unhandled files to/from StringValue objects
-* Script plugin
-	* Transforms `*.lua` files to their appropriate file types
-* JSON/rbxmx/rbxlx model plugin
-* External binary plugin
-	* User passes a binary name (like `moonc`) that modifies file contents
-
-## Roblox Studio Plugin
-With the protocol version 1 change, the Roblox Studio plugin got a lot simpler. Notably, the plugin doesn't need to be aware of anything about the filesystem's semantics, which is super handy.
-
-## Bi-directional syncing
-Quenty laid out a good way to handle bi-directional syncing.
-
-When receiving a change from the plugin:
-1. Hash the new contents of the file, store it in a map from routes to hashes
-2. Write the new file contents to the filesystem
-3. Later down the line, receive a change event from the filesystem watcher
-4. When receiving a change, if the item is in the hash map, read it and hash those contents
-5. If the hash matches the last noted hash, discard the change, else continue as normal

LICENSE.md

@@ -1,9 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Lucien Greathouse
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

README.md

@@ -1,206 +1,56 @@
 <div align="center">
-  <img src="assets/rojo-logo.png" alt="Rojo" height="217" />
+    <a href="https://rojo.space">
+        <img src="assets/rojo-logo.png" alt="Rojo" height="217" />
+    </a>
 </div>
 
 <div>&nbsp;</div>
 
 <div align="center">
-  <a href="https://travis-ci.org/LPGhatguy/rojo">
-    <img src="https://api.travis-ci.org/LPGhatguy/rojo.svg?branch=master" alt="Travis-CI Build Status" />
-  </a>
-  <img src="https://img.shields.io/badge/latest_version-0.4.3-brightgreen.svg" alt="Current server version" />
+    <a href="https://travis-ci.org/rojo-rbx/rojo">
+        <img src="https://api.travis-ci.org/rojo-rbx/rojo.svg?branch=master" alt="Travis-CI Build Status" />
+    </a>
+    <a href="https://crates.io/crates/rojo">
+        <img src="https://img.shields.io/crates/v/rojo.svg?label=version" alt="Latest server version" />
+    </a>
+    <a href="https://rojo.space/docs/0.4.x">
+        <img src="https://img.shields.io/badge/docs-0.4.x-brightgreen.svg" alt="Rojo 0.4.x Documentation" />
+    </a>
+    <a href="https://rojo.space/docs/0.5.x">
+        <img src="https://img.shields.io/badge/docs-0.5.x-brightgreen.svg" alt="Rojo 0.5.x Documentation" />
+    </a>
 </div>
 
 <hr />
 
-**Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
+**Rojo** is a tool designed to enable Roblox developers to use professional-grade software engineering tools.
 
-It's designed for power users who want to use the **best tools available** for building games, libraries, and plugins.
+With Rojo, it's possible to use industry-leading tools like **Visual Studio Code** and **Git**.
+
+Rojo is designed for power users who want to use the best tools available for building games, libraries, and plugins.
 
 ## Features
-Rojo lets you:
+Rojo enables:
 
-* 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
+* Working on scripts and models from the filesystem, in your favorite editor
+* Versioning your game, library, or plugin using Git or another VCS
+* Streaming `rbxmx` and `rbxm` models into your game in real time
+* Packaging and deploying your project to Roblox.com from the command line
 
-Later this year, Rojo will be able to:
+Soon, Rojo will be able to:
 
-* Sync `rbxmx` models between the filesystem and Roblox Studio
-* Package projects into `rbxmx` files from the command line
+* Automatically convert your existing game to work with Rojo
+* Sync instances from Roblox Studio to the filesystem
+* Automatically manage your assets on Roblox.com, like images and sounds
+* Import custom instances like MoonScript code
 
-## Installation
-Rojo has two components:
-
-* The server, a binary written in Rust
-* The plugin, a Roblox Studio plugin written in Lua
-
-It's important that the plugin and server are compatible. The plugin will show errors in the Roblox Studio Output window if there is a version mismatch.
-
-To install the server, either:
-
-* If you have Rust installed, use `cargo install rojo`
-* Or, download a pre-built Windows binary from [the GitHub releases page](https://github.com/LPGhatguy/rojo/releases)
-
-To install the plugin, either:
-
-* Install the plugin from the [Roblox plugin page](https://www.roblox.com/library/1211549683/Rojo).
-  * This gives you less control over what version you install -- you will always have the latest version.
-* Or, download the latest release from [the GitHub releases section](https://github.com/LPGhatguy/rojo/releases) and install it into your Roblox plugins folder
-  * You can open this folder by clicking the "Plugins Folder" button from the Plugins toolbar in Roblox Studio
-
-## Server Usage
-For more help, use `rojo help`.
-
-### New Project
-Create a new folder, then use `rojo init` inside that folder to initialize an empty project:
-
-```sh
-mkdir my-new-project
-cd my-new-project
-
-rojo init
-```
-
-Rojo will create an empty project file named `rojo.json` in the directory.
-
-The default project file is:
-
-```json
-{
-  "name": "my-new-project",
-  "servePort": 8000,
-  "partitions": {}
-}
-```
-
-### Start Dev Server
-To start the Rojo dev server, use:
-
-```sh
-rojo serve
-```
-
-The tool will tell you whether it found an existing project. You should then be able to connect and use the project from within Roblox Studio!
-
-### Migrating an Existing Roblox Project
-[Bi-directional script syncing](https://github.com/LPGhatguy/rojo/issues/5) is on the roadmap for Rojo this year, but isn't implemented.
-
-In the mean-time, manually migrating scripts is probably the best route forward.
-
-### Syncing into Roblox
-In order to sync code into Roblox, you'll need to add one or more *partitions* to your configuration. A partition tells Rojo how to map directories on your filesystem to Roblox objects.
-
-Each entry in the `partitions` map has a unique name, a filesystem path, and the full name of the Roblox object to sync into.
-
-For example, if you want to map your `src` directory to an object named `My Cool Game` in `ReplicatedStorage`, you could use this configuration:
-
-```json
-{
-  "name": "rojo",
-  "servePort": 8000,
-  "partitions": {
-    "game": {
-      "path": "src",
-      "target": "ReplicatedStorage.My Cool Game"
-    }
-  }
-}
-```
-
-The `path` parameter is relative to the project file.
-
-The `target` parameter is a path to a Roblox object to link the partition to, starting at `game`. If any objects don't exist along the way, Rojo will try to create them.
-
-**Any objects in a partition may be wiped away by Rojo after syncing! If this is not desired, use multiple, smaller partitions.**
-
-Run `rojo serve` in the directory containing this project, then press the "Sync In" or "Toggle Polling" buttons in the Roblox Studio plugin to sync into your game.
-
-### Sync Details
-The structure of files and diectories on the filesystem are preserved when syncing into game.
-
-Creation of Roblox instances follows a simple set of rules. The first rule that matches the file name is chosen:
-
-| File Name      | Instance Type  | Notes                                     |
-| -------------- | -------------- | ----------------------------------------- |
-| `*.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 the example below                     |
-| `*`            | `StringValue`  | `Value` will contain the file's contents  |
-
-Any directories on the filesystem will turn into `Folder` objects.
-
-Any directory containing one of these files will instead be a `ModuleScript`, `Script`, `LocalScript` containing the directory's contents:
-
-* `init.lua`
-* `init.server.lua`
-* `init.client.lua`
-
-For example, this file tree:
-
-* my-game
-	* init.client.lua
-	* foo.lua
-
-Will turn into these instances in Roblox:
-
-* `my-game` (`LocalScript` with source from `my-game/init.client.lua`)
-	* `foo` (`ModuleScript` with source from `my-game/foo.lua`)
-
-`*.model.json` files are a way to represent simple Roblox instances on the filesystem until `rbxmx` and `rbxlx` support is implemented in Rojo.
-
-This feature is intended for small instances, like `RemoteEvent` or `*Value` objects.
-
-JSON Model files are strict, with every property being required. They look like this:
-
-```json
-{
-  "Name": "hello",
-  "ClassName": "Model",
-  "Children": [
-    {
-      "Name": "Some Part",
-      "ClassName": "Part",
-      "Children": [],
-      "Properties": {}
-    },
-    {
-      "Name": "Some StringValue",
-      "ClassName": "StringValue",
-      "Children": [],
-      "Properties": {
-        "Value": {
-          "Type": "String",
-          "Value": "Hello, world!"
-        }
-      }
-    }
-  ],
-  "Properties": {}
-}
-```
-
-## Inspiration
-There are lots of other tools that sync scripts into Roblox or provide other tools for working with Roblox places.
-
-Here are a few, if you're looking for alternatives or supplements to Rojo:
-
-* [Studio Bridge by Vocksel](https://github.com/vocksel/studio-bridge)
-* [RbxRefresh by Osyris](https://github.com/osyrisrblx/RbxRefresh)
-* [RbxSync by evaera](https://github.com/evaera/RbxSync)
-* [CodeSync](https://github.com/MemoryPenguin/CodeSync) and [rbx-exteditor](https://github.com/MemoryPenguin/rbx-exteditor) by [MemoryPenguin](https://github.com/MemoryPenguin)
-* [rbxmk by Anaminus](https://github.com/anaminus/rbxmk)
-
-I also have a couple tools that Rojo intends to replace:
-
-* [rbxfs](https://github.com/LPGhatguy/rbxfs), which has been deprecated by Rojo
-* [rbxpacker](https://github.com/LPGhatguy/rbxpacker), which is still useful
+## [Documentation](https://rojo.space/docs/latest)
+If you find any mistakes, feel free to make changes in the [docs](https://github.com/rojo-rbx/rojo/tree/master/docs) folder of this repository and submit a pull request!
 
 ## Contributing
 Pull requests are welcome!
 
-All pull requests are run against a test suite on Travis CI. That test suite should always pass!
+Rojo supports Rust 1.32 and newer.
 
 ## License
-Rojo is available under the terms of the MIT license. See [LICENSE.md](LICENSE.md) for details.
+Rojo is available under the terms of the Mozilla Public License, Version 2.0. See [LICENSE.txt](LICENSE.txt) for details.

assets/kenney-ui-gray-sheet.xml

@@ -0,0 +1,41 @@
+<TextureAtlas imagePath="sheet.png">
+	<SubTexture name="grey_arrowDownGrey.png" x="78" y="498" width="15" height="10"/>
+	<SubTexture name="grey_arrowDownWhite.png" x="123" y="496" width="15" height="10"/>
+	<SubTexture name="grey_arrowUpGrey.png" x="108" y="498" width="15" height="10"/>
+	<SubTexture name="grey_arrowUpWhite.png" x="93" y="498" width="15" height="10"/>
+	<SubTexture name="grey_box.png" x="147" y="433" width="38" height="36"/>
+	<SubTexture name="grey_boxCheckmark.png" x="147" y="469" width="38" height="36"/>
+	<SubTexture name="grey_boxCross.png" x="185" y="433" width="38" height="36"/>
+	<SubTexture name="grey_boxTick.png" x="190" y="198" width="36" height="36"/>
+	<SubTexture name="grey_button00.png" x="0" y="143" width="190" height="45"/>
+	<SubTexture name="grey_button01.png" x="0" y="188" width="190" height="49"/>
+	<SubTexture name="grey_button02.png" x="0" y="98" width="190" height="45"/>
+	<SubTexture name="grey_button03.png" x="0" y="331" width="190" height="49"/>
+	<SubTexture name="grey_button04.png" x="0" y="286" width="190" height="45"/>
+	<SubTexture name="grey_button05.png" x="0" y="0" width="195" height="49"/>
+	<SubTexture name="grey_button06.png" x="0" y="49" width="191" height="49"/>
+	<SubTexture name="grey_button07.png" x="195" y="0" width="49" height="49"/>
+	<SubTexture name="grey_button08.png" x="240" y="49" width="49" height="49"/>
+	<SubTexture name="grey_button09.png" x="98" y="433" width="49" height="45"/>
+	<SubTexture name="grey_button10.png" x="191" y="49" width="49" height="49"/>
+	<SubTexture name="grey_button11.png" x="0" y="433" width="49" height="45"/>
+	<SubTexture name="grey_button12.png" x="244" y="0" width="49" height="49"/>
+	<SubTexture name="grey_button13.png" x="49" y="433" width="49" height="45"/>
+	<SubTexture name="grey_button14.png" x="0" y="384" width="190" height="49"/>
+	<SubTexture name="grey_button15.png" x="0" y="237" width="190" height="49"/>
+	<SubTexture name="grey_checkmarkGrey.png" x="99" y="478" width="21" height="20"/>
+	<SubTexture name="grey_checkmarkWhite.png" x="78" y="478" width="21" height="20"/>
+	<SubTexture name="grey_circle.png" x="185" y="469" width="36" height="36"/>
+	<SubTexture name="grey_crossGrey.png" x="120" y="478" width="18" height="18"/>
+	<SubTexture name="grey_crossWhite.png" x="190" y="318" width="18" height="18"/>
+	<SubTexture name="grey_panel.png" x="190" y="98" width="100" height="100"/>
+	<SubTexture name="grey_sliderDown.png" x="190" y="234" width="28" height="42"/>
+	<SubTexture name="grey_sliderEnd.png" x="138" y="478" width="8" height="10"/>
+	<SubTexture name="grey_sliderHorizontal.png" x="0" y="380" width="190" height="4"/>
+	<SubTexture name="grey_sliderLeft.png" x="0" y="478" width="39" height="31"/>
+	<SubTexture name="grey_sliderRight.png" x="39" y="478" width="39" height="31"/>
+	<SubTexture name="grey_sliderUp.png" x="190" y="276" width="28" height="42"/>
+	<SubTexture name="grey_sliderVertical.png" x="208" y="318" width="4" height="100"/>
+	<SubTexture name="grey_tickGrey.png" x="190" y="336" width="17" height="17"/>
+	<SubTexture name="grey_tickWhite.png" x="190" y="353" width="17" height="17"/>
+</TextureAtlas>

bin/test-scratch-project

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# Copies a project from 'test-projects' into a folder that can be messed with
+# without accidentally checking the results into version control.
+
+set -e
+
+if [ ! -d "test-projects/$1" ]
+then
+	echo "Pick a project that exists!"
+	exit 1
+fi
+
+if [ -d "scratch-project/$1" ]
+then
+	rm -rf "scratch-project/$1"
+fi
+
+mkdir -p scratch-project
+cp -r "test-projects/$1" scratch-project
+cargo run -- serve "scratch-project/$1"

docs/extra.css

@@ -0,0 +1,13 @@
+.md-typeset__table {
+  width: 100%;
+}
+
+.feature-image img {
+  border: 1px solid rgba(0, 0, 0, 0.2);
+  box-shadow: 1px 1px 4px rgba(0, 0, 0, 0.2);
+}
+
+.codehilite {
+  border: 1px solid rgba(0, 0, 0, 0.2);
+  box-shadow: 1px 1px 4px rgba(0, 0, 0, 0.2);
+}

docs/guide/existing-game.md

@@ -0,0 +1,11 @@
+**This page is under construction!**
+
+## Summary
+* Tools to port existing games are in progress!
+    * [rbxlx-to-rojo](https://github.com/rojo/rbxlx-to-rojo)
+    * `rojo export` ([issue #208](https://github.com/rojo-rbx/rojo/issues/208))
+* Can port as much or as little of your game as you like
+    * Rojo can manage just a slice of your game!
+* Some Roblox idioms aren't very well supported
+    * Redundant copies of scripts don't work well with files
+    * Having only a couple places with scripts simplifies your project dramatically!

docs/guide/installation.md

@@ -0,0 +1,46 @@
+This is this installation guide for Rojo **0.5.x**.
+
+[TOC]
+
+## Overview
+Rojo has two components:
+
+* The command line interface (CLI)
+* The Roblox Studio plugin
+
+!!! info
+    It's important that your installed version of the plugin and CLI are compatible.
+
+    The plugin will show errors in the Roblox Studio output window if there is a version mismatch.
+
+## Visual Studio Code Extension
+If you use Visual Studio Code, you can install [the Rojo VS Code extension](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo), which will install both halves of Rojo for you. It even has a nifty UI to sync files and start/stop the Rojo server!
+
+## Installing the CLI
+
+### Installing from GitHub
+If you're on Windows, there are pre-built binaries available from Rojo's [GitHub Releases page](https://github.com/LPGhatguy/rojo/releases).
+
+The Rojo CLI must be run from the command line, like Terminal.app on MacOS or `cmd.exe` on Windows. It's recommended that you put the Rojo CLI executable on your `PATH` to make this easier.
+
+### Installing from Cargo
+If you have Rust installed, the easiest way to get Rojo is with Cargo!
+
+To install the latest 0.5.0 alpha, use:
+
+```sh
+cargo install rojo --version 0.5.0-alpha.12
+```
+
+## Installing the Plugin
+
+### Installing from GitHub
+The Rojo Roblox Studio plugin is available from Rojo's [GitHub Releases page](https://github.com/LPGhatguy/rojo/releases).
+
+Download the attached `rbxm` file and put it into your Roblox Studio plugins folder. You can find that folder by pressing **Plugins Folder** from your Plugins toolbar in Roblox Studio:
+
+!['Plugins Folder' button in Roblox Studio](../images/plugins-folder-in-studio.png)
+{: align="center" }
+
+### Installing from Roblox.com
+Visit [Rojo's Roblox.com Plugin page](https://www.roblox.com/library/1997686364/Rojo-0-5-0-alpha-3) in Roblox Studio and press **Install**.

docs/guide/migrating-to-epiphany.md

@@ -0,0 +1,63 @@
+Rojo underwent a large refactor during most of 2018 to enable a bunch of new features and lay groundwork for lots more in 2019. As such, Rojo **0.5.x** projects are not compatible with Rojo **0.4.x** projects.
+
+[TOC]
+
+## Supporting Both 0.4.x and 0.5.x
+Rojo 0.5.x uses a different name for its project format. While 0.4.x used `rojo.json`, 0.5.x uses `default.project.json`, which allows them to coexist.
+
+If you aren't sure about upgrading or want to upgrade gradually, it's possible to keep both files in the same project without causing problems.
+
+## Upgrading Your Project File
+Project files in 0.5.x are more explicit and flexible than they were in 0.4.x. Project files can now describe models and plugins in addition to places.
+
+This new project file format also guards against two of the biggest pitfalls when writing a config file:
+
+* Using a service as a partition target directly, which often wiped away extra instances
+* Defining two partitions that overlapped, which made Rojo act unpredictably
+
+The biggest change is that the `partitions` field has been replaced with a new field, `tree`, that describes the entire hierarchy of your project from the top-down.
+
+A project for 0.4.x that syncs from the `src` directory into `ReplicatedStorage.Source` would look like this:
+
+```json
+{
+    "name": "Rojo 0.4.x Example",
+    "partitions": {
+        "path": "src",
+        "target": "ReplicatedStorage.Source"
+    }
+}
+```
+
+In 0.5.x, the project format is more explicit:
+
+```json
+{
+    "name": "Rojo 0.5.x Example",
+    "tree": {
+        "$className": "DataModel",
+        "ReplicatedStorage": {
+            "$className": "ReplicatedStorage",
+            "Source": {
+                "$path": "src"
+            }
+        }
+    }
+}
+```
+
+For each object in the tree, we define *metadata* and *children*.
+
+Metadata begins with a dollar sign (`$`), like `$className`. This is so that children and metadata can coexist without creating too many nested layers.
+
+All other values are considered children, where the key is the instance's name, and the value is an object, repeating the process.
+
+## Migrating Unknown Files
+If you used Rojo to sync in files as `StringValue` objects, you'll need to make sure those files end with the `txt` extension to preserve this in Rojo 0.5.x.
+
+Unknown files are now ignored in Rojo instead of being converted to `StringValue` objects.
+
+## Migrating `init.model.json` files
+In Rojo 0.4.x, it's possible to create a file named `init.model.json` that lets you describe a model that becomes the container for all of the other files in the folder, just like `init.lua`.
+
+In Rojo 0.5.x, this feature has been replaced with `init.meta.json` files. See [Sync Details](../reference/sync-details) for more information about these new files.

docs/guide/new-game.md

@@ -0,0 +1,90 @@
+[TOC]
+
+## Creating the Rojo Project
+To use Rojo to build a game, you'll need to create a new project file, which tells Rojo how to turn your files into a Roblox place.
+
+First, create a new folder to contain the files for your game and open up a new terminal inside of it, like cmd.exe or Bash.
+
+It's convenient to make the folder from the command line:
+
+```sh
+mkdir my-new-project
+cd my-new-project
+```
+
+Inside the folder, initialize a new Rojo project:
+
+```sh
+rojo init
+```
+
+Rojo will make a small project file in your directory, named `default.project.json`. It matches the "Baseplate" template from Roblox Studio, except that it'll take any files you put in a folder called `src` and put it into `ReplicatedStorage.Source`.
+
+Speaking of files, make sure to create a directory named `src` in this folder, or Rojo will be upset about missing files!
+
+```sh
+mkdir src
+```
+
+Let's also add a Lua file, `hello.lua` to the `src` folder, so that we can make this project our own.
+
+```sh
+echo 'return "Hello, Rojo!"' > src/hello.lua
+```
+
+## Building Your Place
+Now that we have a project, one thing we can do is build a Roblox place file for our project. This is a great way to get started with a project quickly with no fuss.
+
+All we have to do is call `rojo build`:
+
+```sh
+rojo build -o MyNewProject.rbxlx
+```
+
+If you open `MyNewProject.rbxlx` in Roblox Studio now, you should see a `Folder` containing a `ModuleScript` under `ReplicatedStorage`!
+
+!!! info
+    To generate a binary place file instead, use `rbxl`. Note that support for binary model/place files (`rbxm` and `rbxl`) is very limited in Rojo presently.
+
+## Live-Syncing into Studio
+Building a place file is great for starting to work on a game, but for active iteration, you'll want something faster.
+
+In Roblox Studio, make sure the Rojo plugin is installed. If you need it, check out [the installation guide](installation) to learn how to install it.
+
+To expose your project to the plugin, you'll need to start a new **live sync session** from the command line:
+
+```sh
+rojo serve
+```
+
+You should see output like this in your terminal:
+
+```sh
+$ rojo serve
+Rojo server listening on port 34872
+```
+
+Switch into Roblox Studio and press the **Connect** button on the Rojo plugin toolbar. A dialog should appear:
+
+![Rojo plugin connection dialog](../images/connection-dialog.png)
+{: class="feature-image" align="center" }
+
+If the port number doesn't match the output from the command line, change it, and then press **Connect**.
+
+If all went well, you should now be able to change files in the `src` directory and watch them sync into Roblox Studio in real time!
+
+## Uploading Your Place
+Aimed at teams that want serious levels of automation, Rojo can upload places to Roblox.com automatically.
+
+You'll need an existing game on Roblox.com as well as the `.ROBLOSECURITY` cookie of an account that has write access to that game.
+
+!!! warning
+    It's recommended that you set up a Roblox account dedicated to deploying your game instead of your personal account in case your security cookie is compromised.
+
+Generating and publishing your game is as simple as:
+
+```sh
+rojo upload --asset_id [PLACE ID] --cookie "[SECURITY COOKIE]"
+```
+
+An example project is available on GitHub that deploys to Roblox.com from GitHub and Travis-CI automatically: [https://github.com/LPGhatguy/roads](https://github.com/LPGhatguy/roads)

docs/images/sync-example-files.gv

@@ -0,0 +1,17 @@
+digraph "Sync Files" {
+	graph [
+	    ranksep = "0.7",
+	    nodesep = "0.5",
+	];
+	node [
+	    fontname = "monospace",
+	    shape = "record",
+	];
+
+	my_model [label = "MyModel"]
+	init_server [label = "init.server.lua"]
+	foo [label = "foo.lua"]
+
+	my_model -> init_server
+	my_model -> foo
+}

docs/images/sync-example-files.svg

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.38.0 (20140413.2041)
+ -->
+<!-- Title: Sync Files Pages: 1 -->
+<svg width="258pt" height="132pt"
+ viewBox="0.00 0.00 258.00 132.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 128)">
+<title>Sync Files</title>
+<polygon fill="white" stroke="none" points="-4,4 -4,-128 254,-128 254,4 -4,4"/>
+<!-- my_model -->
+<g id="node1" class="node"><title>my_model</title>
+<polygon fill="none" stroke="black" points="104,-87.5 104,-123.5 178,-123.5 178,-87.5 104,-87.5"/>
+<text text-anchor="middle" x="141" y="-101.8" font-family="monospace" font-size="14.00">MyModel</text>
+</g>
+<!-- init_server -->
+<g id="node2" class="node"><title>init_server</title>
+<polygon fill="none" stroke="black" points="0,-0.5 0,-36.5 140,-36.5 140,-0.5 0,-0.5"/>
+<text text-anchor="middle" x="70" y="-14.8" font-family="monospace" font-size="14.00">init.server.lua</text>
+</g>
+<!-- my_model&#45;&gt;init_server -->
+<g id="edge1" class="edge"><title>my_model&#45;&gt;init_server</title>
+<path fill="none" stroke="black" d="M126.632,-87.299C116.335,-74.9713 102.308,-58.1787 90.7907,-44.3902"/>
+<polygon fill="black" stroke="black" points="93.4435,-42.1065 84.3465,-36.6754 88.0711,-46.594 93.4435,-42.1065"/>
+</g>
+<!-- foo -->
+<g id="node3" class="node"><title>foo</title>
+<polygon fill="none" stroke="black" points="176,-0.5 176,-36.5 250,-36.5 250,-0.5 176,-0.5"/>
+<text text-anchor="middle" x="213" y="-14.8" font-family="monospace" font-size="14.00">foo.lua</text>
+</g>
+<!-- my_model&#45;&gt;foo -->
+<g id="edge2" class="edge"><title>my_model&#45;&gt;foo</title>
+<path fill="none" stroke="black" d="M155.57,-87.299C166.013,-74.9713 180.237,-58.1787 191.917,-44.3902"/>
+<polygon fill="black" stroke="black" points="194.659,-46.5681 198.451,-36.6754 189.317,-42.0437 194.659,-46.5681"/>
+</g>
+</g>
+</svg>

docs/images/sync-example-instances.gv

@@ -0,0 +1,15 @@
+digraph "Sync Files" {
+	graph [
+	    ranksep = "0.7",
+	    nodesep = "0.5",
+	];
+	node [
+	    fontname = "monospace",
+	    shape = "record",
+	];
+
+	my_model [label = "MyModel (Script)"]
+	foo [label = "foo (ModuleScript)"]
+
+	my_model -> foo
+}

docs/images/sync-example-instances.svg

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.38.0 (20140413.2041)
+ -->
+<!-- Title: Sync Files Pages: 1 -->
+<svg width="173pt" height="132pt"
+ viewBox="0.00 0.00 173.00 132.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 128)">
+<title>Sync Files</title>
+<polygon fill="white" stroke="none" points="-4,4 -4,-128 169,-128 169,4 -4,4"/>
+<!-- my_model -->
+<g id="node1" class="node"><title>my_model</title>
+<polygon fill="none" stroke="black" points="8,-87.5 8,-123.5 157,-123.5 157,-87.5 8,-87.5"/>
+<text text-anchor="middle" x="82.5" y="-101.8" font-family="monospace" font-size="14.00">MyModel (Script)</text>
+</g>
+<!-- foo -->
+<g id="node2" class="node"><title>foo</title>
+<polygon fill="none" stroke="black" points="0,-0.5 0,-36.5 165,-36.5 165,-0.5 0,-0.5"/>
+<text text-anchor="middle" x="82.5" y="-14.8" font-family="monospace" font-size="14.00">foo (ModuleScript)</text>
+</g>
+<!-- my_model&#45;&gt;foo -->
+<g id="edge1" class="edge"><title>my_model&#45;&gt;foo</title>
+<path fill="none" stroke="black" d="M82.5,-87.299C82.5,-75.6626 82.5,-60.0479 82.5,-46.7368"/>
+<polygon fill="black" stroke="black" points="86.0001,-46.6754 82.5,-36.6754 79.0001,-46.6755 86.0001,-46.6754"/>
+</g>
+</g>
+</svg>

docs/images/sync-example-json-model.gv

@@ -0,0 +1,17 @@
+digraph "Sync Files" {
+	graph [
+	    ranksep = "0.7",
+	    nodesep = "0.5",
+	];
+	node [
+	    fontname = "monospace",
+	    shape = "record",
+	];
+
+	model [label = "My Cool Model (Folder)"]
+	root_part [label = "RootPart (Part)"]
+	send_money [label = "SendMoney (RemoteEvent)"]
+
+	model -> root_part
+	model -> send_money
+}

docs/images/sync-example-json-model.svg

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+ "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<!-- Generated by graphviz version 2.38.0 (20140413.2041)
+ -->
+<!-- Title: Sync Files Pages: 1 -->
+<svg width="390pt" height="132pt"
+ viewBox="0.00 0.00 390.00 132.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 128)">
+<title>Sync Files</title>
+<polygon fill="white" stroke="none" points="-4,4 -4,-128 386,-128 386,4 -4,4"/>
+<!-- model -->
+<g id="node1" class="node"><title>model</title>
+<polygon fill="none" stroke="black" points="75,-87.5 75,-123.5 273,-123.5 273,-87.5 75,-87.5"/>
+<text text-anchor="middle" x="174" y="-101.8" font-family="monospace" font-size="14.00">My Cool Model (Folder)</text>
+</g>
+<!-- root_part -->
+<g id="node2" class="node"><title>root_part</title>
+<polygon fill="none" stroke="black" points="0,-0.5 0,-36.5 140,-36.5 140,-0.5 0,-0.5"/>
+<text text-anchor="middle" x="70" y="-14.8" font-family="monospace" font-size="14.00">RootPart (Part)</text>
+</g>
+<!-- model&#45;&gt;root_part -->
+<g id="edge1" class="edge"><title>model&#45;&gt;root_part</title>
+<path fill="none" stroke="black" d="M152.954,-87.299C137.448,-74.6257 116.168,-57.2335 99.0438,-43.2377"/>
+<polygon fill="black" stroke="black" points="100.972,-40.2938 91.0147,-36.6754 96.5426,-45.7138 100.972,-40.2938"/>
+</g>
+<!-- send_money -->
+<g id="node3" class="node"><title>send_money</title>
+<polygon fill="none" stroke="black" points="176,-0.5 176,-36.5 382,-36.5 382,-0.5 176,-0.5"/>
+<text text-anchor="middle" x="279" y="-14.8" font-family="monospace" font-size="14.00">SendMoney (RemoteEvent)</text>
+</g>
+<!-- model&#45;&gt;send_money -->
+<g id="edge2" class="edge"><title>model&#45;&gt;send_money</title>
+<path fill="none" stroke="black" d="M195.248,-87.299C210.904,-74.6257 232.388,-57.2335 249.677,-43.2377"/>
+<polygon fill="black" stroke="black" points="252.213,-45.6878 257.783,-36.6754 247.809,-40.2471 252.213,-45.6878"/>
+</g>
+</g>
+</svg>

docs/index.md

@@ -1,6 +1,11 @@
-# Home
-This is the documentation home for Rojo.
+This is the documentation home for Rojo 0.5.x.
+
+Available versions of these docs:
+
+* [Latest version (currently 0.5.x)](https://rojo.space/docs/latest)
+* [0.5.x](https://rojo.space/docs/0.5.x)
+* [0.4.x](https://rojo.space/docs/0.4.x)
 
 **Rojo** is a flexible multi-tool designed for creating robust Roblox projects.
 
-This documentation is a work in progress, and is incomplete.
+This documentation is a continual work in progress. If you find any issues, please file an issue on [Rojo's issue tracker](https://github.com/rojo-rbx/rojo/issues)!

docs/internals/overview.md

@@ -0,0 +1,45 @@
+This document aims to give a general overview of how Rojo works. It's intended for people who want to contribute to the project as well as anyone who's just curious how the tool works!
+
+[TOC]
+
+## CLI
+
+### RbxTree
+Rojo uses a library named [`rbx_tree`](https://github.com/LPGhatguy/rbx-tree) as its implementation of the Roblox DOM. It serves as a common format for serialization to all the formats Rojo supports!
+
+Rojo uses two related libraries to deserialize instances from Roblox's file formats, `rbx_xml` and `rbx_binary`.
+
+### In-Memory Filesystem (IMFS)
+Relevant source files:
+
+* [`server/src/imfs.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/imfs.rs)
+* [`server/src/fs_watcher.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/fs_watcher.rs)
+
+Rojo keeps an in-memory copy of all files that it needs reasons about. This enables taking fast, stateless, tear-tree snapshots of files to turn them into instances.
+
+Keeping an in-memory copy of file contents will also enable Rojo to debounce changes that are caused by Rojo itself. This'll happen when two-way sync finally happens.
+
+### Snapshot Reconciler
+Relevant source files:
+
+* [`server/src/snapshot_reconciler.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/snapshot_reconciler.rs)
+* [`server/src/rbx_snapshot.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/rbx_snapshot.rs)
+* [`server/src/rbx_session.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/rbx_session.rs)
+
+To simplify incremental updates of instances, Rojo generates lightweight snapshots describing how files map to instances. This means that Rojo can treat file change events similarly to damage painting as opposed to trying to surgically update the correct instances.
+
+This approach reduces the number of desynchronization bugs, reduces the complexity of important pieces of the codebase, and makes writing plugins a lot easier.
+
+### HTTP API
+Relevant source files:
+
+* [`server/src/web.rs`](https://github.com/LPGhatguy/rojo/blob/master/server/src/web.rs)
+
+The Rojo live-sync server and Roblox Studio plugin communicate via HTTP.
+
+Requests sent from the plugin to the server are regular HTTP requests.
+
+Messages sent from the server to the plugin are delivered via HTTP long-polling. This is an approach that uses long-lived HTTP requests that restart on timeout. It's largely been replaced by WebSockets, but Roblox doesn't have support for them.
+
+## Roblox Studio Plugin
+TODO

docs/reference/full-vs-partial.md

@@ -0,0 +1,37 @@
+Rojo is designed to be adopted incrementally. How much of your project Rojo manages is up to you!
+
+There are two primary categories of ways to use Rojo: *Fully Managed*, where everything is managed by Rojo, and *Partially Managed*, where Rojo only manages a slice of your project.
+
+## Fully Managed
+In a fully managed game project, Rojo controls every instance. A fully managed Rojo project can be built from scratch using `rojo build`.
+
+Fully managed projects are most practical for libraries, plugins, and simple games.
+
+Rojo's goal is to make it practical and easy for _every_ project to be fully managed, but we're not quite there yet!
+
+### Pros
+* Fully reproducible builds from scratch
+* Everything checked into version control
+
+### Cons
+* Without two-way sync, models have to be saved manually
+    * This can be done with the 'Save to File...' menu in Roblox Studio
+    * This will be solved by Two-Way Sync ([issue #164](https://github.com/LPGhatguy/rojo/issues/164))
+* Rojo can't manage everything yet
+    * Refs are currently broken ([issue #142](https://github.com/LPGhatguy/rojo/issues/142))
+
+## Partially Managed
+In a partially managed project, Rojo only handles a slice of the game. This could be as small as a couple scripts, or as large as everything except `Workspace`!
+
+The rest of the place's content can be versioned using Team Create or checked into source control.
+
+Partially managed projects are most practical for complicated games, or games that are migrating to use Rojo.
+
+### Pros
+* Easier to adopt gradually
+* Integrates with Team Create
+
+### Cons
+* Not everything is in version control, which makes merges tougher
+* Rojo can't live-sync instances like Terrain, MeshPart, or CSG operations yet
+    * Will be fixed with plugin escalation ([issue #169](https://github.com/LPGhatguy/rojo/issues/169))

docs/reference/project-format.md

@@ -0,0 +1,145 @@
+[TOC]
+
+## Project File
+
+Rojo projects are JSON files that have the `.project.json` extension. They have these fields:
+
+* `name`: A string indicating the name of the project.
+    * This is only used for diagnostics.
+* `tree`: An [Instance Description](#instance-description) describing the root instance of the project.
+
+## Instance Description
+Instance Descriptions correspond one-to-one with the actual Roblox Instances in the project. They can be specified directly in the project file or be pulled from the filesystem.
+
+* `$className`: The ClassName of the Instance being described.
+    * Optional if `$path` is specified.
+* `$path`: The path on the filesystem to pull files from into the project.
+    * Optional if `$className` is specified.
+    * Paths are relative to the folder containing the project file.
+* `$properties`: Properties to apply to the instance. Values should be [Instance Property Values](#instance-property-value).
+    * Optional
+* `$ignoreUnknownInstances`: Whether instances that Rojo doesn't know about should be deleted.
+    * Optional
+    * Default is `false` if `$path` is specified, otherwise `true`.
+
+All other fields in an Instance Description are turned into instances whose name is the key. These values should also be Instance Descriptions!
+
+Instance Descriptions are fairly verbose and strict. In the future, it'll be possible for Rojo to [infer class names for known services like `Workspace`](https://github.com/LPGhatguy/rojo/issues/179).
+
+## Instance Property Value
+There are two kinds of property values on instances, **implicit** and **explicit**.
+
+In the vast majority of cases, you should be able to use **implicit** property values. To use them, just use a value that's the same shape as the type that the property has:
+
+```json
+"MyPart": {
+    "$className": "Part",
+    "$properties": {
+        "Size": [3, 5, 3],
+        "Color": [0.5, 0, 0.5],
+        "Anchored": true,
+        "Material": "Granite"
+    }
+}
+```
+
+`Vector3` and `Color3` properties can just be arrays of numbers, as can types like `Vector2`, `CFrame`, and more!
+
+Enums can be set to a string containing the enum variant. Rojo will raise an error if the string isn't a valid variant for the enum.
+
+There are some cases where this syntax for assigning properties _doesn't_ work. In these cases, Rojo requires you to use the **explicit** property syntax.
+
+Some reasons why you might need to use an **explicit** property:
+
+* Using exotic property types like `BinaryString`
+* Using properties added to Roblox recently that Rojo doesn't know about yet
+
+The shape of explicit property values is defined by the [rbx-dom](https://github.com/LPGhatguy/rbx-dom) library, so it uses slightly different conventions than the rest of Rojo.
+
+Each value should be an object with the following required fields:
+
+* `Type`: The type of property to represent.
+    * [Supported types can be found here](https://github.com/LPGhatguy/rbx-tree#property-type-coverage).
+* `Value`: The value of the property.
+    * The shape of this field depends on which property type is being used. `Vector3` and `Color3` values are both represented as a list of numbers, while `BinaryString` expects a base64-encoded string, for example.
+
+Here's the same object, but with explicit properties:
+
+```json
+"MyPart": {
+    "$className": "Part",
+    "$properties": {
+        "Size": {
+            "Type": "Vector3",
+            "Value": [3, 5, 3]
+        },
+        "Color": {
+            "Type": "Color3",
+            "Value": [0.5, 0, 0.5]
+        },
+        "Anchored": {
+            "Type": "Bool",
+            "Value": true
+        },
+        "Material": {
+            "Type": "Enum",
+            "Value": 832
+        }
+    }
+}
+```
+
+## Example Projects
+This project bundles up everything in the `src` directory. It'd be suitable for making a plugin or model:
+
+```json
+{
+    "name": "AwesomeLibrary",
+    "tree": {
+        "$path": "src"
+    }
+}
+```
+
+This project describes the layout you might use if you were making the next hit simulator game, *Sisyphus Simulator*:
+
+```json
+{
+    "name": "Sisyphus Simulator",
+    "tree": {
+        "$className": "DataModel",
+
+        "HttpService": {
+            "$className": "HttpService",
+            "$properties": {
+                "HttpEnabled": true
+            }
+        },
+
+        "ReplicatedStorage": {
+            "$className": "ReplicatedStorage",
+            "$path": "src/ReplicatedStorage"
+        },
+
+        "StarterPlayer": {
+            "$className": "StarterPlayer",
+
+            "StarterPlayerScripts": {
+                "$className": "StarterPlayerScripts",
+                "$path": "src/StarterPlayerScripts"
+            }
+        },
+
+        "Workspace": {
+            "$className": "Workspace",
+            "$properties": {
+                "Gravity": 67.3
+            },
+
+            "Terrain": {
+                "$path": "Terrain.rbxm"
+            }
+        }
+    }
+}
+```

docs/reference/sync-details.md

@@ -0,0 +1,144 @@
+This page aims to describe how Rojo turns files on the filesystem into Roblox objects.
+
+[TOC]
+
+## Overview
+| File Name      | Instance Type             |
+| -------------- | ------------------------- |
+| any directory  | `Folder`                  |
+| `*.server.lua` | `Script`                  |
+| `*.client.lua` | `LocalScript`             |
+| `*.lua`        | `ModuleScript`            |
+| `*.csv`        | `LocalizationTable`       |
+| `*.txt`        | `StringValue`             |
+| `*.model.json` | Any                       |
+| `*.rbxm`       | Any                       |
+| `*.rbxmx`      | Any                       |
+| `*.meta.json`  | Modifies another instance |
+
+## Limitations
+Not all property types can be synced by Rojo in real-time due to limitations of the Roblox Studio plugin API. In these cases, you can usually generate a place file and open it when you start working on a project.
+
+Some common cases you might hit are:
+
+* Binary data (Terrain, CSG, CollectionService tags)
+* `MeshPart.MeshId`
+* `HttpService.HttpEnabled`
+
+For a list of all property types that Rojo can reason about, both when live-syncing and when building place files, look at [rbx-dom's type coverage chart](https://github.com/rojo-rbx/rbx-dom#property-type-coverage).
+
+This limitation may be solved by [issue #205](https://github.com/rojo-rbx/rojo/issues/205) in the future.
+
+## Folders
+Any directory on the filesystem will turn into a `Folder` instance unless it contains an 'init' script, described below.
+
+## Scripts
+The default script type in Rojo projects is `ModuleScript`, since most scripts in well-structued Roblox projects will be modules.
+
+If a directory contains a file named `init.server.lua`, `init.client.lua`, or `init.lua`, that folder will be transformed into a `*Script` instance with the contents of the 'init' file. This can be used to create scripts inside of scripts.
+
+For example, these files:
+
+![Tree of files on disk](../images/sync-example-files.svg)
+{: align="center" }
+
+Will turn into these instances in Roblox:
+
+![Tree of instances in Roblox](../images/sync-example-instances.svg)
+{: align="center" }
+
+## Localization Tables
+Any CSV files are transformed into `LocalizationTable` instances. Rojo expects these files to follow the same format that Roblox does when importing and exporting localization information.
+
+## Plain Text Files
+Plain text files (`.txt`) files are transformed into `StringValue` instances. This is useful for bringing in text data that can be read by scripts at runtime.
+
+## JSON Models
+Files ending in `.model.json` can be used to describe simple models. They're designed to be hand-written and are useful for instances like `RemoteEvent`.
+
+A JSON model describing a folder containing a `Part` and a `RemoteEvent` could be described as:
+
+```json
+{
+    "Name": "My Cool Model",
+    "ClassName": "Folder",
+    "Children": [
+        {
+            "Name": "RootPart",
+            "ClassName": "Part",
+            "Properties": {
+                "Size": {
+                    "Type": "Vector3",
+                    "Value": [4, 4, 4]
+                }
+            }
+        },
+        {
+            "Name": "SendMoney",
+            "ClassName": "RemoteEvent"
+        }
+    ]
+}
+```
+
+It would turn into instances in this shape:
+
+![Tree of instances in Roblox](../images/sync-example-json-model.svg)
+{: align="center" }
+
+## Binary and XML Models
+Rojo supports both binary (`.rbxm`) and XML (`.rbxmx`) models generated by Roblox Studio or another tool.
+
+Support for the `rbxmx` is very good, while support for `rbxm` is still very early, buggy, and lacking features.
+
+For a rundown of supported types, check out [rbx-dom's type coverage chart](https://github.com/rojo-rbx/rbx-dom#property-type-coverage).
+
+## Meta Files
+New in Rojo 0.5.0-alpha.12 are meta files, named `.meta.json`.
+
+Meta files allow attaching extra Rojo data to models defined in other formats, like Roblox's `rbxm` and `rbxmx` model formats, or even Lua scripts.
+
+This can be used to set Rojo-specific settings like `ignoreUnknownInstances`, or can be used to set properties like `Disabled` on a script.
+
+Meta files can contain:
+
+* `className`: Changes the `className` of a containing `Folder` into something else.
+    * Usable only in `init.meta.json` files
+* `properties`: A map of properties to set on the instance, just like projects
+    * Usable on anything except `.rbxmx`, `.rbxm`, and `.model.json` files, which already have properties
+* `ignoreUnknownInstances`: Works just like `$ignoreUnknownInstances` in project files
+
+### Meta Files to set Rojo metadata
+Sometimes it's useful to apply properties like `ignoreUnknownInstances` on instances that are defined on the filesystem instead of within the project itself.
+
+### Meta Files for Disabled Scripts
+Meta files can be used to set properties on `Script` instances, like `Disabled`.
+
+If your project had `foo.server.lua` and you wanted to make sure it would be disabled, you could create a `foo.meta.json` next to it with:
+
+```json
+{
+    "properties": {
+        "Disabled": true
+    }
+}
+```
+
+### Meta Files for Tools
+If you wanted to represent a tool containing a script and a model for its handle, create a directory with an `init.meta.json` file in it:
+
+```json
+{
+    "className": "Tool",
+    "properties": {
+        "Grip": [
+            0, 0, 0,
+            1, 0, 0,
+            0, 1, 0,
+            0, 0, 1,
+        ]
+    }
+}
+```
+
+Instead of a `Folder` instance, you'll end up with a `Tool` instance with the `Grip` property set!

docs/rojo-alternatives.md

@@ -0,0 +1,23 @@
+There are a number of existing plugins for Roblox that move code from the filesystem into Roblox.
+
+Besides Rojo, you might consider:
+
+* [rbxmk by Anaminus](https://github.com/anaminus/rbxmk)
+* [Rofresh by Osyris](https://github.com/osyrisrblx/rofresh)
+* [RbxRefresh by Osyris](https://github.com/osyrisrblx/RbxRefresh)
+* [Studio Bridge by Vocksel](https://github.com/vocksel/studio-bridge)
+* [Elixir by Vocksel](https://github.com/vocksel/elixir)
+* [RbxSync by evaera](https://github.com/evaera/RbxSync)
+* [CodeSync by MemoryPenguin](https://github.com/MemoryPenguin/CodeSync)
+* [rbx-exteditor by MemoryPenguin](https://github.com/MemoryPenguin/rbx-exteditor)
+
+So why did I build Rojo?
+
+Each of these tools solves what is essentially the same problem from a few different angles. The goal of Rojo is to take all of the lessons and ideas learned from these projects and build a tool that can solve this problem for good.
+
+Additionally:
+
+* I think that this tool needs to be built in a compiled language without a runtime, for easy distribution and good performance.
+* I think that the conventions promoted by other sync plugins (`.module.lua` for modules, as well a single sync point) are sub-optimal.
+* I think that I have a good enough understanding of the problem to build something robust.
+* I think that Rojo should be able to do more than just sync code.

docs/why-rojo.md

@@ -0,0 +1,39 @@
+Adding a tool like Rojo to your Roblox workflow can be daunting, but it comes with some key advantages.
+
+[TOC]
+
+## External Text Editors
+Rojo opens the door to use the absolute best text editors in the world and their rich plugin ecosystems.
+
+Some very popular editors include [Visual Studio Code](https://code.visualstudio.com) and [Sublime Text](https://www.sublimetext.com).
+
+These advanced text editors have features like multi-cursor editing, goto symbol, multi-file regex find and replace, bookmarks and much more.
+
+Many Rojo VS Code users also use extensions like:
+
+* [vscode-rbxlua](https://marketplace.visualstudio.com/items?itemName=AmaranthineCodices.vscode-rbxlua)
+* [Roblox Lua Autocompletes](https://marketplace.visualstudio.com/items?itemName=Kampfkarren.roblox-lua-autofills)
+* [TabNine](https://tabnine.com)
+
+## Version Control
+By building your game (or just the scripts) as individual files on the filesystem, it becomes easy to start using professional-grade version control tools like [Git](https://git-scm.com) and [GitHub](https://github.com).
+
+Hundreds of thousands of companies and individual developers use Git to version their software projects. With Rojo, Roblox developers can take advantage of the best collaboration tool around.
+
+Using a repository hosting service like GitHub or GitLab brings powerful features to Roblox developers like code reviews and issue tracking that professional engineers can't live without.
+
+## TypeScript
+TypeScript enables static type safety, which helps prevent typos and adds unparalleled autocompletion. It also brings features like arrow functions, object destructuring, functional programming methods, and more!
+
+With Rojo, you can use [roblox-ts](https://roblox-ts.github.io) to compile TypeScript to Lua and take advantage of a huge ecosystem of TypeScript tooling.
+
+It's also possible to use other languages that compile to Lua like [MoonScript](https://moonscript.org) and [Haxe](https://haxe.org).
+
+## Other Tools
+There are decades of excellent tools available that operate on files. With Rojo, it's possible to take advantage of any of them!
+
+Popular tools include:
+
+* [luacheck](https://github.com/mpeterv/luacheck), a static analysis tool to help you write better Lua
+* [ripgrep](https://github.com/BurntSushi/ripgrep), an extremely fast code search tool
+* [Tokei](https://github.com/XAMPPRocky/tokei), a tool for statistics like lines of code

mkdocs.yml

@@ -1,7 +1,6 @@
 site_name: Rojo Documentation
-site_url: https://lpghatguy.github.io/rojo/
-repo_name: LPGhatguy/rojo
-repo_url: https://github.com/LPGhatguy/rojo
+repo_name: rojo-rbx/rojo
+repo_url: https://github.com/rojo-rbx/rojo
 
 theme:
   name: material
@@ -9,10 +8,27 @@ theme:
     primary: 'Red'
     accent: 'Red'
 
-pages:
+nav:
   - Home: index.md
+  - Why Rojo?: why-rojo.md
+  - Guide:
+    - Installation: guide/installation.md
+    - Creating a Game with Rojo: guide/new-game.md
+    - Porting an Existing Game to Rojo: guide/existing-game.md
+    - Migrating from 0.4.x to 0.5.x: guide/migrating-to-epiphany.md
+  - Reference:
+    - Fully vs Partially Managed Rojo: reference/full-vs-partial.md
+    - Project Format: reference/project-format.md
+    - Sync Details: reference/sync-details.md
+  - Rojo Alternatives: rojo-alternatives.md
+  - Rojo Internals:
+    - Internals Overview: internals/overview.md
+
+extra_css:
+  - extra.css
 
 markdown_extensions:
+  - attr_list
   - admonition
   - codehilite:
       guess_lang: false

plugin/.editorconfig

@@ -1,4 +0,0 @@
-[*.lua]
-indent_style = tab
-trim_trailing_whitespace = true
-insert_final_newline = true

plugin/.luacheckrc

@@ -13,6 +13,7 @@ stds.roblox = {
 
 		-- Types
 		"Vector2", "Vector3",
+		"Vector2int16", "Vector3int16",
 		"Color3",
 		"UDim", "UDim2",
 		"Rect",

plugin/README.md

@@ -0,0 +1,5 @@
+# Rojo Plugin
+
+This is the source to the Rojo Roblox Studio plugin.
+
+Documentation is WIP.

plugin/default.project.json

@@ -0,0 +1,21 @@
+{
+  "name": "Rojo",
+  "tree": {
+    "$className": "Folder",
+    "Plugin": {
+      "$path": "src"
+    },
+    "Roact": {
+      "$path": "modules/roact/src"
+    },
+    "Promise": {
+      "$path": "modules/promise/lib"
+    },
+    "t": {
+      "$path": "modules/t/lib"
+    },
+    "RbxDom": {
+      "$path": "modules/rbx-dom/rbx_dom_lua/src"
+    }
+  }
+}

plugin/loadEnvironment.lua

@@ -0,0 +1,37 @@
+--[[
+	Loads the Rojo plugin and all of its dependencies.
+]]
+
+local function loadEnvironment()
+	-- If you add any dependencies, add them to this table so they'll be loaded!
+	local LOAD_MODULES = {
+		{"src", "Rojo"},
+		{"modules/promise/lib", "Promise"},
+		{"modules/testez/lib", "TestEZ"},
+	}
+
+	-- This makes sure we can load Lemur and other libraries that depend on init.lua
+	package.path = package.path .. ";?/init.lua"
+
+	-- If this fails, make sure you've run `lua bin/install-dependencies.lua` first!
+	local lemur = require("modules.lemur")
+
+	-- Create a virtual Roblox tree
+	local habitat = lemur.Habitat.new()
+
+	-- We'll put all of our library code and dependencies here
+	local modules = lemur.Instance.new("Folder")
+	modules.Name = "Modules"
+	modules.Parent = habitat.game:GetService("ReplicatedStorage")
+
+	-- Load all of the modules specified above
+	for _, module in ipairs(LOAD_MODULES) do
+		local container = habitat:loadFromFs(module[1])
+		container.Name = module[2]
+		container.Parent = modules
+	end
+
+	return habitat, modules
+end
+
+return loadEnvironment

plugin/place.project.json

@@ -0,0 +1,48 @@
+{
+  "name": "rojo",
+  "tree": {
+    "$className": "DataModel",
+
+    "ReplicatedStorage": {
+      "$className": "ReplicatedStorage",
+
+      "Rojo": {
+        "$className": "Folder",
+
+        "Plugin": {
+          "$path": "src"
+        },
+        "Roact": {
+          "$path": "modules/roact/src"
+        },
+        "Promise": {
+          "$path": "modules/promise/lib"
+        },
+        "t": {
+          "$path": "modules/t/lib"
+        }
+      },
+      "TestEZ": {
+        "$path": "modules/testez/lib"
+      }
+    },
+
+    "HttpService": {
+      "$className": "HttpService",
+      "$properties": {
+        "HttpEnabled": {
+          "Type": "Bool",
+          "Value": true
+        }
+      }
+    },
+
+    "ServerScriptService": {
+      "$className": "ServerScriptService",
+
+      "TestBootstrap": {
+        "$path": "testBootstrap.server.lua"
+      }
+    }
+  }
+}

plugin/rojo.json

@@ -1,30 +0,0 @@
-{
-  "name": "rojo",
-  "servePort": 8000,
-  "partitions": {
-    "plugin": {
-      "path": "src",
-      "target": "ReplicatedStorage.Rojo.plugin"
-    },
-    "modules/roact": {
-      "path": "modules/roact/lib",
-      "target": "ReplicatedStorage.Rojo.modules.Roact"
-    },
-    "modules/rodux": {
-      "path": "modules/rodux/lib",
-      "target": "ReplicatedStorage.Rojo.modules.Rodux"
-    },
-    "modules/roact-rodux": {
-      "path": "modules/roact-rodux/lib",
-      "target": "ReplicatedStorage.Rojo.modules.RoactRodux"
-    },
-    "modules/testez": {
-      "path": "modules/testez/lib",
-      "target": "ReplicatedStorage.TestEZ"
-    },
-    "tests": {
-      "path": "tests",
-      "target": "TestService"
-    }
-  }
-}

plugin/runTest.lua

@@ -0,0 +1,15 @@
+local loadEnvironment = require("loadEnvironment")
+
+local testPath = assert((...), "Please specify a path to a test file.")
+
+local habitat = loadEnvironment()
+
+local testModule = habitat:loadFromFs(testPath)
+
+if testModule == nil then
+	error("Couldn't find test file at " .. testPath)
+end
+
+print("Starting test module.")
+
+habitat:require(testModule)

plugin/spec.lua

@@ -2,68 +2,16 @@
 	Loads our library and all of its dependencies, then runs tests using TestEZ.
 ]]
 
--- If you add any dependencies, add them to this table so they'll be loaded!
-local LOAD_MODULES = {
-	{"src", "Plugin"},
-	{"modules/testez/lib", "TestEZ"},
-}
+local loadEnvironment = require("loadEnvironment")
 
--- This makes sure we can load Lemur and other libraries that depend on init.lua
-package.path = package.path .. ";?/init.lua"
-
--- If this fails, make sure you've run `lua bin/install-dependencies.lua` first!
-local lemur = require("modules.lemur")
-
---[[
-	Collapses ModuleScripts named 'init' into their parent folders.
-
-	This is the same result as the collapsing mechanism from Rojo.
-]]
-local function collapse(root)
-	local init = root:FindFirstChild("init")
-	if init then
-		init.Name = root.Name
-		init.Parent = root.Parent
-
-		for _, child in ipairs(root:GetChildren()) do
-			child.Parent = init
-		end
-
-		root:Destroy()
-		root = init
-	end
-
-	for _, child in ipairs(root:GetChildren()) do
-		if child:IsA("Folder") then
-			collapse(child)
-		end
-	end
-
-	return root
-end
-
--- Create a virtual Roblox tree
-local habitat = lemur.Habitat.new()
-
--- We'll put all of our library code and dependencies here
-local Root = lemur.Instance.new("Folder")
-Root.Name = "Root"
-
--- Load all of the modules specified above
-for _, module in ipairs(LOAD_MODULES) do
-	local container = lemur.Instance.new("Folder", Root)
-	container.Name = module[2]
-	habitat:loadFromFs(module[1], container)
-end
-
-collapse(Root)
+local habitat, modules = loadEnvironment()
 
 -- Load TestEZ and run our tests
-local TestEZ = habitat:require(Root.TestEZ)
+local TestEZ = habitat:require(modules.TestEZ)
 
-local results = TestEZ.TestBootstrap:run(Root.Plugin, TestEZ.Reporters.TextReporter)
+local results = TestEZ.TestBootstrap:run({modules.Rojo}, TestEZ.Reporters.TextReporter)
 
 -- Did something go wrong?
 if results.failureCount > 0 then
 	os.exit(1)
-end
+end

plugin/src/Api.lua

@@ -1,112 +0,0 @@
-local HttpService = game:GetService("HttpService")
-
-local Config = require(script.Parent.Config)
-local Promise = require(script.Parent.Promise)
-local Version = require(script.Parent.Version)
-
-local Api = {}
-Api.__index = Api
-
-Api.Error = {
-	ServerIdMismatch = "ServerIdMismatch",
-}
-
-setmetatable(Api.Error, {
-	__index = function(_, key)
-		error("Invalid API.Error name " .. key, 2)
-	end
-})
-
---[[
-	Api.connect(Http) -> Promise<Api>
-
-	Create a new Api using the given HTTP implementation.
-
-	Attempting to invoke methods on an invalid conext will throw errors!
-]]
-function Api.connect(http)
-	local context = {
-		http = http,
-		serverId = nil,
-		currentTime = 0,
-	}
-
-	setmetatable(context, Api)
-
-	return context:_start()
-end
-
-function Api:_start()
-	return self.http:get("/")
-		:andThen(function(response)
-			response = response:json()
-
-			if response.protocolVersion ~= Config.protocolVersion then
-				local message = (
-					"Found a Rojo dev server, but it's using a different protocol version, and is incompatible." ..
-					"\nMake sure you have matching versions of both the Rojo plugin and server!" ..
-					"\n\nYour client is version %s, with protocol version %s. It expects server version %s." ..
-					"\nYour server is version %s, with protocol version %s." ..
-					"\n\nGo to https://github.com/LPGhatguy/rojo for more details."
-				):format(
-					Version.display(Config.version), Config.protocolVersion,
-					Config.expectedApiVersionString,
-					response.serverVersion, response.protocolVersion
-				)
-
-				return Promise.reject(message)
-			end
-
-			self.serverId = response.serverId
-			self.currentTime = response.currentTime
-
-			return self
-		end)
-end
-
-function Api:getInfo()
-	return self.http:get("/")
-		:andThen(function(response)
-			response = response:json()
-
-			if response.serverId ~= self.serverId then
-				return Promise.reject(Api.Error.ServerIdMismatch)
-			end
-
-			return response
-		end)
-end
-
-function Api:read(paths)
-	local body = HttpService:JSONEncode(paths)
-
-	return self.http:post("/read", body)
-		:andThen(function(response)
-			response = response:json()
-
-			if response.serverId ~= self.serverId then
-				return Promise.reject(Api.Error.ServerIdMismatch)
-			end
-
-			return response.items
-		end)
-end
-
-function Api:getChanges()
-	local url = ("/changes/%f"):format(self.currentTime)
-
-	return self.http:get(url)
-		:andThen(function(response)
-			response = response:json()
-
-			if response.serverId ~= self.serverId then
-				return Promise.reject(Api.Error.ServerIdMismatch)
-			end
-
-			self.currentTime = response.currentTime
-
-			return response.changes
-		end)
-end
-
-return Api

plugin/src/ApiContext.lua

@@ -0,0 +1,169 @@
+local Promise = require(script.Parent.Parent.Promise)
+
+local Config = require(script.Parent.Config)
+local Version = require(script.Parent.Version)
+local Http = require(script.Parent.Http)
+local HttpError = require(script.Parent.HttpError)
+
+local ApiContext = {}
+ApiContext.__index = ApiContext
+
+-- TODO: Audit cases of errors and create enum values for each of them.
+ApiContext.Error = {
+	ServerIdMismatch = "ServerIdMismatch",
+
+	-- The server gave an unexpected 400-category error, which may be the
+	-- client's fault.
+	ClientError = "ClientError",
+
+	-- The server gave an unexpected 500-category error, which may be the
+	-- server's fault.
+	ServerError = "ServerError",
+}
+
+setmetatable(ApiContext.Error, {
+	__index = function(_, key)
+		error("Invalid ApiContext.Error name " .. key, 2)
+	end
+})
+
+local function rejectFailedRequests(response)
+	if response.code >= 400 then
+		if response.code < 500 then
+			return Promise.reject(ApiContext.Error.ClientError)
+		else
+			return Promise.reject(ApiContext.Error.ServerError)
+		end
+	end
+
+	return response
+end
+
+function ApiContext.new(baseUrl)
+	assert(type(baseUrl) == "string")
+
+	local self = {
+		baseUrl = baseUrl,
+		serverId = nil,
+		rootInstanceId = nil,
+		messageCursor = -1,
+		partitionRoutes = nil,
+	}
+
+	setmetatable(self, ApiContext)
+
+	return self
+end
+
+function ApiContext:onMessage(callback)
+	self.onMessageCallback = callback
+end
+
+function ApiContext:connect()
+	local url = ("%s/api/rojo"):format(self.baseUrl)
+
+	return Http.get(url)
+		:andThen(rejectFailedRequests)
+		:andThen(function(response)
+			local body = response:json()
+
+			if body.protocolVersion ~= Config.protocolVersion then
+				local message = (
+					"Found a Rojo dev server, but it's using a different protocol version, and is incompatible." ..
+					"\nMake sure you have matching versions of both the Rojo plugin and server!" ..
+					"\n\nYour client is version %s, with protocol version %s. It expects server version %s." ..
+					"\nYour server is version %s, with protocol version %s." ..
+					"\n\nGo to https://github.com/LPGhatguy/rojo for more details."
+				):format(
+					Version.display(Config.version), Config.protocolVersion,
+					Config.expectedApiContextVersionString,
+					body.serverVersion, body.protocolVersion
+				)
+
+				return Promise.reject(message)
+			end
+
+			if body.expectedPlaceIds ~= nil then
+				local foundId = false
+
+				for _, id in ipairs(body.expectedPlaceIds) do
+					if id == game.PlaceId then
+						foundId = true
+						break
+					end
+				end
+
+				if not foundId then
+					local idList = {}
+					for _, id in ipairs(body.expectedPlaceIds) do
+						table.insert(idList, "- " .. tostring(id))
+					end
+
+					local message = (
+						"Found a Rojo server, but its project is set to only be used with a specific list of places." ..
+						"\nYour place ID is %s, but needs to be one of these:" ..
+						"\n%s" ..
+						"\n\nTo change this list, edit 'servePlaceIds' in roblox-project.json"
+					):format(
+						tostring(game.PlaceId),
+						table.concat(idList, "\n")
+					)
+
+					return Promise.reject(message)
+				end
+			end
+
+			self.serverId = body.serverId
+			self.partitionRoutes = body.partitions
+			self.rootInstanceId = body.rootInstanceId
+		end)
+end
+
+function ApiContext:read(ids)
+	local url = ("%s/api/read/%s"):format(self.baseUrl, table.concat(ids, ","))
+
+	return Http.get(url)
+		:andThen(rejectFailedRequests)
+		:andThen(function(response)
+			local body = response:json()
+
+			if body.serverId ~= self.serverId then
+				return Promise.reject("Server changed ID")
+			end
+
+			self.messageCursor = body.messageCursor
+
+			return body
+		end)
+end
+
+function ApiContext:retrieveMessages()
+	local url = ("%s/api/subscribe/%s"):format(self.baseUrl, self.messageCursor)
+
+	local function sendRequest()
+		return Http.get(url)
+			:catch(function(err)
+				if err.type == HttpError.Error.Timeout then
+					return sendRequest()
+				end
+
+				return Promise.reject(err)
+			end)
+	end
+
+	return sendRequest()
+		:andThen(rejectFailedRequests)
+		:andThen(function(response)
+			local body = response:json()
+
+			if body.serverId ~= self.serverId then
+				return Promise.reject("Server changed ID")
+			end
+
+			self.messageCursor = body.messageCursor
+
+			return body.messages
+		end)
+end
+
+return ApiContext

plugin/src/Assets.lua

@@ -0,0 +1,42 @@
+local Assets = {
+	Sprites = {
+		WhiteCross = {
+			asset = "rbxassetid://2738712459",
+			offset = Vector2.new(190, 318),
+			size = Vector2.new(18, 18),
+		},
+	},
+	Slices = {
+		RoundBox = {
+			asset = "rbxassetid://2773204550",
+			offset = Vector2.new(0, 0),
+			size = Vector2.new(32, 32),
+			center = Rect.new(4, 4, 4, 4),
+		},
+	},
+	Images = {
+		Logo = "rbxassetid://3405346157",
+		Icon = "rbxassetid://3405341609",
+	},
+	StartSession = "",
+	SessionActive = "",
+	Configure = "",
+}
+
+local function guardForTypos(name, map)
+	setmetatable(map, {
+		__index = function(_, key)
+			error(("%q is not a valid member of %s"):format(tostring(key), name), 2)
+		end
+	})
+
+	for key, child in pairs(map) do
+		if type(child) == "table" then
+			guardForTypos(("%s.%s"):format(name, key), child)
+		end
+	end
+end
+
+guardForTypos("Assets", Assets)
+
+return Assets

plugin/src/Components/App.lua

@@ -0,0 +1,189 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+local Plugin = Rojo.Plugin
+
+local Roact = require(Rojo.Roact)
+
+local Assets = require(Plugin.Assets)
+local Config = require(Plugin.Config)
+local DevSettings = require(Plugin.DevSettings)
+local Logging = require(Plugin.Logging)
+local Session = require(Plugin.Session)
+local Version = require(Plugin.Version)
+local preloadAssets = require(Plugin.preloadAssets)
+
+local ConnectPanel = require(Plugin.Components.ConnectPanel)
+local ConnectionActivePanel = require(Plugin.Components.ConnectionActivePanel)
+
+local e = Roact.createElement
+
+local function showUpgradeMessage(lastVersion)
+	local message = (
+		"Rojo detected an upgrade from version %s to version %s." ..
+		"\nMake sure you have also upgraded your server!" ..
+		"\n\nRojo plugin version %s is intended for use with server version %s."
+	):format(
+		Version.display(lastVersion), Version.display(Config.version),
+		Version.display(Config.version), Config.expectedServerVersionString
+	)
+
+	Logging.info(message)
+end
+
+--[[
+	Check if the user is using a newer version of Rojo than last time. If they
+	are, show them a reminder to make sure they check their server version.
+]]
+local function checkUpgrade(plugin)
+	-- When developing Rojo, there's no use in doing version checks
+	if DevSettings:isEnabled() then
+		return
+	end
+
+	local lastVersion = plugin:GetSetting("LastRojoVersion")
+
+	if lastVersion then
+		local wasUpgraded = Version.compare(Config.version, lastVersion) == 1
+
+		if wasUpgraded then
+			showUpgradeMessage(lastVersion)
+		end
+	end
+
+	plugin:SetSetting("LastRojoVersion", Config.version)
+end
+
+local SessionStatus = {
+	Disconnected = "Disconnected",
+	Connected = "Connected",
+}
+
+setmetatable(SessionStatus, {
+	__index = function(_, key)
+		error(("%q is not a valid member of SessionStatus"):format(tostring(key)), 2)
+	end,
+})
+
+local App = Roact.Component:extend("App")
+
+function App:init()
+	self:setState({
+		sessionStatus = SessionStatus.Disconnected,
+	})
+
+	self.signals = {}
+	self.currentSession = nil
+
+	self.displayedVersion = DevSettings:isEnabled()
+		and Config.codename
+		or Version.display(Config.version)
+
+	local toolbar = self.props.plugin:CreateToolbar("Rojo " .. self.displayedVersion)
+
+	self.toggleButton = toolbar:CreateButton(
+		"Rojo",
+		"Show or hide the Rojo panel",
+		Assets.Images.Icon)
+	self.toggleButton.ClickableWhenViewportHidden = true
+	self.toggleButton.Click:Connect(function()
+		self.dockWidget.Enabled = not self.dockWidget.Enabled
+	end)
+
+	local widgetInfo = DockWidgetPluginGuiInfo.new(
+		Enum.InitialDockState.Right,
+		false, -- Initially enabled state
+		false, -- Whether to override the widget's previous state
+		360, 190, -- Floating size
+		360, 190 -- Minimum size
+	)
+
+	self.dockWidget = self.props.plugin:CreateDockWidgetPluginGui("Rojo-0.5.x", widgetInfo)
+	self.dockWidget.Name = "Rojo " .. self.displayedVersion
+	self.dockWidget.Title = "Rojo " .. self.displayedVersion
+	self.dockWidget.AutoLocalize = false
+	self.dockWidget.ZIndexBehavior = Enum.ZIndexBehavior.Sibling
+
+	self.signals.dockWidgetEnabled = self.dockWidget:GetPropertyChangedSignal("Enabled"):Connect(function()
+		self.toggleButton:SetActive(self.dockWidget.Enabled)
+	end)
+end
+
+function App:render()
+	local children
+
+	if self.state.sessionStatus == SessionStatus.Connected then
+		children = {
+			ConnectionActivePanel = e(ConnectionActivePanel, {
+				stopSession = function()
+					Logging.trace("Disconnecting session")
+
+					self.currentSession:disconnect()
+					self.currentSession = nil
+					self:setState({
+						sessionStatus = SessionStatus.Disconnected,
+					})
+
+					Logging.trace("Session terminated by user")
+				end,
+			}),
+		}
+	elseif self.state.sessionStatus == SessionStatus.Disconnected then
+		children = {
+			ConnectPanel = e(ConnectPanel, {
+				startSession = function(address, port)
+					Logging.trace("Starting new session")
+
+					local success, session = Session.new({
+						address = address,
+						port = port,
+						onError = function(message)
+							Logging.warn("Rojo session terminated because of an error:\n%s", tostring(message))
+							self.currentSession = nil
+
+							self:setState({
+								sessionStatus = SessionStatus.Disconnected,
+							})
+						end
+					})
+
+					if success then
+						self.currentSession = session
+						self:setState({
+							sessionStatus = SessionStatus.Connected,
+						})
+					end
+				end,
+				cancel = function()
+					Logging.trace("Canceling session configuration")
+
+					self:setState({
+						sessionStatus = SessionStatus.Disconnected,
+					})
+				end,
+			}),
+		}
+	end
+
+	return Roact.createElement(Roact.Portal, {
+		target = self.dockWidget,
+	}, children)
+end
+
+function App:didMount()
+	Logging.trace("Rojo %s initializing", self.displayedVersion)
+
+	checkUpgrade(self.props.plugin)
+	preloadAssets()
+end
+
+function App:willUnmount()
+	if self.currentSession ~= nil then
+		self.currentSession:disconnect()
+		self.currentSession = nil
+	end
+
+	for _, signal in pairs(self.signals) do
+		signal:Disconnect()
+	end
+end
+
+return App

plugin/src/Components/ConnectPanel.lua

@@ -0,0 +1,161 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+local Plugin = Rojo.Plugin
+
+local Roact = require(Rojo.Roact)
+
+local Config = require(Plugin.Config)
+local Theme = require(Plugin.Theme)
+
+local Panel = require(Plugin.Components.Panel)
+local FitList = require(Plugin.Components.FitList)
+local FitText = require(Plugin.Components.FitText)
+local FormButton = require(Plugin.Components.FormButton)
+local FormTextInput = require(Plugin.Components.FormTextInput)
+
+local e = Roact.createElement
+
+local ConnectPanel = Roact.Component:extend("ConnectPanel")
+
+function ConnectPanel:init()
+	self:setState({
+		address = "",
+		port = "",
+	})
+end
+
+function ConnectPanel:render()
+	local startSession = self.props.startSession
+
+	return e(Panel, nil, {
+		Layout = e("UIListLayout", {
+			SortOrder = Enum.SortOrder.LayoutOrder,
+			HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			VerticalAlignment = Enum.VerticalAlignment.Center,
+		}),
+
+		Inputs = e(FitList, {
+			containerProps = {
+				BackgroundTransparency = 1,
+				LayoutOrder = 1,
+			},
+			layoutProps = {
+				FillDirection = Enum.FillDirection.Horizontal,
+				Padding = UDim.new(0, 8),
+			},
+			paddingProps = {
+				PaddingTop = UDim.new(0, 20),
+				PaddingBottom = UDim.new(0, 10),
+				PaddingLeft = UDim.new(0, 24),
+				PaddingRight = UDim.new(0, 24),
+			},
+		}, {
+			Address = e(FitList, {
+				containerProps = {
+					LayoutOrder = 1,
+					BackgroundTransparency = 1,
+				},
+				layoutProps = {
+					Padding = UDim.new(0, 4),
+				},
+			}, {
+				Label = e(FitText, {
+					Kind = "TextLabel",
+					LayoutOrder = 1,
+					BackgroundTransparency = 1,
+					TextXAlignment = Enum.TextXAlignment.Left,
+					Font = Theme.TitleFont,
+					TextSize = 20,
+					Text = "Address",
+					TextColor3 = Theme.PrimaryColor,
+				}),
+
+				Input = e(FormTextInput, {
+					layoutOrder = 2,
+					width = UDim.new(0, 220),
+					value = self.state.address,
+					placeholderValue = Config.defaultHost,
+					onValueChange = function(newValue)
+						self:setState({
+							address = newValue,
+						})
+					end,
+				}),
+			}),
+
+			Port = e(FitList, {
+				containerProps = {
+					LayoutOrder = 2,
+					BackgroundTransparency = 1,
+				},
+				layoutProps = {
+					Padding = UDim.new(0, 4),
+				},
+			}, {
+				Label = e(FitText, {
+					Kind = "TextLabel",
+					LayoutOrder = 1,
+					BackgroundTransparency = 1,
+					TextXAlignment = Enum.TextXAlignment.Left,
+					Font = Theme.TitleFont,
+					TextSize = 20,
+					Text = "Port",
+					TextColor3 = Theme.PrimaryColor,
+				}),
+
+				Input = e(FormTextInput, {
+					layoutOrder = 2,
+					width = UDim.new(0, 80),
+					value = self.state.port,
+					placeholderValue = Config.defaultPort,
+					onValueChange = function(newValue)
+						self:setState({
+							port = newValue,
+						})
+					end,
+				}),
+			}),
+		}),
+
+		Buttons = e(FitList, {
+			fitAxes = "Y",
+			containerProps = {
+				BackgroundTransparency = 1,
+				LayoutOrder = 2,
+				Size = UDim2.new(1, 0, 0, 0),
+			},
+			layoutProps = {
+				FillDirection = Enum.FillDirection.Horizontal,
+				HorizontalAlignment = Enum.HorizontalAlignment.Right,
+				Padding = UDim.new(0, 8),
+			},
+			paddingProps = {
+				PaddingTop = UDim.new(0, 0),
+				PaddingBottom = UDim.new(0, 20),
+				PaddingLeft = UDim.new(0, 24),
+				PaddingRight = UDim.new(0, 24),
+			},
+		}, {
+			e(FormButton, {
+				layoutOrder = 2,
+				text = "Connect",
+				onClick = function()
+					if startSession ~= nil then
+						local address = self.state.address
+						if address:len() == 0 then
+							address = Config.defaultHost
+						end
+
+						local port = self.state.port
+						if port:len() == 0 then
+							port = Config.defaultPort
+						end
+
+						startSession(address, port)
+					end
+				end,
+			}),
+		}),
+	})
+end
+
+return ConnectPanel

plugin/src/Components/ConnectionActivePanel.lua

@@ -0,0 +1,46 @@
+local Roact = require(script:FindFirstAncestor("Rojo").Roact)
+
+local Plugin = script:FindFirstAncestor("Plugin")
+
+local Theme = require(Plugin.Theme)
+
+local Panel = require(Plugin.Components.Panel)
+local FitText = require(Plugin.Components.FitText)
+local FormButton = require(Plugin.Components.FormButton)
+
+local e = Roact.createElement
+
+local ConnectionActivePanel = Roact.Component:extend("ConnectionActivePanel")
+
+function ConnectionActivePanel:render()
+	local stopSession = self.props.stopSession
+
+	return e(Panel, nil, {
+		Layout = Roact.createElement("UIListLayout", {
+			HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			VerticalAlignment = Enum.VerticalAlignment.Center,
+			SortOrder = Enum.SortOrder.LayoutOrder,
+			Padding = UDim.new(0, 8),
+		}),
+
+		Text = e(FitText, {
+			Padding = Vector2.new(12, 6),
+			Font = Theme.ButtonFont,
+			TextSize = 18,
+			Text = "Connected to Live-Sync Server",
+			TextColor3 = Theme.PrimaryColor,
+			BackgroundTransparency = 1,
+		}),
+
+		DisconnectButton = e(FormButton, {
+			layoutOrder = 2,
+			text = "Disconnect",
+			secondary = true,
+			onClick = function()
+				stopSession()
+			end,
+		}),
+	})
+end
+
+return ConnectionActivePanel

plugin/src/Components/FitList.lua

@@ -0,0 +1,63 @@
+local Roact = require(script:FindFirstAncestor("Rojo").Roact)
+
+local Dictionary = require(script.Parent.Parent.Dictionary)
+
+local e = Roact.createElement
+
+local FitList = Roact.Component:extend("FitList")
+
+function FitList:init()
+	self.sizeBinding, self.setSize = Roact.createBinding(UDim2.new())
+end
+
+function FitList:render()
+	local containerKind = self.props.containerKind or "Frame"
+	local fitAxes = self.props.fitAxes or "XY"
+	local containerProps = self.props.containerProps
+	local layoutProps = self.props.layoutProps
+	local paddingProps = self.props.paddingProps
+
+	local padding
+	if paddingProps ~= nil then
+		padding = e("UIPadding", paddingProps)
+	end
+
+	local children = Dictionary.merge(self.props[Roact.Children], {
+		["$Layout"] = e("UIListLayout", Dictionary.merge({
+			SortOrder = Enum.SortOrder.LayoutOrder,
+			[Roact.Change.AbsoluteContentSize] = function(instance)
+				local contentSize = instance.AbsoluteContentSize
+
+				if paddingProps ~= nil then
+					contentSize = contentSize + Vector2.new(
+						paddingProps.PaddingLeft.Offset + paddingProps.PaddingRight.Offset,
+						paddingProps.PaddingTop.Offset + paddingProps.PaddingBottom.Offset)
+				end
+
+				local combinedSize
+
+				if fitAxes == "X" then
+					combinedSize = UDim2.new(0, contentSize.X, containerProps.Size.Y.Scale, containerProps.Size.Y.Offset)
+				elseif fitAxes == "Y" then
+					combinedSize = UDim2.new(containerProps.Size.X.Scale, containerProps.Size.X.Offset, 0, contentSize.Y)
+				elseif fitAxes == "XY" then
+					combinedSize = UDim2.new(0, contentSize.X, 0, contentSize.Y)
+				else
+					error("Invalid fitAxes value")
+				end
+
+				self.setSize(combinedSize)
+			end,
+		}, layoutProps)),
+
+		["$Padding"] = padding,
+	})
+
+	local fullContainerProps = Dictionary.merge(containerProps, {
+		Size = self.sizeBinding,
+	})
+
+	return e(containerKind, fullContainerProps, children)
+end
+
+return FitList

plugin/src/Components/FitText.lua

@@ -0,0 +1,52 @@
+local TextService = game:GetService("TextService")
+
+local Roact = require(script:FindFirstAncestor("Rojo").Roact)
+
+local Dictionary = require(script.Parent.Parent.Dictionary)
+
+local e = Roact.createElement
+
+local FitText = Roact.Component:extend("FitText")
+
+function FitText:init()
+	self.sizeBinding, self.setSize = Roact.createBinding(UDim2.new())
+end
+
+function FitText:render()
+	local kind = self.props.Kind or "TextLabel"
+
+	local containerProps = Dictionary.merge(self.props, {
+		Kind = Dictionary.None,
+		Padding = Dictionary.None,
+		MinSize = Dictionary.None,
+		Size = self.sizeBinding
+	})
+
+	return e(kind, containerProps)
+end
+
+function FitText:didMount()
+	self:updateTextMeasurements()
+end
+
+function FitText:didUpdate()
+	self:updateTextMeasurements()
+end
+
+function FitText:updateTextMeasurements()
+	local minSize = self.props.MinSize or Vector2.new(0, 0)
+	local padding = self.props.Padding or Vector2.new(0, 0)
+
+	local text = self.props.Text or ""
+	local font = self.props.Font or Enum.Font.Legacy
+	local textSize = self.props.TextSize or 12
+
+	local measuredText = TextService:GetTextSize(text, textSize, font, Vector2.new(9e6, 9e6))
+	local totalSize = UDim2.new(
+		0, math.max(minSize.X, padding.X * 2 + measuredText.X),
+		0, math.max(minSize.Y, padding.Y * 2 + measuredText.Y))
+
+	self.setSize(totalSize)
+end
+
+return FitText

plugin/src/Components/FormButton.lua

@@ -0,0 +1,62 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+local Plugin = Rojo.Plugin
+
+local Roact = require(Rojo.Roact)
+
+local Assets = require(Plugin.Assets)
+local Theme = require(Plugin.Theme)
+local FitList = require(Plugin.Components.FitList)
+local FitText = require(Plugin.Components.FitText)
+
+local e = Roact.createElement
+
+local RoundBox = Assets.Slices.RoundBox
+
+local function FormButton(props)
+	local text = props.text
+	local layoutOrder = props.layoutOrder
+	local onClick = props.onClick
+
+	local textColor
+	local backgroundColor
+
+	if props.secondary then
+		textColor = Theme.AccentColor
+		backgroundColor = Theme.SecondaryColor
+	else
+		textColor = Theme.SecondaryColor
+		backgroundColor = Theme.AccentColor
+	end
+
+	return e(FitList, {
+		containerKind = "ImageButton",
+		containerProps = {
+			LayoutOrder = layoutOrder,
+			BackgroundTransparency = 1,
+			Image = RoundBox.asset,
+			ImageRectOffset = RoundBox.offset,
+			ImageRectSize = RoundBox.size,
+			SliceCenter = RoundBox.center,
+			ScaleType = Enum.ScaleType.Slice,
+			ImageColor3 = backgroundColor,
+
+			[Roact.Event.Activated] = function()
+				if onClick ~= nil then
+					onClick()
+				end
+			end,
+		},
+	}, {
+		Text = e(FitText, {
+			Kind = "TextLabel",
+			Text = text,
+			TextSize = 18,
+			TextColor3 = textColor,
+			Font = Theme.ButtonFont,
+			Padding = Vector2.new(16, 8),
+			BackgroundTransparency = 1,
+		}),
+	})
+end
+
+return FormButton

plugin/src/Components/FormTextInput.lua

@@ -0,0 +1,80 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+local Plugin = Rojo.Plugin
+
+local Roact = require(Rojo.Roact)
+
+local Assets = require(Plugin.Assets)
+local Theme = require(Plugin.Theme)
+
+local e = Roact.createElement
+
+local RoundBox = Assets.Slices.RoundBox
+
+local TEXT_SIZE = 22
+local PADDING = 8
+
+local FormTextInput = Roact.Component:extend("FormTextInput")
+
+function FormTextInput:init()
+	self:setState({
+		focused = false,
+	})
+end
+
+function FormTextInput:render()
+	local value = self.props.value
+	local placeholderValue = self.props.placeholderValue
+	local onValueChange = self.props.onValueChange
+	local layoutOrder = self.props.layoutOrder
+	local width = self.props.width
+
+	local shownPlaceholder
+	if self.state.focused then
+		shownPlaceholder = ""
+	else
+		shownPlaceholder = placeholderValue
+	end
+
+	return e("ImageLabel", {
+		LayoutOrder = layoutOrder,
+		Image = RoundBox.asset,
+		ImageRectOffset = RoundBox.offset,
+		ImageRectSize = RoundBox.size,
+		ScaleType = Enum.ScaleType.Slice,
+		SliceCenter = RoundBox.center,
+		ImageColor3 = Theme.SecondaryColor,
+		Size = UDim2.new(width.Scale, width.Offset, 0, TEXT_SIZE + PADDING * 2),
+		BackgroundTransparency = 1,
+	}, {
+		InputInner = e("TextBox", {
+			BackgroundTransparency = 1,
+			Size = UDim2.new(1, -PADDING * 2, 1, -PADDING * 2),
+			Position = UDim2.new(0.5, 0, 0.5, 0),
+			AnchorPoint = Vector2.new(0.5, 0.5),
+			Font = Theme.InputFont,
+			ClearTextOnFocus = false,
+			TextXAlignment = Enum.TextXAlignment.Center,
+			TextSize = TEXT_SIZE,
+			Text = value,
+			PlaceholderText = shownPlaceholder,
+			PlaceholderColor3 = Theme.LightTextColor,
+			TextColor3 = Theme.PrimaryColor,
+
+			[Roact.Change.Text] = function(rbx)
+				onValueChange(rbx.Text)
+			end,
+			[Roact.Event.Focused] = function()
+				self:setState({
+					focused = true,
+				})
+			end,
+			[Roact.Event.FocusLost] = function()
+				self:setState({
+					focused = false,
+				})
+			end,
+		}),
+	})
+end
+
+return FormTextInput

plugin/src/Components/Panel.lua

@@ -0,0 +1,34 @@
+local Roact = require(script:FindFirstAncestor("Rojo").Roact)
+
+local Plugin = script:FindFirstAncestor("Plugin")
+
+local RojoFooter = require(Plugin.Components.RojoFooter)
+
+local e = Roact.createElement
+
+local Panel = Roact.Component:extend("Panel")
+
+function Panel:init()
+	self.footerSize, self.setFooterSize = Roact.createBinding(Vector2.new())
+end
+
+function Panel:render()
+	return e("Frame", {
+		Size = UDim2.new(1, 0, 1, 0),
+		BackgroundTransparency = 1,
+	}, {
+		Layout = Roact.createElement("UIListLayout", {
+			HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			SortOrder = Enum.SortOrder.LayoutOrder,
+		}),
+
+		Body = e("Frame", {
+			Size = UDim2.new(0, 360, 1, -32),
+			BackgroundTransparency = 1,
+		}, self.props[Roact.Children]),
+
+		Footer = e(RojoFooter),
+	})
+end
+
+return Panel

plugin/src/Components/RojoFooter.lua

@@ -0,0 +1,69 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+local Plugin = Rojo.Plugin
+
+local Roact = require(Rojo.Roact)
+
+local Config = require(Plugin.Config)
+local Version = require(Plugin.Version)
+local Assets = require(Plugin.Assets)
+local Theme = require(Plugin.Theme)
+
+local FitText = require(Plugin.Components.FitText)
+
+local e = Roact.createElement
+
+local RojoFooter = Roact.Component:extend("RojoFooter")
+
+function RojoFooter:init()
+	self.footerSize, self.setFooterSize = Roact.createBinding(Vector2.new())
+	self.footerVersionSize, self.setFooterVersionSize = Roact.createBinding(Vector2.new())
+end
+
+function RojoFooter:render()
+	return e("Frame", {
+		LayoutOrder = 3,
+		Size = UDim2.new(1, 0, 0, 32),
+		BackgroundColor3 = Theme.SecondaryColor,
+		BorderSizePixel = 0,
+	}, {
+		Padding = e("UIPadding", {
+			PaddingTop = UDim.new(0, 4),
+			PaddingBottom = UDim.new(0, 4),
+			PaddingLeft = UDim.new(0, 8),
+			PaddingRight = UDim.new(0, 8),
+		}),
+
+		LogoContainer = e("Frame", {
+			BackgroundTransparency = 1,
+
+			Size = UDim2.new(0, 0, 0, 32),
+		}, {
+			Logo = e("ImageLabel", {
+				Image = Assets.Images.Logo,
+				Size = UDim2.new(0, 80, 0, 40),
+				ScaleType = Enum.ScaleType.Fit,
+				BackgroundTransparency = 1,
+				Position = UDim2.new(0, 0, 1, -10),
+				AnchorPoint = Vector2.new(0, 1),
+			}),
+		}),
+
+		Version = e("TextLabel", {
+			Position = UDim2.new(1, 0, 0, 0),
+			Size = UDim2.new(0, 0, 1, 0),
+			AnchorPoint = Vector2.new(1, 0),
+			Font = Theme.TitleFont,
+			TextSize = 18,
+			Text = Version.display(Config.version),
+			TextXAlignment = Enum.TextXAlignment.Right,
+			TextColor3 = Theme.LightTextColor,
+			BackgroundTransparency = 1,
+
+			[Roact.Change.AbsoluteSize] = function(rbx)
+				self.setFooterVersionSize(rbx.AbsoluteSize)
+			end,
+		}),
+	})
+end
+
+return RojoFooter

plugin/src/Config.lua

@@ -1,7 +1,8 @@
 return {
-	pollingRate = 0.2,
-	version = {0, 4, 3},
-	expectedServerVersionString = "0.4.x",
-	protocolVersion = 1,
-	dev = false,
-}
+	codename = "Epiphany",
+	version = {0, 5, 0, "-alpha.12"},
+	expectedServerVersionString = "0.5.0 or newer",
+	protocolVersion = 2,
+	defaultHost = "localhost",
+	defaultPort = 34872,
+}

plugin/src/Config.spec.lua

@@ -1,7 +0,0 @@
-return function()
-	local Config = require(script.Parent.Config)
-
-	it("should have 'dev' disabled", function()
-		expect(Config.dev).to.equal(false)
-	end)
-end

plugin/src/DevSettings.lua

@@ -0,0 +1,127 @@
+local Config = require(script.Parent.Config)
+
+local Environment = {
+	User = "User",
+	Dev = "Dev",
+	Test = "Test",
+}
+
+local VALUES = {
+	LogLevel = {
+		type = "IntValue",
+		values = {
+			[Environment.User] = 2,
+			[Environment.Dev] = 3,
+			[Environment.Test] = 3,
+		},
+	},
+	TypecheckingEnabled = {
+		type = "BoolValue",
+		values = {
+			[Environment.User] = false,
+			[Environment.Dev] = true,
+			[Environment.Test] = true,
+		},
+	},
+}
+
+local CONTAINER_NAME = "RojoDevSettings" .. Config.codename
+
+local function getValueContainer()
+	return game:FindFirstChild(CONTAINER_NAME)
+end
+
+local valueContainer = getValueContainer()
+
+local function getStoredValue(name)
+	if valueContainer == nil then
+		return nil
+	end
+
+	local valueObject = valueContainer:FindFirstChild(name)
+
+	if valueObject == nil then
+		return nil
+	end
+
+	return valueObject.Value
+end
+
+local function setStoredValue(name, kind, value)
+	local object = valueContainer:FindFirstChild(name)
+
+	if object == nil then
+		object = Instance.new(kind)
+		object.Name = name
+		object.Parent = valueContainer
+	end
+
+	object.Value = value
+end
+
+local function createAllValues(environment)
+	assert(Environment[environment] ~= nil, "Invalid environment")
+
+	valueContainer = getValueContainer()
+
+	if valueContainer == nil then
+		valueContainer = Instance.new("Folder")
+		valueContainer.Name = CONTAINER_NAME
+		valueContainer.Parent = game
+	end
+
+	for name, value in pairs(VALUES) do
+		setStoredValue(name, value.type, value.values[environment])
+	end
+end
+
+local function getValue(name)
+	assert(VALUES[name] ~= nil, "Invalid DevSettings name")
+
+	local stored = getStoredValue(name)
+
+	if stored ~= nil then
+		return stored
+	end
+
+	return VALUES[name].values[Environment.User]
+end
+
+local DevSettings = {}
+
+function DevSettings:createDevSettings()
+	createAllValues(Environment.Dev)
+end
+
+function DevSettings:createTestSettings()
+	createAllValues(Environment.Test)
+end
+
+function DevSettings:hasChangedValues()
+	return valueContainer ~= nil
+end
+
+function DevSettings:resetValues()
+	if valueContainer then
+		valueContainer:Destroy()
+		valueContainer = nil
+	end
+end
+
+function DevSettings:isEnabled()
+	return valueContainer ~= nil
+end
+
+function DevSettings:getLogLevel()
+	return getValue("LogLevel")
+end
+
+function DevSettings:shouldTypecheck()
+	return getValue("TypecheckingEnabled")
+end
+
+function _G.ROJO_DEV_CREATE()
+	DevSettings:createDevSettings()
+end
+
+return DevSettings

plugin/src/Dictionary.lua

@@ -0,0 +1,33 @@
+--[[
+	This is a placeholder module waiting for Cryo to become available.
+]]
+
+local None = newproxy(true)
+getmetatable(None).__tostring = function()
+	return "None"
+end
+
+local function merge(...)
+	local output = {}
+
+	for i = 1, select("#", ...) do
+		local source = select(i, ...)
+
+		if source ~= nil then
+			for key, value in pairs(source) do
+				if value == None then
+					output[key] = nil
+				else
+					output[key] = value
+				end
+			end
+		end
+	end
+
+	return output
+end
+
+return {
+	None = None,
+	merge = merge,
+}

plugin/src/Http.lua

@@ -1,67 +1,75 @@
 local HttpService = game:GetService("HttpService")
 
-local HTTP_DEBUG = false
+local Promise = require(script.Parent.Parent.Promise)
 
-local Promise = require(script.Parent.Promise)
+local Logging = require(script.Parent.Logging)
 local HttpError = require(script.Parent.HttpError)
 local HttpResponse = require(script.Parent.HttpResponse)
 
-local function dprint(...)
-	if HTTP_DEBUG then
-		print(...)
-	end
-end
+local lastRequestId = 0
 
+-- TODO: Factor out into separate library, especially error handling
 local Http = {}
-Http.__index = Http
 
-function Http.new(baseUrl)
-	assert(type(baseUrl) == "string", "Http.new needs a baseUrl!")
+function Http.get(url)
+	local requestId = lastRequestId + 1
+	lastRequestId = requestId
 
-	local http = {
-		baseUrl = baseUrl
-	}
+	Logging.trace("GET(%d) %s", requestId, url)
 
-	setmetatable(http, Http)
-
-	return http
-end
-
-function Http:get(endpoint)
-	dprint("\nGET", endpoint)
 	return Promise.new(function(resolve, reject)
-		spawn(function()
-			local ok, result = pcall(function()
-				return HttpService:GetAsync(self.baseUrl .. endpoint, true)
+		coroutine.wrap(function()
+			local success, response = pcall(function()
+				return HttpService:RequestAsync({
+					Url = url,
+					Method = "GET",
+				})
 			end)
 
-			if ok then
-				dprint("\t", result, "\n")
-				resolve(HttpResponse.new(result))
+			if success then
+				Logging.trace("Request %d success: status code %s", requestId, response.StatusCode)
+				resolve(HttpResponse.fromRobloxResponse(response))
 			else
-				reject(HttpError.fromErrorString(result))
+				Logging.trace("Request %d failure: %s", requestId, response)
+				reject(HttpError.fromErrorString(response))
 			end
-		end)
+		end)()
 	end)
 end
 
-function Http:post(endpoint, body)
-	dprint("\nPOST", endpoint)
-	dprint(body)
+function Http.post(url, body)
+	local requestId = lastRequestId + 1
+	lastRequestId = requestId
+
+	Logging.trace("POST(%d) %s\n%s", requestId, url, body)
+
 	return Promise.new(function(resolve, reject)
-		spawn(function()
-			local ok, result = pcall(function()
-				return HttpService:PostAsync(self.baseUrl .. endpoint, body)
+		coroutine.wrap(function()
+			local success, response = pcall(function()
+				return HttpService:RequestAsync({
+					Url = url,
+					Method = "POST",
+					Body = body,
+				})
 			end)
 
-			if ok then
-				dprint("\t", result, "\n")
-				resolve(HttpResponse.new(result))
+			if success then
+				Logging.trace("Request %d success: status code %s", requestId, response.StatusCode)
+				resolve(HttpResponse.fromRobloxResponse(response))
 			else
-				reject(HttpError.fromErrorString(result))
+				Logging.trace("Request %d failure: %s", requestId, response)
+				reject(HttpError.fromErrorString(response))
 			end
-		end)
+		end)()
 	end)
 end
 
-return Http
+function Http.jsonEncode(object)
+	return HttpService:JSONEncode(object)
+end
+
+function Http.jsonDecode(source)
+	return HttpService:JSONDecode(source)
+end
+
+return Http

plugin/src/HttpError.lua

@@ -1,3 +1,5 @@
+local Logging = require(script.Parent.Logging)
+
 local HttpError = {}
 HttpError.__index = HttpError
 
@@ -7,14 +9,23 @@ HttpError.Error = {
 			"Check your game settings, located in the 'Home' tab of Studio.",
 	},
 	ConnectFailed = {
-		message = "Rojo plugin couldn't connect to the Rojo server.\n" ..
-			"Make sure the server is running -- use 'Rojo serve' to run it!",
+		message = "Couldn't connect to the Rojo server.\n" ..
+			"Make sure the server is running -- use 'rojo serve' to run it!",
+	},
+	Timeout = {
+		message = "Request timed out.",
 	},
 	Unknown = {
-		message = "Rojo encountered an unknown error: {{message}}",
+		message = "Unknown error: {{message}}",
 	},
 }
 
+setmetatable(HttpError.Error, {
+	__index = function(_, key)
+		error(("%q is not a valid member of HttpError.Error"):format(tostring(key)), 2)
+	end,
+})
+
 function HttpError.new(type, extraMessage)
 	extraMessage = extraMessage or ""
 	local message = type.message:gsub("{{message}}", extraMessage)
@@ -36,25 +47,26 @@ end
 --[[
 	This method shouldn't have to exist. Ugh.
 ]]
-function HttpError.fromErrorString(err)
-	err = err:lower()
+function HttpError.fromErrorString(message)
+	local lower = message:lower()
 
-	if err:find("^http requests are not enabled") then
+	if lower:find("^http requests are not enabled") then
 		return HttpError.new(HttpError.Error.HttpNotEnabled)
 	end
 
-	if err:find("^curl error") then
+	if lower:find("^httperror: timedout") then
+		return HttpError.new(HttpError.Error.Timeout)
+	end
+
+	if lower:find("^httperror: connectfail") then
 		return HttpError.new(HttpError.Error.ConnectFailed)
 	end
 
-	return HttpError.new(HttpError.Error.Unknown, err)
+	return HttpError.new(HttpError.Error.Unknown, message)
 end
 
 function HttpError:report()
-	warn(self.message)
-	if self.type == HttpError.Error.HttpNotEnabled then
-		game:GetService("Selection"):Set{game:GetService("HttpService")}
-	end
+	Logging.warn(self.message)
 end
 
-return HttpError
+return HttpError

plugin/src/HttpResponse.lua

@@ -1,20 +1,34 @@
 local HttpService = game:GetService("HttpService")
 
+local stringTemplate = [[
+HttpResponse {
+	code: %d
+	body: %s
+}]]
+
 local HttpResponse = {}
 HttpResponse.__index = HttpResponse
 
-function HttpResponse.new(body)
-	local response = {
-		body = body,
+function HttpResponse:__tostring()
+	return stringTemplate:format(self.code, self.body)
+end
+
+function HttpResponse.fromRobloxResponse(response)
+	local self = {
+		body = response.Body,
+		code = response.StatusCode,
+		headers = response.Headers,
 	}
 
-	setmetatable(response, HttpResponse)
+	return setmetatable(self, HttpResponse)
+end
 
-	return response
+function HttpResponse:isSuccess()
+	return self.code >= 200 and self.code < 300
 end
 
 function HttpResponse:json()
 	return HttpService:JSONDecode(self.body)
 end
 
-return HttpResponse
+return HttpResponse

plugin/src/InstanceMap.lua

@@ -0,0 +1,81 @@
+local Logging = require(script.Parent.Logging)
+
+--[[
+	A bidirectional map between instance IDs and Roblox instances. It lets us
+	keep track of every instance we know about.
+
+	TODO: Track ancestry to catch when stuff moves?
+]]
+local InstanceMap = {}
+InstanceMap.__index = InstanceMap
+
+function InstanceMap.new()
+	local self = {
+		fromIds = {},
+		fromInstances = {},
+	}
+
+	return setmetatable(self, InstanceMap)
+end
+
+function InstanceMap:insert(id, instance)
+	self.fromIds[id] = instance
+	self.fromInstances[instance] = id
+end
+
+function InstanceMap:removeId(id)
+	local instance = self.fromIds[id]
+
+	if instance ~= nil then
+		self.fromIds[id] = nil
+		self.fromInstances[instance] = nil
+	else
+		Logging.warn("Attempted to remove nonexistant ID %s", tostring(id))
+	end
+end
+
+function InstanceMap:removeInstance(instance)
+	local id = self.fromInstances[instance]
+
+	if id ~= nil then
+		self.fromInstances[instance] = nil
+		self.fromIds[id] = nil
+	else
+		Logging.warn("Attempted to remove nonexistant instance %s", tostring(instance))
+	end
+end
+
+function InstanceMap:destroyInstance(instance)
+	local id = self.fromInstances[instance]
+
+	if id ~= nil then
+		self:destroyId(id)
+	else
+		Logging.warn("Attempted to destroy untracked instance %s", tostring(instance))
+	end
+end
+
+function InstanceMap:destroyId(id)
+	local instance = self.fromIds[id]
+	self:removeId(id)
+
+	if instance ~= nil then
+		local descendantsToDestroy = {}
+
+		for otherInstance in pairs(self.fromInstances) do
+			if otherInstance:IsDescendantOf(instance) then
+				table.insert(descendantsToDestroy, otherInstance)
+			end
+		end
+
+		for _, otherInstance in ipairs(descendantsToDestroy) do
+			self:removeInstance(otherInstance)
+		end
+
+		instance:Destroy()
+	else
+		Logging.warn("Attempted to destroy nonexistant ID %s", tostring(id))
+	end
+end
+
+return InstanceMap

plugin/src/Logging.lua

@@ -0,0 +1,50 @@
+local DevSettings = require(script.Parent.DevSettings)
+
+local Level = {
+	Error = 0,
+	Warning = 1,
+	Info = 2,
+	Trace = 3,
+}
+
+local testLogLevel = nil
+
+local function getLogLevel()
+	if testLogLevel ~= nil then
+		return testLogLevel
+	end
+
+	return DevSettings:getLogLevel()
+end
+
+local function addTags(tag, message)
+	return tag .. message:gsub("\n", "\n" .. tag)
+end
+
+local INFO_TAG = (" "):rep(15) .. "[Rojo-Info] "
+local TRACE_TAG = (" "):rep(15) .. "[Rojo-Trace] "
+local WARN_TAG = "[Rojo-Warn] "
+
+local Log = {}
+
+Log.Level = Level
+
+function Log.trace(template, ...)
+	if getLogLevel() >= Level.Trace then
+		print(addTags(TRACE_TAG, string.format(template, ...)))
+	end
+end
+
+function Log.info(template, ...)
+	if getLogLevel() >= Level.Info then
+		print(addTags(INFO_TAG, string.format(template, ...)))
+	end
+end
+
+function Log.warn(template, ...)
+	if getLogLevel() >= Level.Warning then
+		warn(addTags(WARN_TAG, string.format(template, ...)))
+	end
+end
+
+return Log

plugin/src/Main.server.lua

@@ -1,79 +0,0 @@
-if not plugin then
-	return
-end
-
-local Plugin = require(script.Parent.Plugin)
-local Config = require(script.Parent.Config)
-local Version = require(script.Parent.Version)
-
---[[
-	Check if the user is using a newer version of Rojo than last time. If they
-	are, show them a reminder to make sure they check their server version.
-]]
-local function checkUpgrade()
-	-- When developing Rojo, there's no use in doing version checks
-	if Config.dev then
-		return
-	end
-
-	local lastVersion = plugin:GetSetting("LastRojoVersion")
-
-	if lastVersion then
-		local wasUpgraded = Version.compare(Config.version, lastVersion) == 1
-
-		if wasUpgraded then
-			local message = (
-				"\nRojo detected an upgrade from version %s to version %s." ..
-				"\nMake sure you have also upgraded your server!" ..
-				"\n\nRojo version %s is intended for use with server version %s.\n"
-			):format(
-				Version.display(lastVersion), Version.display(Config.version),
-				Version.display(Config.version), Config.expectedServerVersionString
-			)
-
-			print(message)
-		end
-	end
-
-	plugin:SetSetting("LastRojoVersion", Config.version)
-end
-
-local function main()
-	local pluginInstance = Plugin.new()
-
-	local displayedVersion = Config.dev and "DEV" or Version.display(Config.version)
-
-	local toolbar = plugin:CreateToolbar("Rojo Plugin " .. displayedVersion)
-
-	toolbar:CreateButton("Test Connection", "Connect to Rojo Server", "")
-		.Click:Connect(function()
-			checkUpgrade()
-
-			pluginInstance:connect()
-				:catch(function(err)
-					warn(err)
-				end)
-		end)
-
-	toolbar:CreateButton("Sync In", "Sync into Roblox Studio", "")
-		.Click:Connect(function()
-			checkUpgrade()
-
-			pluginInstance:syncIn()
-				:catch(function(err)
-					warn(err)
-				end)
-		end)
-
-	toolbar:CreateButton("Toggle Polling", "Poll server for changes", "")
-		.Click:Connect(function()
-			checkUpgrade()
-
-			pluginInstance:togglePolling()
-				:catch(function(err)
-					warn(err)
-				end)
-		end)
-end
-
-main()

plugin/src/Plugin.lua

@@ -1,253 +0,0 @@
-local Config = require(script.Parent.Config)
-local Http = require(script.Parent.Http)
-local Api = require(script.Parent.Api)
-local Promise = require(script.Parent.Promise)
-local Reconciler = require(script.Parent.Reconciler)
-
-local function collectMatch(source, pattern)
-	local result = {}
-
-	for match in source:gmatch(pattern) do
-		table.insert(result, match)
-	end
-
-	return result
-end
-
-local Plugin = {}
-Plugin.__index = Plugin
-
-function Plugin.new()
-	local address = "localhost"
-	local port = Config.dev and 8001 or 8000
-
-	local remote = ("http://%s:%d"):format(address, port)
-
-	local self = {
-		_http = Http.new(remote),
-		_reconciler = Reconciler.new(),
-		_api = nil,
-		_polling = false,
-	}
-
-	setmetatable(self, Plugin)
-
-	do
-		local screenGui = Instance.new("ScreenGui")
-		screenGui.Name = "Rojo UI"
-		screenGui.Parent = game.CoreGui
-		screenGui.DisplayOrder = -1
-		screenGui.Enabled = false
-
-		local label = Instance.new("TextLabel")
-		label.Font = Enum.Font.SourceSans
-		label.TextSize = 20
-		label.Text = "Rojo polling..."
-		label.BackgroundColor3 = Color3.fromRGB(31, 31, 31)
-		label.BackgroundTransparency = 0.5
-		label.BorderSizePixel = 0
-		label.TextColor3 = Color3.new(1, 1, 1)
-		label.Size = UDim2.new(0, 120, 0, 28)
-		label.Position = UDim2.new(0, 0, 0, 0)
-		label.Parent = screenGui
-
-		self._label = screenGui
-	end
-
-	return self
-end
-
---[[
-	Clears all state and issues a notice to the user that the plugin has
-	restarted.
-]]
-function Plugin:restart()
-	warn("The server has changed since the last request, reloading plugin...")
-
-	self._reconciler:clear()
-	self._api = nil
-	self._polling = false
-end
-
-function Plugin:api()
-	if not self._api then
-		self._api = Api.connect(self._http)
-			:catch(function(err)
-				self._api = nil
-				return Promise.reject(err)
-			end)
-	end
-
-	return self._api
-end
-
-function Plugin:connect()
-	print("Testing connection...")
-
-	return self:api()
-		:andThen(function(api)
-			local ok, info = api:getInfo():await()
-
-			if not ok then
-				return Promise.reject(info)
-			end
-
-			print("Server found!")
-			print("Protocol version:", info.protocolVersion)
-			print("Server version:", info.serverVersion)
-		end)
-		:catch(function(err)
-			if err == Api.Error.ServerIdMismatch then
-				self:restart()
-				return self:connect()
-			else
-				return Promise.reject(err)
-			end
-		end)
-end
-
-function Plugin:togglePolling()
-	if self._polling then
-		return self:stopPolling()
-	else
-		return self:startPolling()
-	end
-end
-
-function Plugin:stopPolling()
-	if not self._polling then
-		return Promise.resolve(false)
-	end
-
-	print("Stopped polling.")
-
-	self._polling = false
-	self._label.Enabled = false
-
-	return Promise.resolve(true)
-end
-
-function Plugin:_pull(api, project, routes)
-	return api:read(routes)
-		:andThen(function(items)
-			for index = 1, #routes do
-				local itemRoute = routes[index]
-				local partitionName = itemRoute[1]
-				local partition = project.partitions[partitionName]
-				local item = items[index]
-
-				local partitionRoute = collectMatch(partition.target, "[^.]+")
-
-				-- If the item route's length was 1, we need to rename the instance to
-				-- line up with the partition's root object name.
-				--
-				-- This is a HACK!
-				if #itemRoute == 1 then
-					if item then
-						local objectName = partition.target:match("[^.]+$")
-						item.Name = objectName
-					end
-				end
-
-				local fullRoute = {}
-				for _, piece in ipairs(partitionRoute) do
-					table.insert(fullRoute, piece)
-				end
-
-				for i = 2, #itemRoute do
-					table.insert(fullRoute, itemRoute[i])
-				end
-
-				self._reconciler:reconcileRoute(fullRoute, item, itemRoute)
-			end
-		end)
-end
-
-function Plugin:startPolling()
-	if self._polling then
-		return
-	end
-
-	print("Starting to poll...")
-
-	self._polling = true
-	self._label.Enabled = true
-
-	return self:api()
-		:andThen(function(api)
-			local syncOk, result = self:syncIn():await()
-
-			if not syncOk then
-				return Promise.reject(result)
-			end
-
-			local infoOk, info = api:getInfo():await()
-
-			if not infoOk then
-				return Promise.reject(info)
-			end
-
-			while self._polling do
-				local changes = api:getChanges():await()
-
-				if #changes > 0 then
-					local routes = {}
-
-					for _, change in ipairs(changes) do
-						table.insert(routes, change.route)
-					end
-
-					local pullOk, pullResult = self:_pull(api, info.project, routes):await()
-
-					if not pullOk then
-						return Promise.reject(pullResult)
-					end
-				end
-
-				wait(Config.pollingRate)
-			end
-		end)
-		:catch(function(err)
-			self:stopPolling()
-
-			if err == Api.Error.ServerIdMismatch then
-				self:restart()
-				return self:startPolling()
-			else
-				return Promise.reject(err)
-			end
-		end)
-end
-
-function Plugin:syncIn()
-	print("Syncing from server...")
-
-	return self:api()
-		:andThen(function(api)
-			local ok, info = api:getInfo():await()
-
-			if not ok then
-				return Promise.reject(info)
-			end
-
-			local routes = {}
-
-			for name in pairs(info.project.partitions) do
-				table.insert(routes, {name})
-			end
-
-			self:_pull(api, info.project, routes)
-
-			print("Sync successful!")
-		end)
-		:catch(function(err)
-			if err == Api.Error.ServerIdMismatch then
-				self:restart()
-				return self:syncIn()
-			else
-				return Promise.reject(err)
-			end
-		end)
-end
-
-return Plugin

plugin/src/Promise.lua

@@ -1,307 +0,0 @@
---[[
-	An implementation of Promises similar to Promise/A+.
-]]
-
-local PROMISE_DEBUG = false
-
--- If promise debugging is on, use a version of pcall that warns on failure.
--- This is useful for finding errors that happen within Promise itself.
-local wpcall
-if PROMISE_DEBUG then
-	wpcall = function(f, ...)
-		local result = { pcall(f, ...) }
-
-		if not result[1] then
-			warn(result[2])
-		end
-
-		return unpack(result)
-	end
-else
-	wpcall = pcall
-end
-
---[[
-	Creates a function that invokes a callback with correct error handling and
-	resolution mechanisms.
-]]
-local function createAdvancer(callback, resolve, reject)
-	return function(...)
-		local result = { wpcall(callback, ...) }
-		local ok = table.remove(result, 1)
-
-		if ok then
-			resolve(unpack(result))
-		else
-			reject(unpack(result))
-		end
-	end
-end
-
-local function isEmpty(t)
-	return next(t) == nil
-end
-
-local Promise = {}
-Promise.__index = Promise
-
-Promise.Status = {
-	Started = "Started",
-	Resolved = "Resolved",
-	Rejected = "Rejected",
-}
-
---[[
-	Constructs a new Promise with the given initializing callback.
-
-	This is generally only called when directly wrapping a non-promise API into
-	a promise-based version.
-
-	The callback will receive 'resolve' and 'reject' methods, used to start
-	invoking the promise chain.
-
-	For example:
-
-		local function get(url)
-			return Promise.new(function(resolve, reject)
-				spawn(function()
-					resolve(HttpService:GetAsync(url))
-				end)
-			end)
-		end
-
-		get("https://google.com")
-			:andThen(function(stuff)
-				print("Got some stuff!", stuff)
-			end)
-]]
-function Promise.new(callback)
-	local promise = {
-		-- Used to locate where a promise was created
-		_source = debug.traceback(),
-
-		-- A tag to identify us as a promise
-		_type = "Promise",
-
-		_status = Promise.Status.Started,
-
-		-- A table containing a list of all results, whether success or failure.
-		-- Only valid if _status is set to something besides Started
-		_value = nil,
-
-		-- If an error occurs with no observers, this will be set.
-		_unhandledRejection = false,
-
-		-- Queues representing functions we should invoke when we update!
-		_queuedResolve = {},
-		_queuedReject = {},
-	}
-
-	setmetatable(promise, Promise)
-
-	local function resolve(...)
-		promise:_resolve(...)
-	end
-
-	local function reject(...)
-		promise:_reject(...)
-	end
-
-	local ok, err = wpcall(callback, resolve, reject)
-
-	if not ok and promise._status == Promise.Status.Started then
-		reject(err)
-	end
-
-	return promise
-end
-
---[[
-	Create a promise that represents the immediately resolved value.
-]]
-function Promise.resolve(value)
-	return Promise.new(function(resolve)
-		resolve(value)
-	end)
-end
-
---[[
-	Create a promise that represents the immediately rejected value.
-]]
-function Promise.reject(value)
-	return Promise.new(function(_, reject)
-		reject(value)
-	end)
-end
-
---[[
-	Returns a new promise that:
-		* is resolved when all input promises resolve
-		* is rejected if ANY input promises reject
-]]
-function Promise.all(...)
-	error("unimplemented", 2)
-end
-
---[[
-	Is the given object a Promise instance?
-]]
-function Promise.is(object)
-	if type(object) ~= "table" then
-		return false
-	end
-
-	return object._type == "Promise"
-end
-
---[[
-	Creates a new promise that receives the result of this promise.
-
-	The given callbacks are invoked depending on that result.
-]]
-function Promise:andThen(successHandler, failureHandler)
-	self._unhandledRejection = false
-
-	-- Create a new promise to follow this part of the chain
-	return Promise.new(function(resolve, reject)
-		-- Our default callbacks just pass values onto the next promise.
-		-- This lets success and failure cascade correctly!
-
-		local successCallback = resolve
-		if successHandler then
-			successCallback = createAdvancer(successHandler, resolve, reject)
-		end
-
-		local failureCallback = reject
-		if failureHandler then
-			failureCallback = createAdvancer(failureHandler, resolve, reject)
-		end
-
-		if self._status == Promise.Status.Started then
-			-- If we haven't resolved yet, put ourselves into the queue
-			table.insert(self._queuedResolve, successCallback)
-			table.insert(self._queuedReject, failureCallback)
-		elseif self._status == Promise.Status.Resolved then
-			-- This promise has already resolved! Trigger success immediately.
-			successCallback(unpack(self._value))
-		elseif self._status == Promise.Status.Rejected then
-			-- This promise died a terrible death! Trigger failure immediately.
-			failureCallback(unpack(self._value))
-		end
-	end)
-end
-
---[[
-	Used to catch any errors that may have occurred in the promise.
-]]
-function Promise:catch(failureCallback)
-	return self:andThen(nil, failureCallback)
-end
-
---[[
-	Yield until the promise is completed.
-
-	This matches the execution model of normal Roblox functions.
-]]
-function Promise:await()
-	self._unhandledRejection = false
-
-	if self._status == Promise.Status.Started then
-		local result
-		local bindable = Instance.new("BindableEvent")
-
-		self:andThen(function(...)
-			result = {...}
-			bindable:Fire(true)
-		end, function(...)
-			result = {...}
-			bindable:Fire(false)
-		end)
-
-		local ok = bindable.Event:Wait()
-		bindable:Destroy()
-
-		return ok, unpack(result)
-	elseif self._status == Promise.Status.Resolved then
-		return true, unpack(self._value)
-	elseif self._status == Promise.Status.Rejected then
-		return false, unpack(self._value)
-	end
-end
-
-function Promise:_resolve(...)
-	if self._status ~= Promise.Status.Started then
-		return
-	end
-
-	-- If the resolved value was a Promise, we chain onto it!
-	if Promise.is((...)) then
-		-- Without this warning, arguments sometimes mysteriously disappear
-		if select("#", ...) > 1 then
-			local message = (
-				"When returning a Promise from andThen, extra arguments are " ..
-				"discarded! See:\n\n%s"
-			):format(
-				self._source
-			)
-			warn(message)
-		end
-
-		(...):andThen(function(...)
-			self:_resolve(...)
-		end, function(...)
-			self:_reject(...)
-		end)
-
-		return
-	end
-
-	self._status = Promise.Status.Resolved
-	self._value = {...}
-
-	-- We assume that these callbacks will not throw errors.
-	for _, callback in ipairs(self._queuedResolve) do
-		callback(...)
-	end
-end
-
-function Promise:_reject(...)
-	if self._status ~= Promise.Status.Started then
-		return
-	end
-
-	self._status = Promise.Status.Rejected
-	self._value = {...}
-
-	-- If there are any rejection handlers, call those!
-	if not isEmpty(self._queuedReject) then
-		-- We assume that these callbacks will not throw errors.
-		for _, callback in ipairs(self._queuedReject) do
-			callback(...)
-		end
-	else
-		-- At this point, no one was able to observe the error.
-		-- An error handler might still be attached if the error occurred
-		-- synchronously. We'll wait one tick, and if there are still no
-		-- observers, then we should put a message in the console.
-
-		self._unhandledRejection = true
-		local err = tostring((...))
-
-		spawn(function()
-			-- Someone observed the error, hooray!
-			if not self._unhandledRejection then
-				return
-			end
-
-			-- Build a reasonable message
-			local message = ("Unhandled promise rejection:\n\n%s\n\n%s"):format(
-				err,
-				self._source
-			)
-			warn(message)
-		end)
-	end
-end
-
-return Promise

plugin/src/Promise.spec.lua

@@ -1,262 +0,0 @@
-return function()
-	local Promise = require(script.Parent.Promise)
-
-	describe("Promise.new", function()
-		it("should instantiate with a callback", function()
-			local promise = Promise.new(function() end)
-
-			expect(promise).to.be.ok()
-		end)
-
-		it("should invoke the given callback with resolve and reject", function()
-			local callCount = 0
-			local resolveArg
-			local rejectArg
-
-			local promise = Promise.new(function(resolve, reject)
-				callCount = callCount + 1
-				resolveArg = resolve
-				rejectArg = reject
-			end)
-
-			expect(promise).to.be.ok()
-
-			expect(callCount).to.equal(1)
-			expect(resolveArg).to.be.a("function")
-			expect(rejectArg).to.be.a("function")
-			expect(promise._status).to.equal(Promise.Status.Started)
-		end)
-
-		it("should resolve promises on resolve()", function()
-			local callCount = 0
-
-			local promise = Promise.new(function(resolve)
-				callCount = callCount + 1
-				resolve()
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Resolved)
-		end)
-
-		it("should reject promises on reject()", function()
-			local callCount = 0
-
-			local promise = Promise.new(function(resolve, reject)
-				callCount = callCount + 1
-				reject()
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-		end)
-
-		it("should reject on error in callback", function()
-			local callCount = 0
-
-			local promise = Promise.new(function()
-				callCount = callCount + 1
-				error("hahah")
-			end)
-
-			expect(promise).to.be.ok()
-			expect(callCount).to.equal(1)
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]:find("hahah")).to.be.ok()
-		end)
-	end)
-
-	describe("Promise.resolve", function()
-		it("should immediately resolve with a value", function()
-			local promise = Promise.resolve(5)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Resolved)
-			expect(promise._value[1]).to.equal(5)
-		end)
-
-		it("should chain onto passed promises", function()
-			local promise = Promise.resolve(Promise.new(function(_, reject)
-				reject(7)
-			end))
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]).to.equal(7)
-		end)
-	end)
-
-	describe("Promise.reject", function()
-		it("should immediately reject with a value", function()
-			local promise = Promise.reject(6)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]).to.equal(6)
-		end)
-
-		it("should pass a promise as-is as an error", function()
-			local innerPromise = Promise.new(function(resolve)
-				resolve(6)
-			end)
-
-			local promise = Promise.reject(innerPromise)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]).to.equal(innerPromise)
-		end)
-	end)
-
-	describe("Promise:andThen", function()
-		it("should chain onto resolved promises", function()
-			local args
-			local argsLength
-			local callCount = 0
-			local badCallCount = 0
-
-			local promise = Promise.resolve(5)
-
-			local chained = promise
-				:andThen(function(...)
-					args = {...}
-					argsLength = select("#", ...)
-					callCount = callCount + 1
-				end, function()
-					badCallCount = badCallCount + 1
-				end)
-
-			expect(badCallCount).to.equal(0)
-
-			expect(callCount).to.equal(1)
-			expect(argsLength).to.equal(1)
-			expect(args[1]).to.equal(5)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Resolved)
-			expect(promise._value[1]).to.equal(5)
-
-			expect(chained).to.be.ok()
-			expect(chained).never.to.equal(promise)
-			expect(chained._status).to.equal(Promise.Status.Resolved)
-			expect(#chained._value).to.equal(0)
-		end)
-
-		it("should chain onto rejected promises", function()
-			local args
-			local argsLength
-			local callCount = 0
-			local badCallCount = 0
-
-			local promise = Promise.reject(5)
-
-			local chained = promise
-				:andThen(function(...)
-					badCallCount = badCallCount + 1
-				end, function(...)
-					args = {...}
-					argsLength = select("#", ...)
-					callCount = callCount + 1
-				end)
-
-			expect(badCallCount).to.equal(0)
-
-			expect(callCount).to.equal(1)
-			expect(argsLength).to.equal(1)
-			expect(args[1]).to.equal(5)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]).to.equal(5)
-
-			expect(chained).to.be.ok()
-			expect(chained).never.to.equal(promise)
-			expect(chained._status).to.equal(Promise.Status.Resolved)
-			expect(#chained._value).to.equal(0)
-		end)
-
-		it("should chain onto asynchronously resolved promises", function()
-			local args
-			local argsLength
-			local callCount = 0
-			local badCallCount = 0
-
-			local startResolution
-			local promise = Promise.new(function(resolve)
-				startResolution = resolve
-			end)
-
-			local chained = promise
-				:andThen(function(...)
-					args = {...}
-					argsLength = select("#", ...)
-					callCount = callCount + 1
-				end, function()
-					badCallCount = badCallCount + 1
-				end)
-
-			expect(callCount).to.equal(0)
-			expect(badCallCount).to.equal(0)
-
-			startResolution(6)
-
-			expect(badCallCount).to.equal(0)
-
-			expect(callCount).to.equal(1)
-			expect(argsLength).to.equal(1)
-			expect(args[1]).to.equal(6)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Resolved)
-			expect(promise._value[1]).to.equal(6)
-
-			expect(chained).to.be.ok()
-			expect(chained).never.to.equal(promise)
-			expect(chained._status).to.equal(Promise.Status.Resolved)
-			expect(#chained._value).to.equal(0)
-		end)
-
-		it("should chain onto asynchronously rejected promises", function()
-			local args
-			local argsLength
-			local callCount = 0
-			local badCallCount = 0
-
-			local startResolution
-			local promise = Promise.new(function(_, reject)
-				startResolution = reject
-			end)
-
-			local chained = promise
-				:andThen(function()
-					badCallCount = badCallCount + 1
-				end, function(...)
-					args = {...}
-					argsLength = select("#", ...)
-					callCount = callCount + 1
-				end)
-
-			expect(callCount).to.equal(0)
-			expect(badCallCount).to.equal(0)
-
-			startResolution(6)
-
-			expect(badCallCount).to.equal(0)
-
-			expect(callCount).to.equal(1)
-			expect(argsLength).to.equal(1)
-			expect(args[1]).to.equal(6)
-
-			expect(promise).to.be.ok()
-			expect(promise._status).to.equal(Promise.Status.Rejected)
-			expect(promise._value[1]).to.equal(6)
-
-			expect(chained).to.be.ok()
-			expect(chained).never.to.equal(promise)
-			expect(chained._status).to.equal(Promise.Status.Resolved)
-			expect(#chained._value).to.equal(0)
-		end)
-	end)
-end

plugin/src/Reconciler.lua

@@ -1,214 +1,222 @@
-local RouteMap = require(script.Parent.RouteMap)
+local t = require(script.Parent.Parent.t)
 
-local function classEqual(rbx, className)
-	if className == "*" then
-		return true
-	end
+local InstanceMap = require(script.Parent.InstanceMap)
+local Logging = require(script.Parent.Logging)
+local setCanonicalProperty = require(script.Parent.setCanonicalProperty)
+local rojoValueToRobloxValue = require(script.Parent.rojoValueToRobloxValue)
+local Types = require(script.Parent.Types)
 
-	return rbx.ClassName == className
-end
-
-local function reparent(rbx, parent)
-	if rbx then
-		-- It's possible that 'rbx' is a service or some other object that we
-		-- can't change the parent of. That's the only reason why Parent would
-		-- fail except for rbx being previously destroyed!
-		pcall(function()
-			rbx.Parent = parent
-		end)
-	end
-end
-
---[[
-	Attempts to match up Roblox instances and object specifiers for
-	reconciliation.
-
-	An object is considered a match if they have the same Name and ClassName.
-
-	primaryChildren and secondaryChildren can each be either a list of Roblox
-	instances or object specifiers. Since they share a common shape, switching
-	the two around isn't problematic!
-
-	visited is expected to be an empty table initially. It will be filled with
-	the set of children that have been visited so far.
-]]
-local function findNextChildPair(primaryChildren, secondaryChildren, visited)
-	for _, primaryChild in ipairs(primaryChildren) do
-		if not visited[primaryChild] then
-			visited[primaryChild] = true
-
-			for _, secondaryChild in ipairs(secondaryChildren) do
-				if primaryChild.ClassName == secondaryChild.ClassName and primaryChild.Name == secondaryChild.Name then
-					visited[secondaryChild] = true
-
-					return primaryChild, secondaryChild
-				end
-			end
-
-			return primaryChild, nil
-		end
-	end
-
-	return nil, nil
+local function setParent(instance, newParent)
+	pcall(function()
+		instance.Parent = newParent
+	end)
 end
 
 local Reconciler = {}
 Reconciler.__index = Reconciler
 
 function Reconciler.new()
-	local reconciler = {
-		_routeMap = RouteMap.new(),
+	local self = {
+		instanceMap = InstanceMap.new(),
 	}
 
-	setmetatable(reconciler, Reconciler)
-
-	return reconciler
+	return setmetatable(self, Reconciler)
 end
 
+function Reconciler:applyUpdate(requestedIds, virtualInstancesById)
+	-- This function may eventually be asynchronous; it will require calls to
+	-- the server to resolve instances that don't exist yet.
+	local visitedIds = {}
+
+	for _, id in ipairs(requestedIds) do
+		self:__applyUpdatePiece(id, visitedIds, virtualInstancesById)
+	end
+end
+
+local reconcileSchema = Types.ifEnabled(t.tuple(
+	t.map(t.string, Types.VirtualInstance),
+	t.string,
+	t.Instance
+))
 --[[
-	A semi-smart algorithm that attempts to apply the given item's children to
-	an existing Roblox object.
+	Update an existing instance, including its properties and children, to match
+	the given information.
 ]]
-function Reconciler:_reconcileChildren(rbx, item)
-	local visited = {}
-	local rbxChildren = rbx:GetChildren()
+function Reconciler:reconcile(virtualInstancesById, id, instance)
+	assert(reconcileSchema(virtualInstancesById, id, instance))
 
-	-- Reconcile any children that were added or updated
-	while true do
-		local itemChild, rbxChild = findNextChildPair(item.Children, rbxChildren, visited)
+	local virtualInstance = virtualInstancesById[id]
 
-		if not itemChild then
-			break
-		end
-
-		reparent(self:reconcile(rbxChild, itemChild), rbx)
+	-- If an instance changes ClassName, we assume it's very different. That's
+	-- not always the case!
+	if virtualInstance.ClassName ~= instance.ClassName then
+		-- TODO: Preserve existing children instead?
+		local parent = instance.Parent
+		self.instanceMap:destroyId(id)
+		return self:__reify(virtualInstancesById, id, parent)
 	end
 
-	-- Reconcile any children that were deleted
-	while true do
-		local rbxChild, itemChild = findNextChildPair(rbxChildren, item.Children, visited)
+	self.instanceMap:insert(id, instance)
 
-		if not rbxChild then
-			break
+	-- Some instances don't like being named, even if their name already matches
+	setCanonicalProperty(instance, "Name", virtualInstance.Name)
+
+	for key, value in pairs(virtualInstance.Properties) do
+		setCanonicalProperty(instance, key, rojoValueToRobloxValue(value))
+	end
+
+	local existingChildren = instance:GetChildren()
+
+	local unvisitedExistingChildren = {}
+	for _, child in ipairs(existingChildren) do
+		unvisitedExistingChildren[child] = true
+	end
+
+	for _, childId in ipairs(virtualInstance.Children) do
+		local childData = virtualInstancesById[childId]
+
+		local existingChildInstance
+		for instance in pairs(unvisitedExistingChildren) do
+			local ok, name, className = pcall(function()
+				return instance.Name, instance.ClassName
+			end)
+
+			if ok then
+				if name == childData.Name and className == childData.ClassName then
+					existingChildInstance = instance
+					break
+				end
+			end
 		end
 
-		reparent(self:reconcile(rbxChild, itemChild), rbx)
+		if existingChildInstance ~= nil then
+			unvisitedExistingChildren[existingChildInstance] = nil
+			self:reconcile(virtualInstancesById, childId, existingChildInstance)
+		else
+			self:__reify(virtualInstancesById, childId, instance)
+		end
+	end
+
+	local shouldClearUnknown = self:__shouldClearUnknownChildren(virtualInstance)
+
+	for existingChildInstance in pairs(unvisitedExistingChildren) do
+		local childId = self.instanceMap.fromInstances[existingChildInstance]
+
+		if childId == nil then
+			if shouldClearUnknown then
+				existingChildInstance:Destroy()
+			end
+		else
+			self.instanceMap:destroyInstance(existingChildInstance)
+		end
+	end
+
+	-- The root instance of a project won't have a parent, like the DataModel,
+	-- so we need to be careful here.
+	if virtualInstance.Parent ~= nil then
+		local parent = self.instanceMap.fromIds[virtualInstance.Parent]
+
+		if parent == nil then
+			Logging.info("Instance %s wanted parent of %s", tostring(id), tostring(virtualInstance.Parent))
+			error("Rojo bug: During reconciliation, an instance referred to an instance ID as parent that does not exist.")
+		end
+
+		-- Some instances, like services, don't like having their Parent
+		-- property poked, even if we're setting it to the same value.
+		setParent(instance, parent)
+	end
+
+	return instance
+end
+
+function Reconciler:__shouldClearUnknownChildren(virtualInstance)
+	if virtualInstance.Metadata ~= nil then
+		return not virtualInstance.Metadata.ignoreUnknownInstances
+	else
+		return true
 	end
 end
 
---[[
-	Construct a new Roblox object from the given item.
-]]
-function Reconciler:_reify(item)
-	local className = item.ClassName
+local reifySchema = Types.ifEnabled(t.tuple(
+	t.map(t.string, Types.VirtualInstance),
+	t.string,
+	t.Instance
+))
 
-	-- "*" represents a match of any class. It reifies as a folder!
-	if className == "*" then
-		className = "Folder"
+function Reconciler:__reify(virtualInstancesById, id, parent)
+	assert(reifySchema(virtualInstancesById, id, parent))
+
+	local virtualInstance = virtualInstancesById[id]
+
+	local instance = Instance.new(virtualInstance.ClassName)
+
+	for key, value in pairs(virtualInstance.Properties) do
+		setCanonicalProperty(instance, key, rojoValueToRobloxValue(value))
 	end
 
-	local rbx = Instance.new(className)
-	rbx.Name = item.Name
+	setCanonicalProperty(instance, "Name", virtualInstance.Name)
 
-	for key, property in pairs(item.Properties) do
-		-- TODO: Check for compound types, like Vector3!
-		rbx[key] = property.Value
+	for _, childId in ipairs(virtualInstance.Children) do
+		self:__reify(virtualInstancesById, childId, instance)
 	end
 
-	self:_reconcileChildren(rbx, item)
+	setParent(instance, parent)
+	self.instanceMap:insert(id, instance)
 
-	if item.Route then
-		self._routeMap:insert(item.Route, rbx)
-	end
-
-	return rbx
+	return instance
 end
 
---[[
-	Clears any state that the Reconciler has, effectively restarting it.
-]]
-function Reconciler:clear()
-	self._routeMap:clear()
-end
+local applyUpdatePieceSchema = Types.ifEnabled(t.tuple(
+	t.string,
+	t.map(t.string, t.boolean),
+	t.map(t.string, Types.VirtualInstance)
+))
 
---[[
-	Apply the changes represented by the given item to a Roblox object that's a
-	child of the given instance.
-]]
-function Reconciler:reconcile(rbx, item)
-	-- Item was deleted
-	if not item then
-		if rbx then
-			rbx:Destroy()
+function Reconciler:__applyUpdatePiece(id, visitedIds, virtualInstancesById)
+	assert(applyUpdatePieceSchema(id, visitedIds, virtualInstancesById))
+
+	if visitedIds[id] then
+		return
+	end
+
+	visitedIds[id] = true
+
+	local virtualInstance = virtualInstancesById[id]
+	local instance = self.instanceMap.fromIds[id]
+
+	-- The instance was deleted in this update
+	if virtualInstance == nil then
+		self.instanceMap:destroyId(id)
+		return
+	end
+
+	-- An instance we know about was updated
+	if instance ~= nil then
+		self:reconcile(virtualInstancesById, id, instance)
+		return instance
+	end
+
+	-- If the instance's parent already exists, we can stick it there
+	local parentInstance = self.instanceMap.fromIds[virtualInstance.Parent]
+	if parentInstance ~= nil then
+		self:__reify(virtualInstancesById, id, parentInstance)
+		return
+	end
+
+	-- Otherwise, we can check if this response payload contained the parent and
+	-- work from there instead.
+	local parentData = virtualInstancesById[virtualInstance.Parent]
+	if parentData ~= nil then
+		if visitedIds[virtualInstance.Parent] then
+			error("Rojo bug: An instance was present and marked as visited but its instance was missing")
 		end
 
-		return nil
+		self:__applyUpdatePiece(virtualInstance.Parent, visitedIds, virtualInstancesById)
+		return
 	end
 
-	-- Item was created!
-	if not rbx then
-		return self:_reify(item)
-	end
-
-	-- Item changed type!
-	if not classEqual(rbx, item.ClassName) then
-		rbx:Destroy()
-
-		rbx = self:_reify(item)
-	end
-
-	-- Apply all properties, Roblox will de-duplicate changes
-	for key, property in pairs(item.Properties) do
-		-- TODO: Transform property value based on property.Type
-		-- Right now, we assume that 'value' is primitive!
-
-		rbx[key] = property.Value
-	end
-
-	-- Use a dumb algorithm for reconciling children
-	self:_reconcileChildren(rbx, item)
-
-	if item.Route then
-		self._routeMap:insert(item.Route, rbx)
-	end
-
-	return rbx
+	Logging.trace("Instance ID %s, parent ID %s", tostring(id), tostring(virtualInstance.Parent))
+	error("Rojo NYI: Instances with parents that weren't mentioned in an update payload")
 end
 
-function Reconciler:reconcileRoute(route, item, itemRoute)
-	local parent
-	local rbx = game
-
-	for i = 1, #route do
-		local piece = route[i]
-
-		local child = rbx:FindFirstChild(piece)
-
-		-- We should get services instead of making folders here.
-		if rbx == game and not child then
-			local _
-			_, child = pcall(game.GetService, game, piece)
-		end
-
-		-- We don't want to create a folder if we're reaching our target item!
-		if not child and i ~= #route then
-			child = Instance.new("Folder")
-			child.Parent = rbx
-			child.Name = piece
-		end
-
-		parent = rbx
-		rbx = child
-	end
-
-	-- Let's check the route map!
-	if not rbx then
-		rbx = self._routeMap:get(itemRoute)
-	end
-
-	rbx = self:reconcile(rbx, item)
-
-	reparent(rbx, parent)
-end
-
-return Reconciler
+return Reconciler

plugin/src/Reconciler.spec.lua

@@ -0,0 +1,218 @@
+local Reconciler = require(script.Parent.Reconciler)
+
+return function()
+	it("should leave instances alone if there's nothing specified", function()
+		local instance = Instance.new("Folder")
+		instance.Name = "TestFolder"
+
+		local instanceId = "test-id"
+		local virtualInstancesById = {
+			[instanceId] = {
+				Name = "TestFolder",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+		}
+
+		local reconciler = Reconciler.new()
+		reconciler:reconcile(virtualInstancesById, instanceId, instance)
+	end)
+
+	it("should assign names from virtual instances", function()
+		local instance = Instance.new("Folder")
+		instance.Name = "InitialName"
+
+		local instanceId = "test-id"
+		local virtualInstancesById = {
+			[instanceId] = {
+				Name = "NewName",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+		}
+
+		local reconciler = Reconciler.new()
+		reconciler:reconcile(virtualInstancesById, instanceId, instance)
+
+		expect(instance.Name).to.equal("NewName")
+	end)
+
+	it("should assign properties from virtual instances", function()
+		local instance = Instance.new("IntValue")
+		instance.Name = "TestValue"
+		instance.Value = 5
+
+		local instanceId = "test-id"
+		local virtualInstancesById = {
+			[instanceId] = {
+				Name = "TestValue",
+				ClassName = "IntValue",
+				Children = {},
+				Properties = {
+					Value = {
+						Type = "Int32",
+						Value = 9
+					}
+				},
+			},
+		}
+
+		local reconciler = Reconciler.new()
+		reconciler:reconcile(virtualInstancesById, instanceId, instance)
+
+		expect(instance.Value).to.equal(9)
+	end)
+
+	it("should wipe unknown children by default", function()
+		local parent = Instance.new("Folder")
+		parent.Name = "Parent"
+
+		local child = Instance.new("Folder")
+		child.Name = "Child"
+
+		local parentId = "test-id"
+		local virtualInstancesById = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+		}
+
+		local reconciler = Reconciler.new()
+		reconciler:reconcile(virtualInstancesById, parentId, parent)
+
+		expect(#parent:GetChildren()).to.equal(0)
+	end)
+
+	it("should preserve unknown children if ignoreUnknownInstances is set", function()
+		local parent = Instance.new("Folder")
+		parent.Name = "Parent"
+
+		local child = Instance.new("Folder")
+		child.Parent = parent
+		child.Name = "Child"
+
+		local parentId = "test-id"
+		local virtualInstancesById = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+				Metadata = {
+					ignoreUnknownInstances = true,
+				},
+			},
+		}
+
+		local reconciler = Reconciler.new()
+		reconciler:reconcile(virtualInstancesById, parentId, parent)
+
+		expect(child.Parent).to.equal(parent)
+		expect(#parent:GetChildren()).to.equal(1)
+	end)
+
+	it("should remove known removed children", function()
+		local parent = Instance.new("Folder")
+		parent.Name = "Parent"
+
+		local child = Instance.new("Folder")
+		child.Parent = parent
+		child.Name = "Child"
+
+		local parentId = "parent-id"
+		local childId = "child-id"
+
+		local reconciler = Reconciler.new()
+
+		local virtualInstancesById = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {childId},
+				Properties = {},
+			},
+			[childId] = {
+				Name = "Child",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+		}
+		reconciler:reconcile(virtualInstancesById, parentId, parent)
+
+		expect(child.Parent).to.equal(parent)
+		expect(#parent:GetChildren()).to.equal(1)
+
+		local newVirtualInstances = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+			[childId] = nil,
+		}
+		reconciler:reconcile(newVirtualInstances, parentId, parent)
+
+		expect(child.Parent).to.equal(nil)
+		expect(#parent:GetChildren()).to.equal(0)
+	end)
+
+	it("should remove known removed children if ignoreUnknownInstances is set", function()
+		local parent = Instance.new("Folder")
+		parent.Name = "Parent"
+
+		local child = Instance.new("Folder")
+		child.Parent = parent
+		child.Name = "Child"
+
+		local parentId = "parent-id"
+		local childId = "child-id"
+
+		local reconciler = Reconciler.new()
+
+		local virtualInstancesById = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {childId},
+				Properties = {},
+				Metadata = {
+					ignoreUnknownInstances = true,
+				},
+			},
+			[childId] = {
+				Name = "Child",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+			},
+		}
+		reconciler:reconcile(virtualInstancesById, parentId, parent)
+
+		expect(child.Parent).to.equal(parent)
+		expect(#parent:GetChildren()).to.equal(1)
+
+		local newVirtualInstances = {
+			[parentId] = {
+				Name = "Parent",
+				ClassName = "Folder",
+				Children = {},
+				Properties = {},
+				Metadata = {
+					ignoreUnknownInstances = true,
+				},
+			},
+			[childId] = nil,
+		}
+		reconciler:reconcile(newVirtualInstances, parentId, parent)
+
+		expect(child.Parent).to.equal(nil)
+		expect(#parent:GetChildren()).to.equal(0)
+	end)
+end

plugin/src/RouteMap.lua

@@ -1,103 +0,0 @@
---[[
-	A map from Route objects (given by the server) to Roblox instances (created
-	by the plugin).
-]]
-
-local function hashRoute(route)
-	return table.concat(route, "/")
-end
-
-local RouteMap = {}
-RouteMap.__index = RouteMap
-
-function RouteMap.new()
-	local self = {
-		_map = {},
-		_reverseMap = {},
-		_connectionsByRbx = {},
-	}
-
-	setmetatable(self, RouteMap)
-
-	return self
-end
-
-function RouteMap:insert(route, rbx)
-	local hashed = hashRoute(route)
-
-	self._map[hashed] = rbx
-	self._reverseMap[rbx] = hashed
-	self._connectionsByRbx[rbx] = rbx.AncestryChanged:Connect(function(_, parent)
-		if parent == nil then
-			self:removeByRbx(rbx)
-		end
-	end)
-end
-
-function RouteMap:get(route)
-	return self._map[hashRoute(route)]
-end
-
-function RouteMap:removeByRoute(route)
-	local hashedRoute = hashRoute(route)
-	local rbx = self._map[hashedRoute]
-
-	if rbx then
-		self._map[hashedRoute] = nil
-		self._reverseMap[rbx] = nil
-		self._connectionsByRbx[rbx] = nil
-	end
-end
-
-function RouteMap:removeByRbx(rbx)
-	local hashedRoute = self._reverseMap[rbx]
-
-	if hashedRoute then
-		self._map[hashedRoute] = nil
-		self._reverseMap[rbx] = nil
-		self._connectionsByRbx[rbx] = nil
-	end
-end
-
-function RouteMap:removeRbxDescendants(parentRbx)
-	for rbx in pairs(self._reverseMap) do
-		if rbx:IsDescendantOf(parentRbx) then
-			self:removeByRbx(rbx)
-		end
-	end
-end
-
-function RouteMap:clear()
-	self._map = {}
-	self._reverseMap = {}
-
-	for _, connection in pairs(self._connectionsByRbx) do
-		connection:Disconnect()
-	end
-
-	self._connectionsByRbx = {}
-end
-
-function RouteMap:visualize()
-	-- Log all of our keys so that the visualization has a stable order.
-	local keys = {}
-
-	for key in pairs(self._map) do
-		table.insert(keys, key)
-	end
-
-	table.sort(keys)
-
-	local buffer = {}
-	for _, key in ipairs(keys) do
-		local visualized = ("- %s: %s"):format(
-			key,
-			self._map[key]:GetFullName()
-		)
-		table.insert(buffer, visualized)
-	end
-
-	return table.concat(buffer, "\n")
-end
-
-return RouteMap

plugin/src/Session.lua

@@ -0,0 +1,97 @@
+local Rojo = script:FindFirstAncestor("Rojo")
+
+local Promise = require(Rojo.Promise)
+
+local ApiContext = require(script.Parent.ApiContext)
+local Reconciler = require(script.Parent.Reconciler)
+
+local Session = {}
+Session.__index = Session
+
+function Session.new(config)
+	local remoteUrl = ("http://%s:%s"):format(config.address, config.port)
+	local api = ApiContext.new(remoteUrl)
+
+	local self = {
+		onError = config.onError,
+		disconnected = false,
+		reconciler = Reconciler.new(),
+		api = api,
+	}
+
+	api:connect()
+		:andThen(function()
+			if self.disconnected then
+				return
+			end
+
+			return api:read({api.rootInstanceId})
+		end)
+		:andThen(function(response)
+			if self.disconnected then
+				return
+			end
+
+			self.reconciler:reconcile(response.instances, api.rootInstanceId, game)
+			return self:__processMessages()
+		end)
+		:catch(function(message)
+			self.disconnected = true
+			self.onError(message)
+		end)
+
+	return not self.disconnected, setmetatable(self, Session)
+end
+
+function Session:__processMessages()
+	if self.disconnected then
+		return Promise.resolve()
+	end
+
+	return self.api:retrieveMessages()
+		:andThen(function(messages)
+			local promise = Promise.resolve(nil)
+
+			for _, message in ipairs(messages) do
+				promise = promise:andThen(function()
+					return self:__onMessage(message)
+				end)
+			end
+
+			return promise
+		end)
+		:andThen(function()
+			return self:__processMessages()
+		end)
+end
+
+function Session:__onMessage(message)
+	if self.disconnected then
+		return Promise.resolve()
+	end
+
+	local requestedIds = {}
+
+	for _, id in ipairs(message.added) do
+		table.insert(requestedIds, id)
+	end
+
+	for _, id in ipairs(message.updated) do
+		table.insert(requestedIds, id)
+	end
+
+	for _, id in ipairs(message.removed) do
+		table.insert(requestedIds, id)
+	end
+
+	return self.api:read(requestedIds)
+		:andThen(function(response)
+			return self.reconciler:applyUpdate(requestedIds, response.instances)
+		end)
+end
+
+function Session:disconnect()
+	self.disconnected = true
+end
+
+return Session

plugin/src/Theme.lua

@@ -0,0 +1,20 @@
+local Theme = {
+	ButtonFont = Enum.Font.GothamSemibold,
+	InputFont = Enum.Font.Code,
+	TitleFont = Enum.Font.GothamBold,
+	MainFont = Enum.Font.Gotham,
+
+	AccentColor = Color3.fromRGB(225, 56, 53),
+	AccentLightColor = Color3.fromRGB(255, 146, 145),
+	PrimaryColor = Color3.fromRGB(64, 64, 64),
+	SecondaryColor = Color3.fromRGB(235, 235, 235),
+	LightTextColor = Color3.fromRGB(160, 160, 160),
+}
+
+setmetatable(Theme, {
+	__index = function(_, key)
+		error(("%s is not a valid member of Theme"):format(key), 2)
+	end
+})
+
+return Theme

plugin/src/Types.lua

@@ -0,0 +1,36 @@
+local t = require(script.Parent.Parent.t)
+
+local DevSettings = require(script.Parent.DevSettings)
+
+local VirtualValue = t.interface({
+	Type = t.string,
+	Value = t.optional(t.any),
+})
+
+local VirtualMetadata = t.interface({
+	ignoreUnknownInstances = t.optional(t.boolean),
+})
+
+local VirtualInstance = t.interface({
+	Name = t.string,
+	ClassName = t.string,
+	Properties = t.map(t.string, VirtualValue),
+	Metadata = t.optional(VirtualMetadata)
+})
+
+local function ifEnabled(innerCheck)
+	return function(...)
+		if DevSettings:shouldTypecheck() then
+			return innerCheck(...)
+		else
+			return true
+		end
+	end
+end
+
+return {
+	ifEnabled = ifEnabled,
+	VirtualInstance = VirtualInstance,
+	VirtualMetadata = VirtualMetadata,
+	VirtualValue = VirtualValue,
+}

plugin/src/Version.lua

@@ -34,7 +34,13 @@ function Version.compare(a, b)
 end
 
 function Version.display(version)
-	return table.concat(version, ".")
+	local output = ("%d.%d.%d"):format(version[1], version[2], version[3])
+
+	if version[4] ~= nil then
+		output = output .. version[4]
+	end
+
+	return output
 end
 
-return Version
+return Version

plugin/src/init.server.lua

@@ -0,0 +1,17 @@
+if not plugin then
+	return
+end
+
+local Roact = require(script.Parent.Roact)
+
+local App = require(script.Components.App)
+
+local app = Roact.createElement(App, {
+	plugin = plugin,
+})
+
+local tree = Roact.mount(app, game:GetService("CoreGui"), "Rojo UI")
+
+plugin.Unloading:Connect(function()
+	Roact.unmount(tree)
+end)

plugin/src/preloadAssets.lua

@@ -0,0 +1,28 @@
+local ContentProvider = game:GetService("ContentProvider")
+
+local Logging = require(script.Parent.Logging)
+local Assets = require(script.Parent.Assets)
+
+local function preloadAssets()
+	local contentUrls = {}
+
+	for _, sprite in pairs(Assets.Sprites) do
+		table.insert(contentUrls, sprite.asset)
+	end
+
+	for _, slice in pairs(Assets.Slices) do
+		table.insert(contentUrls, slice.asset)
+	end
+
+	for _, url in pairs(Assets.Images) do
+		table.insert(contentUrls, url)
+	end
+
+	Logging.trace("Preloading assets: %s", table.concat(contentUrls, ", "))
+
+	coroutine.wrap(function()
+		ContentProvider:PreloadAsync(contentUrls)
+	end)()
+end
+
+return preloadAssets

plugin/src/rojoValueToRobloxValue.lua

@@ -0,0 +1,19 @@
+local RbxDom = require(script:FindFirstAncestor("Rojo").RbxDom)
+
+local function rojoValueToRobloxValue(value)
+	-- TODO: Manually decode this value by looking up its GUID The Rojo server
+	-- doesn't give us valid ref values yet, so this isn't important yet.
+	if value.Type == "Ref" then
+		return nil
+	end
+
+	local success, decodedValue = RbxDom.EncodedValue.decode(value)
+
+	if not success then
+		error(decodedValue, 2)
+	end
+
+	return decodedValue
+end
+
+return rojoValueToRobloxValue

plugin/src/rojoValueToRobloxValue.spec.lua

@@ -0,0 +1,40 @@
+local rojoValueToRobloxValue = require(script.Parent.rojoValueToRobloxValue)
+
+return function()
+	it("should convert primitives", function()
+		local inputString = {
+			Type = "String",
+			Value = "Hello, world!",
+		}
+
+		local inputFloat32 = {
+			Type = "Float32",
+			Value = 12341.512,
+		}
+
+		expect(rojoValueToRobloxValue(inputString)).to.equal(inputString.Value)
+		expect(rojoValueToRobloxValue(inputFloat32)).to.equal(inputFloat32.Value)
+	end)
+
+	it("should convert properties with direct constructors", function()
+		local inputColor3 = {
+			Type = "Color3",
+			Value = {0, 1, 0.5},
+		}
+		local outputColor3 = Color3.new(0, 1, 0.5)
+
+		local inputCFrame = {
+			Type = "CFrame",
+			Value = {
+				1, 2, 3,
+				4, 5, 6,
+				7, 8, 9,
+				10, 11, 12,
+			},
+		}
+		local outputCFrame = CFrame.new(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12)
+
+		expect(rojoValueToRobloxValue(inputColor3)).to.equal(outputColor3)
+		expect(rojoValueToRobloxValue(inputCFrame)).to.equal(outputCFrame)
+	end)
+end

plugin/src/setCanonicalProperty.lua

@@ -0,0 +1,37 @@
+local RbxDom = require(script:FindFirstAncestor("Rojo").RbxDom)
+
+--[[
+	Attempts to set a property on the given instance.
+]]
+local function setCanonicalProperty(instance, propertyName, value)
+	local descriptor = RbxDom.findCanonicalPropertyDescriptor(instance.ClassName, propertyName)
+
+	-- We can skip unknown properties; they're not likely reflected to Lua.
+	--
+	-- A good example of a property like this is `Model.ModelInPrimary`, which
+	-- is serialized but not reflected to Lua.
+	if descriptor == nil then
+		return false, "unknown property"
+	end
+
+	if descriptor.scriptability == "None" or descriptor.scriptability == "Read" then
+		return false, "unwritable property"
+	end
+
+	local success, err = descriptor:write(instance, value)
+
+	if not success then
+		-- If we don't have permission to write a property, we just silently
+		-- ignore it.
+		if err.kind == RbxDom.Error.Kind.Roblox and err.extra:find("lacking permission") then
+			return false, "permission error"
+		end
+
+		local message = ("Invalid property %s.%s: %s"):format(descriptor.className, descriptor.name, tostring(err))
+		error(message, 2)
+	end
+
+	return true
+end
+
+return setCanonicalProperty

plugin/testBootstrap.server.lua

@@ -0,0 +1,19 @@
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+local TestEZ = require(ReplicatedStorage.TestEZ)
+
+local Rojo = ReplicatedStorage.Rojo
+
+local DevSettings = require(Rojo.Plugin.DevSettings)
+
+local setDevSettings = not DevSettings:hasChangedValues()
+
+if setDevSettings then
+	DevSettings:createTestSettings()
+end
+
+TestEZ.TestBootstrap:run({Rojo.Plugin})
+
+if setDevSettings then
+	DevSettings:resetValues()
+end

plugin/tests/empty.lua

@@ -0,0 +1,5 @@
+local ReplicatedStorage = game:GetService("ReplicatedStorage")
+
+local Session = require(ReplicatedStorage.Modules.Rojo.Session)
+
+Session.new()

plugin/tests/runTests.server.lua

@@ -1,2 +0,0 @@
-local TestEZ = require(game.ReplicatedStorage.TestEZ)
-TestEZ.TestBootstrap:run(game.ReplicatedStorage.Rojo.plugin)

server/.editorconfig

@@ -1,5 +0,0 @@
-[*.rs]
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
-insert_final_newline = true

server/.gitignore

@@ -1,2 +0,0 @@
-/target/
-**/*.rs.bk