rojo-rbx/rojo
1
0
Fork 1
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-04-24 14:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update and improve reference documentation

Browse Source
This commit is contained in:
Lucien Greathouse
2019-08-26 17:23:59 -07:00
parent 32af8783ba
commit 53793f7dd2
2 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/reference/project-format.md
View File

@@ -1,25 +1,31 @@
[TOC] [TOC]
## Project File ## Project File
Rojo projects are JSON files that have the `.project.json` extension. They have the following fields:
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 name is used when building the project into a model or place file.
* **Required**
* `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. * `tree`: An [Instance Description](#instance-description) describing the root instance of the project.
* **Required**
* `servePort`: The port that `rojo serve` should listen on. Passing `--port` will override this setting.
* **Optional**
* Default is `34872`
* `servePlaceIds`: A list of place IDs that this project may be live-synced to. This feature can help prevent overwriting the wrong game with source from Rojo.
* **Optional**
* Default is `null`
## Instance Description ## 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. Instance Descriptions correspond one-to-one with the actual Roblox Instances in the project.
* `$className`: The ClassName of the Instance being described. * `$className`: The ClassName of the Instance being described.
* Optional if `$path` is specified. * **Optional if `$path` is specified.**
* `$path`: The path on the filesystem to pull files from into the project. * `$path`: The path on the filesystem to pull files from into the project.
* Optional if `$className` is specified. * **Optional if `$className` is specified.**
* Paths are relative to the folder containing the project file. * 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). * `$properties`: Properties to apply to the instance. Values should be [Instance Property Values](#instance-property-value).
* Optional * **Optional**
* `$ignoreUnknownInstances`: Whether instances that Rojo doesn't know about should be deleted. * `$ignoreUnknownInstances`: Whether instances that Rojo doesn't know about should be deleted.
* Optional * **Optional**
* Default is `false` if `$path` is specified, otherwise `true`. * 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! All other fields in an Instance Description are turned into instances whose name is the key. These values should also be Instance Descriptions!

5
docs/reference/sync-details.md
View File

@@ -86,6 +86,11 @@ It would turn into instances in this shape:
![Tree of instances in Roblox](../images/sync-example-json-model.svg) ![Tree of instances in Roblox](../images/sync-example-json-model.svg)
{: align="center" } {: align="center" }
!!! warning
Starting in Rojo 0.5.0 Beta 1, the `Name` field is no longer required. The name of the top-level instance in a JSON model is now based on its file name, and the `Name` field is now ignored.
Rojo will emit a warning if the `Name` field is specified and does not match the file's name.
## Binary and XML Models ## Binary and XML Models
Rojo supports both binary (`.rbxm`) and XML (`.rbxmx`) models generated by Roblox Studio or another tool. Rojo supports both binary (`.rbxm`) and XML (`.rbxmx`) models generated by Roblox Studio or another tool.