-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
202 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ::: danger UNFINISHED | ||
| This documentation is unfinished. | ||
| ::: | ||
|
|
||
| # Automated Downloads | ||
|
|
||
| ## Syntax | ||
|
|
||
| ::: info Keys | ||
| - string `name` | ||
| - string `url` | ||
| - string `type` | ||
| - {[string]: string} `headers` | ||
| - string | Object `postData` | ||
| - string `path` | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| ::: danger UNFINISHED | ||
| This documentation is unfinished. | ||
| ::: | ||
|
|
||
| # Automated Jobs | ||
|
|
||
| ## Syntax | ||
|
|
||
| ::: info Keys | ||
| - string `globPath` | ||
| - {string} `on` | ||
| - string `commandName` | ||
| ::: |
1 change: 1 addition & 0 deletions
1
...c/project-format/project-file/packages.md → docs/lync/project-format/project/packages.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| ::: danger UNFINISHED | ||
| This documentation is unfinished. | ||
| ::: | ||
|
|
||
| # Packages | ||
|
|
||
| ::: tip | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| ::: danger UNFINISHED | ||
| This documentation is unfinished. | ||
| ::: | ||
|
|
||
| # Project File | ||
|
|
||
| ## Syntax | ||
|
|
||
| ::: info File Name | ||
| - `Default.Project.JSON` | ||
| - The default project to load when running Lync without the project file argument. | ||
| - `*.Project.JSON` | ||
| - For non-default projects. | ||
| ::: | ||
| ::: info Keys | ||
| - string `name` | ||
| - The name of the project for informational purposes. | ||
| - string `base` *(Optional)* | ||
| - The path to the file to build in when using `OPEN` and `BUILD` modes. | ||
| - When omitted, Lync builds in a new file. | ||
| - string `build` | ||
| - The path to save the finished build file when using `OPEN` and `BUILD` modes. | ||
| - number `port` | ||
| - The network port to serve the project on when using `SERVE` and `OPEN` modes. | ||
| - string `remoteAddress` *(Optional)* | ||
| - The IP address or hostname to connect to instead of the localhost. | ||
| - {number} `servePlaceIds` *(Optional)* | ||
| - {string} `globIgnorePaths` *(Optional)* | ||
| - An array of glob paths to ignore when mapping the project. | ||
| - {RBXM: boolean, RBXMX: boolean} `sourcemapEnabled` *(Optional)* | ||
| - Controls which types of Model Files (`RBXM`/`RBXMX`) are parsed during sourcemap generation. | ||
| - Object `sources` *(Optional)* | ||
| - See [project-format/project/automated-downloads](/lync/project-format/project/automated-downloads). | ||
| - Object `jobs` *(Optional)* | ||
| - See [project-format/project/automated-jobs](/lync/project-format/project/automated-jobs). | ||
| - Object `tree` | ||
| - The root Instance. | ||
| ::: | ||
| ::: danger UNAVAILABLE | ||
| `remoteAddress` is unimplemented. | ||
| ::: | ||
|
|
||
| ### Example | ||
|
|
||
| ```json | ||
| { | ||
| "name": "Example Project", | ||
| "base": "Base.rbxl", | ||
| "build": "Build.rbxl", | ||
| "port": 34873, | ||
| "remoteAddress": "localhost", | ||
| "servePlaceIds": 1818, | ||
| "globIgnorePaths": [ "ignoredDirectory/**" ], | ||
| "sourcemapEnabled": { | ||
| "RBXM": true, | ||
| "RBXMX": true | ||
| }, | ||
| "sources": { ... }, | ||
| "jobs": { ... }, | ||
|
|
||
| "tree": { | ||
| ... | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Instance Definitions | ||
|
|
||
| ::: info Keys | ||
| - string `$className` *(Optional)* | ||
| - Has no effect when `$path` is specified. | ||
| - (string | Object) `$path` *(Optional)* | ||
| - A path to a file or directory that overrides the Instance Definition. | ||
| - Use `"$path": { "optional": "..." }` when the file or directory could possibly be non-existant. | ||
| - Use `"$path": { "package": "...", "type": "..." }` for [Packages](/lync/project-format/project/packages). | ||
| - {[string]: any} `$properties` *(Optional)* | ||
| - Functions as `instance[property] = value`. | ||
| - {[string]: any} `$attributes` *(Optional)* | ||
| - Functions as `instance:SetAttribute(attribute, value)`. | ||
| - {string} `$tags` *(Optional)* | ||
| - Functions as `CollectionService:AddTag(instance, tag)`. | ||
| - boolean `$clearOnSync` *(Optional)* | ||
| - When `true`, the associated Instance and its descendants will be destroyed in Studio when performing sync operations. | ||
| - Useful for clearing unmapped content when modifications are made outside your active live sync session. | ||
| ::: | ||
|
|
||
| ### Values | ||
|
|
||
| Values not storable in JSON, like `Enum`, `Color3`, `Vector3` and so on, should be represented as a single Lua string wrapped inside an array (e.g., `[ "Value" ]`.) | ||
|
|
||
|
|
||
| ### Example | ||
|
|
||
| ```json | ||
| "Wood Brick": { | ||
| "$className": "Part", | ||
| "$properties": { | ||
| "Color": [ "Color3.fromRGB(132, 66, 4)" ], | ||
| "Material": [ "Enum.Material.Wood" ], | ||
| "Transparency": 0, | ||
| "Position": [ "Vector3.new(0, 10, 0)" ], | ||
| "Anchored": true | ||
| }, | ||
| "$attributes": { | ||
| "ExampleAttribute": true | ||
| }, | ||
| "$tags": [ "ExampleTag1", "ExampleTag2", "ExampleTag3" ] | ||
| } | ||
| ``` | ||
|
|
||
| ## Terrain | ||
|
|
||
| ::: info Keys | ||
| - {[1]: string, [2]: Lua, [3]: boolean} `Terrain.$terrainRegion` *(Optional)* | ||
| - Functions as `Terrain:PasteRegion(region, corner, pasteEmptyCells)`. | ||
| - {[string]: Lua} `Terrain.$terrainMaterialColors` *(Optional)* | ||
| - Functions as `Terrain:SetMaterialColor(material, value)`. | ||
| ::: | ||
|
|
||
| ### Example | ||
|
|
||
| ```json | ||
| "Workspace": { | ||
| "Terrain": { | ||
| "$terrainRegion": [ "Assets/TerrainRegion.rbxm", [ "Vector3int16.new(-32000, -32000, -32000)" ], true ], | ||
| "$terrainMaterialColors": { | ||
| "Grass": [ "Color3.new(0, 0.5, 0)" ] | ||
| } | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters