diff --git a/docs/lync/getting-started/convert-place.md b/docs/lync/getting-started/convert-place.md index 7ef6d77..ffa3396 100644 --- a/docs/lync/getting-started/convert-place.md +++ b/docs/lync/getting-started/convert-place.md @@ -1,4 +1,5 @@ # Convert an Existing Place + ::: danger UNAVAILABLE The `LYNC INIT` wizard is not yet available. diff --git a/docs/lync/getting-started/installation.md b/docs/lync/getting-started/installation.md index c8bf4b2..a7f6987 100644 --- a/docs/lync/getting-started/installation.md +++ b/docs/lync/getting-started/installation.md @@ -1,4 +1,5 @@ # Installation + There are three ways to install Lync: ::: details Aftman ```bash @@ -19,6 +20,7 @@ In Windows, it's recommended that you modify your `Path` system environment vari The Roblox Studio plugin installs automatically each time a live sync session is started. ## Auto Updates + Lync has the ability to automatically download and install new releases. Your configuration is preserved when updating. This feature is disabled by default. @@ -27,4 +29,5 @@ This feature is disabled by default. * To change the update repository, run `LYNC CONFIG` and modify `AutoUpdate_Repo`. ## Lune Dependency + [Lune](https://lune-org.github.io/docs/getting-started/1-installation) must be installed for building to file in `OPEN` and `BUILD` modes. You must specify the path to your Lune installation in the config file. To do this, run `LYNC CONFIG` and modify `Path_Lune`. diff --git a/docs/lync/getting-started/new-project.md b/docs/lync/getting-started/new-project.md index 741eba8..a8d45f1 100644 --- a/docs/lync/getting-started/new-project.md +++ b/docs/lync/getting-started/new-project.md @@ -1,4 +1,5 @@ # Create a New Project + ::: danger UNAVAILABLE The `LYNC INIT` wizard is not yet available. diff --git a/docs/lync/getting-started/usage/lync-executable.md b/docs/lync/getting-started/usage/lync-executable.md index fc4558a..ae557b3 100644 --- a/docs/lync/getting-started/usage/lync-executable.md +++ b/docs/lync/getting-started/usage/lync-executable.md @@ -1,7 +1,9 @@ # Lync Executable + The Lync executable can start a live sync session, build to file, and fetch downloads. ## Command Line Arguments + ::: info Command Line Arguments - `LYNC HELP` - Displays the list of available arguments. - `LYNC CONFIG` - Opens the config file. diff --git a/docs/lync/getting-started/usage/studio-plugin.md b/docs/lync/getting-started/usage/studio-plugin.md index f7d0b0a..1bf60fa 100644 --- a/docs/lync/getting-started/usage/studio-plugin.md +++ b/docs/lync/getting-started/usage/studio-plugin.md @@ -1,9 +1,11 @@ # Studio Plugin + The Studio plugin interfaces with an active live sync session in order to sync content. When using the `OPEN` mode, the plugin will attempt to connect automatically. ## Lync Client Widget + The **Lync Client** widget is used to control an active live sync session. - **Sync** / **Pause** / **Resume** - Toggles live sync. @@ -11,16 +13,19 @@ The **Lync Client** widget is used to control an active live sync session. - **Save Script** / **Revert Script** - When live sync is enabled, the open script in Roblox Studio can be saved to disk, or reverted to its linked file's contents. ## Playtest Sync + When **Playtest Sync** is enabled from the toolbar, file changes are synced during a singleplayer or multiplayer test session. Only the Roblox server-side (i.e., not client-side) will sync changes. ## Save Terrain + The **Save Terrain** toolbar button is used to snapshot a [TerrainRegion](https://create.roblox.com/docs/reference/engine/classes/TerrainRegion) for use inside a project. Activating it opens a file save dialog. ## Unsaved Models Widget + A cube icon will appear in the bottom right corner of the viewport whenever a synced model is modified. Clicking on the icon opens the **Unsaved Models** widget which displays a list of all modified synced models. diff --git a/docs/lync/index.md b/docs/lync/index.md index 9e34abd..f021106 100644 --- a/docs/lync/index.md +++ b/docs/lync/index.md @@ -62,6 +62,7 @@ Lync is written in [Node.js](https://nodejs.org/) and compiled with [pkg](https: As is the case with most thirdparty Roblox tooling, its source is publicly available and can be modified if needed. ## Games Made With Lync + ::: info Games Made With Lync - [Claw Machine Simulator - Fund For Games](https://www.roblox.com/games/8875360163) - [ExoTech - Iron Stag Games](https://www.roblox.com/games/7634484468) diff --git a/docs/lync/introduction/community-tooling.md b/docs/lync/introduction/community-tooling.md index 8d7b26f..26e6bd1 100644 --- a/docs/lync/introduction/community-tooling.md +++ b/docs/lync/introduction/community-tooling.md @@ -1,4 +1,5 @@ # Community Tooling + Although most (if not all) were originally designed with Rojo in mind, the following open source tools are compatible with Lync. This list is by no means complete. diff --git a/docs/lync/project-format/files/excel-tables.md b/docs/lync/project-format/files/excel-tables.md index 94cc8f1..b85c793 100644 --- a/docs/lync/project-format/files/excel-tables.md +++ b/docs/lync/project-format/files/excel-tables.md @@ -1,9 +1,11 @@ # Excel Tables + Excel Tables specify a range of cells from an Excel Spreadsheet (`XLSX`/`XLS`) to translate into a [ModuleScript](https://create.roblox.com/docs/reference/engine/classes/ModuleScript). The resulting table can be formatted in multiple ways. ## Syntax + ::: info File Name - `*.Excel.JSON` ::: @@ -17,6 +19,7 @@ The resulting table can be formatted in multiple ways. ## Examples ### Example 1 + Given an Excel Spreadsheet named `Economy.xlsx` containing the following cells in a sheet named `Pets`; | | A | B | C | D | E | F | |-|-|-|-|-|-|-| @@ -65,6 +68,7 @@ It's important to format tables in ways that are easy for you to use. When table ::: ### Example 2 + Given an Excel Spreadsheet named `Players.xlsx` containing the following cells in a sheet named `Sheet1`; | | C | D | E | F | |-|-|-|-|-| diff --git a/docs/lync/project-format/files/json-models.md b/docs/lync/project-format/files/json-models.md index 3cb8280..da0fe0c 100644 --- a/docs/lync/project-format/files/json-models.md +++ b/docs/lync/project-format/files/json-models.md @@ -1,9 +1,11 @@ # JSON Models + JSON Models describe a simple set of Instances. Unlike Model Files (`RBXM`/`RBXMX`\;) their data is limited to that which can be assigned by a script (e.g., no [MeshPart](https://create.roblox.com/docs/reference/engine/classes/MeshPart) data.) ## Syntax + ::: info File Name - `*.Model.JSON` ::: @@ -17,6 +19,7 @@ Unlike Model Files (`RBXM`/`RBXMX`\;) their data is limited to that which can be ::: ## Example + A JSON Model describing a [Model](https://create.roblox.com/docs/reference/engine/classes/Model) containing a small green [Part](https://create.roblox.com/docs/reference/engine/classes/Part) and a [RemoteEvent](https://create.roblox.com/docs/reference/engine/classes/RemoteEvent) would be written as a file named `{example}.Model.JSON` with: ```json { diff --git a/docs/lync/project-format/files/meta-files.md b/docs/lync/project-format/files/meta-files.md index 8f0851e..08f57fd 100644 --- a/docs/lync/project-format/files/meta-files.md +++ b/docs/lync/project-format/files/meta-files.md @@ -1,9 +1,11 @@ # Meta Files + Meta Files attach additional data to a file or directory. They are used in scenarios where it would be desirable to change the properties of something which otherwise cannot be changed from the filesystem. ## Syntax + ::: info File Name - `*.Meta.JSON` - For files. - `Init.Meta.JSON` - For directories. @@ -18,6 +20,7 @@ They are used in scenarios where it would be desirable to change the properties ## Examples ### Example 1 + The most common use case is changing the ClassName of a Folder. If your project has a Folder and you want to change its ClassName, you will create a `Init.Meta.JSON` inside it with: @@ -28,6 +31,7 @@ If your project has a Folder and you want to change its ClassName, you will crea ``` ### Example 2 + Another use case is changing the properties of a Model File (`RBXM`/`RBXMX`). Because the file is encoded, it cannot have its properties changed directly. If your project has `{example}.RBXM` (which contains a single [Part](https://create.roblox.com/docs/reference/engine/classes/Part)) and you want to make it a different color, you would create a `{example}.Meta.JSON` next to it with: diff --git a/docs/lync/project-format/files/scripts.md b/docs/lync/project-format/files/scripts.md index 99302b3..0a6a3d8 100644 --- a/docs/lync/project-format/files/scripts.md +++ b/docs/lync/project-format/files/scripts.md @@ -1,7 +1,9 @@ # Scripts + Scripts can be formatted in a few different ways to change their representation in Roblox. ## Script Directives + Add Directives to the top of your script to change its ClassName, control its [RunContext](https://create.roblox.com/docs/reference/engine/enums/RunContext), or disable it. ::: info Script Directives | Directive | ClassName | RunContext | Behavior | @@ -15,6 +17,7 @@ Add Directives to the top of your script to change its ClassName, control its [R ::: ## Init Scripts + Any file ending in `Init.LUA` or `{parent directory's name}.Init.LUA` will change its parent directory to a script with the contents of the file. Like all directories, contents inside the parent directory will be parented to the script. diff --git a/docs/lync/project-format/files/supported-files.md b/docs/lync/project-format/files/supported-files.md index 5ad14e4..11183a8 100644 --- a/docs/lync/project-format/files/supported-files.md +++ b/docs/lync/project-format/files/supported-files.md @@ -1,4 +1,5 @@ # Supported Files + Different file types are synced into the place in different forms. All forms of Roblox content can be stored on the filesystem and synced. diff --git a/docs/lync/project-format/sourcemap.md b/docs/lync/project-format/sourcemap.md index c71ba86..ad490a1 100644 --- a/docs/lync/project-format/sourcemap.md +++ b/docs/lync/project-format/sourcemap.md @@ -1,9 +1,11 @@ # Sourcemap + The Sourcemap is an automatically generated file that serves as a layout of the project for other tools to utilize. This file cannot be deleted and should be ignored unless you're a tool developer. ## Syntax + ::: info File Name - `sourcemap.json` :::