-
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
12 changed files
with
86 additions
and
52 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Command Line | ||
|
|
||
| ### List of Arguments | ||
| - `LYNC HELP` - Displays the list of available arguments. | ||
| - `LYNC CONFIG` - Opens the config file. | ||
| - `LYNC SERVE project.json? REMOTE?` - Syncs the project. | ||
| - `LYNC OPEN project.json? REMOTE?` - Build, syncs, and opens the project in Roblox Studio. | ||
| - `LYNC BUILD project.json?` - Builds the project to file. | ||
| - `LYNC FETCH project.json?` - Downloads the list of sources in the project file. | ||
|
|
||
| `project.json?` - The project file to read from and serve. | ||
|
|
||
|
|
||
| `REMOTE?` - Connect to the project's `remoteAddress` instead of the localhost. | ||
|
|
||
| ::: warning | ||
| `REMOTE` is unimplemented! | ||
| ::: | ||
|
|
||
| ### Live Sync | ||
|
|
||
| The `SERVE` and `OPEN` modes start live sync. | ||
|
|
||
| `OPEN` functions the same as `SERVE`, except it also builds the project and opens it in Roblox Studio. | ||
|
|
||
| Connect to the session through the Roblox Studio plugin. | ||
|
|
||
| ### Build to File | ||
|
|
||
| The `BUILD` mode builds the project to a place (or model) file. | ||
|
|
||
| This mode works without having Roblox Studio installed and without an internet connection. | ||
|
|
||
| ### Fetch Downloads | ||
|
|
||
| The `FETCH` mode downloads the list of sources in the project file. | ||
|
|
||
| See [project-format/project-file/automated-downloads](/lync/project-format/project-file/automated-downloads). |
41 changes: 1 addition & 40 deletions
41
docs/lync/getting-started/usage.md → ...nc/getting-started/usage/studio-plugin.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
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
File renamed without changes.
File renamed without changes.
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,7 @@ | ||
| # Script Directives | ||
| Add the following directives to the top of your script to control its [RunContext](https://create.roblox.com/docs/reference/engine/enums/RunContext) or to disable it: | ||
| * `--@script` / `--@script:legacy` | ||
| * `--@script:server` | ||
| * `--@script:client` | ||
| * `--@localscript` / `--@script:localscript` | ||
| * `--@disabled` |
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,19 @@ | ||
| # Supported Files | ||
| | Concept | File Extension | Roblox ClassName | | ||
| |-|-|-| | ||
| | Folders | any directory | Folder | ||
| | Scripts | `LUA`/`LUAU` | [LuaSourceContainer](https://create.roblox.com/docs/reference/engine/classes/LuaSourceContainer) * | | ||
| | Models | `RBXM`/`RBXMX` | Varies | | ||
| | JSON Objects | `JSON` | [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) | | ||
| | YAML Objects | `YAML` | [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) | | ||
| | TOML Objects | `TOML` | [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) | | ||
| | Excel Sheets | `XLSX`/`XLS` | [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) | | ||
| | Text Document | `TXT` | [StringValue](https://create.roblox.com/docs/reference/engine/classes/StringValue) | | ||
| | Localization Table | `CSV` | [LocalizationTable](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable) | | ||
| | Child Projects | `*.Project.JSON` | Varies | | ||
| | JSON Models | `*.Model.JSON` | Varies | | ||
| | Init Scripts (Anonymous) | `Init.LUA` / `LUAU` | [LuaSourceContainer](https://create.roblox.com/docs/reference/engine/classes/LuaSourceContainer) * | | ||
| | Init Scripts (Named) | `*.Init.LUA` / `LUAU` | [LuaSourceContainer](https://create.roblox.com/docs/reference/engine/classes/LuaSourceContainer) * | | ||
| | Meta Files | `*.Meta.JSON` / `YAML` / `TOML` | N/A | | ||
|
|
||
| \* Can be [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript), [Script](https://create.roblox.com/docs/reference/engine/classes/Script), or [LocalScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) depending on the script run context directive |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.