goldsync 0.1.11

package/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2026 tay. All rights reserved.
+
+Permission is granted to install and use GoldSync through its official Visual Studio Marketplace listing, npm package, or an installation package supplied by the publisher. Redistribution, modification, sublicensing, and resale are not permitted without prior written permission from the copyright holder.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.

package/README.md

@@ -0,0 +1,129 @@
+# GoldSync
+
+GoldSync synchronizes configured, code-free Roblox Studio hierarchies with native `.rbxm` files. Rojo continues to own scripts.
+
+This is the standalone GoldSync source and build folder. It stays separate from game projects. Each game project contains its own `goldsync.project.json`, one Rojo session-marker mapping, and its synced RBXM files.
+
+## Install for Cursor or VS Code
+
+Install the public VS Code extension:
+
+```powershell
+code --install-extension tay.native-asset-sync
+```
+
+Open the game repository in VS Code. GoldSync activates when the workspace root contains `goldsync.project.json` and installs its Roblox Studio plugin automatically on Windows. Reload VS Code and restart Studio once after the first installation. Studio may ask for permission to access `127.0.0.1`.
+
+## Install for Zed
+
+From the game repository terminal, run:
+
+```powershell
+npx goldsync install
+```
+
+That command downloads GoldSync from npm, finds the repository's `goldsync.project.json`, installs the Studio plugin, registers that project, starts GoldSync immediately, and enables it at Windows login. Zed does not need a task or extension. Restart Studio once after the first installation.
+
+For offline distribution, build the companion package from this folder:
+
+```powershell
+npm run package:companion
+```
+
+Send the ZIP from `dist` to the programmer and extract it anywhere. From the game repository terminal, run its installer as one command:
+
+```powershell
+& "C:\path\to\GoldSync-Companion\install.cmd"
+```
+
+Running the installer from another game registers that game too. Registering another clone with the same `projectId` replaces the old clone, preventing two copies of one project from claiming the same Rojo session. Cursor's extension and the companion can run together; they share one broker automatically.
+
+For a local development build, run:
+
+```powershell
+.\install.ps1
+```
+
+That installs dependencies, builds the Studio plugin and VS Code extension, creates the latest VSIX under `extension`, and installs it locally.
+
+## Configure a game
+
+Place `goldsync.project.json` at the game repository root:
+
+```json
+{
+  "version": 1,
+  "name": "My Game",
+  "projectId": "my-game",
+  "roots": [
+    {
+      "id": "effects",
+      "studioPath": ["ReplicatedStorage", "Assets", "Effects"],
+      "file": "assets/ReplicatedStorage/Assets/Effects.rbxm"
+    },
+    {
+      "id": "main-pages",
+      "studioPath": ["StarterGui", "Main", "Pages"],
+      "directory": "assets/StarterGui/Main/Pages",
+      "splitDepth": 1
+    }
+  ]
+}
+```
+
+A `file` root becomes one RBXM. A `directory` root creates separate files for descendants at `splitDepth`. Split at complete models, effects, or UI components—not individual parts or attachments. Never map the same hierarchy in Rojo, and do not include scripts inside a GoldSync root.
+
+GoldSync reads the Rojo project name and fallback `servePort` from `default.project.json`. It automatically detects `rojo serve --port` overrides and verifies the listener's project name before connecting. That active Rojo session selects the GoldSync workspace, so Studio place IDs and names do not need configuration. Set `rojo.projectFile` only when the repository uses another project file.
+
+Map GoldSync's generated live-session marker in the Rojo project tree:
+
+```json
+"ServerStorage": {
+  "__GoldSyncSession": {
+    "$path": ".goldsync/rojo-session.model.json"
+  }
+}
+```
+
+The extension generates that ignored file from Rojo's current session ID. Only Studio windows that receive the current marker from Rojo can access the matching GoldSync workspace. A disconnected or different place is rejected.
+
+## Daily use
+
+1. Open the game repository in Cursor, VS Code, or Zed.
+2. Run `rojo serve`.
+3. Open a configured place in Roblox Studio.
+4. Confirm the GoldSync status bar and Studio widget are connected.
+
+Studio and file edits then synchronize automatically. On the first connection, if both sides already contain data, use **Push Studio** or **Pull File** once to select the authoritative copy. Stopping Rojo pauses normal synchronization.
+
+Deleting a synchronized root in Studio deletes its RBXM file. GoldSync refuses the deletion if that file changed since Studio last synchronized it, preserving the file for manual conflict resolution.
+
+The broker uses `127.0.0.1:34873`. Multiple repositories and different Rojo projects may be served at once because every Studio request is bound to its project and live Rojo session. GoldSync refuses multiple simultaneous Rojo servers for the same project name.
+
+## Merge conflicts
+
+Configured RBXM conflicts pause that file before either side can overwrite it. GoldSync shows a VS Code notification naming the project. **Open Conflict Viewer** temporarily connects that workspace even while Rojo is offline.
+
+In Studio, **Open Merge Workspace** creates Base, Yours, Theirs, and editable Result trees under `ServerStorage.GoldSync Conflicts`. Use **Property Diff** when useful, edit Result, then click **Resolve Result**. Resolving writes and stages the selected RBXM file. The viewer is optional and can be disabled with `goldsync.conflictNotifications.enabled`.
+
+## Development
+
+Run the automated tests from this repository:
+
+```powershell
+npm test
+```
+
+Package the Marketplace extension:
+
+```powershell
+cd extension
+npm install
+npm run package
+```
+
+To run the standalone diagnostic server against a game config:
+
+```powershell
+.\start.ps1 C:\path\to\goldsync.project.json
+```