From c86a4acdfd9c453667abf98db7112365eb190b6d Mon Sep 17 00:00:00 2001 From: hoontee Date: Wed, 29 Nov 2023 21:18:26 -0600 Subject: [PATCH] Update all --- docs/.vitepress/config.mjs | 25 +++++++---- .../getting-started/usage/command-line.md | 38 +++++++++++++++++ .../{usage.md => usage/studio-plugin.md} | 41 +------------------ docs/lync/index.md | 8 ++-- .../files/{filetypes.md => init-scripts.md} | 0 .../files/{model-files.md => json-models.md} | 0 .../project-format/files/script-directives.md | 7 ++++ .../project-format/files/supported-files.md | 19 +++++++++ .../automated-downloads.md | 0 .../automated-jobs.md | 0 .../packages.md | 0 .../overview.md => project-file/syntax.md} | 0 12 files changed, 86 insertions(+), 52 deletions(-) create mode 100644 docs/lync/getting-started/usage/command-line.md rename docs/lync/getting-started/{usage.md => usage/studio-plugin.md} (52%) rename docs/lync/project-format/files/{filetypes.md => init-scripts.md} (100%) rename docs/lync/project-format/files/{model-files.md => json-models.md} (100%) create mode 100644 docs/lync/project-format/files/script-directives.md create mode 100644 docs/lync/project-format/files/supported-files.md rename docs/lync/project-format/{project-json => project-file}/automated-downloads.md (100%) rename docs/lync/project-format/{project-json => project-file}/automated-jobs.md (100%) rename docs/lync/project-format/{project-json => project-file}/packages.md (100%) rename docs/lync/project-format/{project-json/overview.md => project-file/syntax.md} (100%) diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 0bbfdb0..7f22f76 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -36,7 +36,14 @@ export default defineConfig({ text: 'Getting Started', collapsed: false, items: [ - { text: 'Usage', link: '/lync/getting-started/usage' }, + { + text: 'Usage', + collapsed: false, + items: [ + { text: 'Command Line', link: '/lync/getting-started/usage/command-line' }, + { text: 'Studio Plugin', link: '/lync/getting-started/usage/studio-plugin' } + ] + }, { text: 'Create a New Project', link: '/lync/getting-started/new-project' }, { text: 'Convert an Existing Place', link: '/lync/getting-started/convert-place' } ] @@ -49,19 +56,21 @@ export default defineConfig({ text: 'Project File', collapsed: false, items: [ - { text: 'Syntax', link: '/lync/project-format/project-json/overview' }, - { text: 'Packages', link: '/lync/project-format/project-json/packages' }, - { text: 'Automated Downloads', link: '/lync/project-format/project-json/automated-downloads' }, - { text: 'Automated Jobs', link: '/lync/project-format/project-json/automated-jobs' } + { text: 'Syntax', link: '/lync/project-format/project-file/syntax' }, + { text: 'Packages', link: '/lync/project-format/project-file/packages' }, + { text: 'Automated Downloads', link: '/lync/project-format/project-file/automated-downloads' }, + { text: 'Automated Jobs', link: '/lync/project-format/project-file/automated-jobs' } ] }, { text: 'Files', collapsed: false, items: [ - { text: 'Filetypes', link: '/lync/project-format/files/filetypes' }, - { text: 'Model Files', link: '/lync/project-format/files/model-files' }, - { text: 'Meta Files', link: '/lync/project-format/files/meta-files' } + { text: 'Supported Files', link: '/lync/project-format/files/supported-files' }, + { text: 'Script Directives', link: '/lync/project-format/files/script-directives' }, + { text: 'Init Scripts', link: '/lync/project-format/files/init-scripts' }, + { text: 'Meta Files', link: '/lync/project-format/files/meta-files' }, + { text: 'JSON Models', link: '/lync/project-format/files/json-models' } ] }, { text: 'Sourcemap', link: '/lync/project-format/sourcemap' } diff --git a/docs/lync/getting-started/usage/command-line.md b/docs/lync/getting-started/usage/command-line.md new file mode 100644 index 0000000..27bc585 --- /dev/null +++ b/docs/lync/getting-started/usage/command-line.md @@ -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). diff --git a/docs/lync/getting-started/usage.md b/docs/lync/getting-started/usage/studio-plugin.md similarity index 52% rename from docs/lync/getting-started/usage.md rename to docs/lync/getting-started/usage/studio-plugin.md index c32e91f..a9ee769 100644 --- a/docs/lync/getting-started/usage.md +++ b/docs/lync/getting-started/usage/studio-plugin.md @@ -1,43 +1,4 @@ -# Usage - -## Command Line 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 [lync/project-json/automated-downloads](/lync/project-format/project-json/automated-downloads). - -## Studio Plugin +# Studio Plugin ### Lync Client Widget The **Lync Client** widget is used to interface with an active live sync session. diff --git a/docs/lync/index.md b/docs/lync/index.md index 28f1b6d..a3ffee4 100644 --- a/docs/lync/index.md +++ b/docs/lync/index.md @@ -29,12 +29,12 @@ The Roblox Studio editor is slow and has a limited feature set. Lync allows you Unlike [the upcoming built-in Open Cloud file sync feature](https://devforum.roblox.com/t/what-we-announced-at-rdc-2023/2585405), Lync deals with more than just scripts - all in-game content can be synced: scripts, models, and properties. -See [lync/project-format/files/filetypes](/lync/project-format/files/filetypes). +See [project-format/files/supported-files](/lync/project-format/files/supported-files). ### Automation Lync offers additional built-in tools for power users to automate aspects of the project. -- [**Packages**](/lync/project-format/project-json/packages) - Download GitHub repositories and insert their contents into the project. -- [**Automated Downloads**](/lync/project-format/project-json/automated-downloads) - Download a list of sources into the project. -- [**Automated Jobs**](/lync/project-format/project-json/automated-jobs) - Run scripts based on file system event criteria. +- [**Packages**](/lync/project-format/project-file/packages) - Download GitHub repositories and insert their contents into the project. +- [**Automated Downloads**](/lync/project-format/project-file/automated-downloads) - Download a list of sources into the project. +- [**Automated Jobs**](/lync/project-format/project-file/automated-jobs) - Run scripts based on file system event criteria. diff --git a/docs/lync/project-format/files/filetypes.md b/docs/lync/project-format/files/init-scripts.md similarity index 100% rename from docs/lync/project-format/files/filetypes.md rename to docs/lync/project-format/files/init-scripts.md diff --git a/docs/lync/project-format/files/model-files.md b/docs/lync/project-format/files/json-models.md similarity index 100% rename from docs/lync/project-format/files/model-files.md rename to docs/lync/project-format/files/json-models.md diff --git a/docs/lync/project-format/files/script-directives.md b/docs/lync/project-format/files/script-directives.md new file mode 100644 index 0000000..ba93d0d --- /dev/null +++ b/docs/lync/project-format/files/script-directives.md @@ -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` \ No newline at end of file diff --git a/docs/lync/project-format/files/supported-files.md b/docs/lync/project-format/files/supported-files.md new file mode 100644 index 0000000..1fcc47e --- /dev/null +++ b/docs/lync/project-format/files/supported-files.md @@ -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 diff --git a/docs/lync/project-format/project-json/automated-downloads.md b/docs/lync/project-format/project-file/automated-downloads.md similarity index 100% rename from docs/lync/project-format/project-json/automated-downloads.md rename to docs/lync/project-format/project-file/automated-downloads.md diff --git a/docs/lync/project-format/project-json/automated-jobs.md b/docs/lync/project-format/project-file/automated-jobs.md similarity index 100% rename from docs/lync/project-format/project-json/automated-jobs.md rename to docs/lync/project-format/project-file/automated-jobs.md diff --git a/docs/lync/project-format/project-json/packages.md b/docs/lync/project-format/project-file/packages.md similarity index 100% rename from docs/lync/project-format/project-json/packages.md rename to docs/lync/project-format/project-file/packages.md diff --git a/docs/lync/project-format/project-json/overview.md b/docs/lync/project-format/project-file/syntax.md similarity index 100% rename from docs/lync/project-format/project-json/overview.md rename to docs/lync/project-format/project-file/syntax.md