You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: simplify citation + host preview on Scriptwonder fork
Citation: trimmed to bibtex only — the paper info paragraph and APA
plain-text citation were nice-to-have but added vertical noise. The
bibtex carries enough metadata for both code search and academic use.
Hosting move (Scriptwonder fork preview):
- docusaurus.config.js: url + organizationName flipped to Scriptwonder
- docs-deploy.yml: deploy on push to `docs/v2-wiki-refresh` OR `beta`
(Setup Pages, Upload artifact, Deploy job conditions all updated).
Lets the live preview at scriptwonder.github.io/unity-mcp update as
we iterate, without waiting for an upstream maintainer to enable
Pages on CoplayDev/unity-mcp.
- Hardcoded URLs in README.md, website/README.md, website/static/
robots.txt swapped from coplaydev.github.io/unity-mcp to
scriptwonder.github.io/unity-mcp via a one-shot sed.
- docs.md + website/README.md retain a one-line note about flipping
back to coplaydev once upstream Pages is enabled.
After push, to make the preview actually serve:
- Settings → Pages → Source → "GitHub Actions"
on https://github.com/Scriptwonder/unity-mcp/settings/pages
The deploy job in the next push will then provision Pages on first run.
Beta channel uses `#beta`. Asset Store and OpenUPM paths are documented in the [Install guide](https://coplaydev.github.io/unity-mcp/getting-started/install).
37
+
Beta channel uses `#beta`. Asset Store and OpenUPM paths are documented in the [Install guide](https://scriptwonder.github.io/unity-mcp/getting-started/install).
38
38
39
39
Then **Window → MCP for Unity → Configure All Detected Clients**. That's it — try a prompt:
40
40
41
41
> Create a red, blue, and yellow cube in the current scene.
42
42
43
-
Full walkthrough: [Your First Prompt](https://coplaydev.github.io/unity-mcp/getting-started/first-prompt).
43
+
Full walkthrough: [Your First Prompt](https://scriptwonder.github.io/unity-mcp/getting-started/first-prompt).
44
44
45
45
---
46
46
@@ -54,7 +54,7 @@ Full walkthrough: [Your First Prompt](https://coplaydev.github.io/unity-mcp/gett
Full history: [Release Notes](https://coplaydev.github.io/unity-mcp/releases).
57
+
Full history: [Release Notes](https://scriptwonder.github.io/unity-mcp/releases).
58
58
59
59
</details>
60
60
<!-- recent-updates:end -->
@@ -70,32 +70,22 @@ Full history: [Release Notes](https://coplaydev.github.io/unity-mcp/releases).
70
70
71
71
## Contributing
72
72
73
-
See [CONTRIBUTING.md](CONTRIBUTING.md). Branch off `beta`, not `main`. The full dev setup, testing, and release process live in the [Contributing](https://coplaydev.github.io/unity-mcp/contributing/dev-setup) docs.
73
+
See [CONTRIBUTING.md](CONTRIBUTING.md). Branch off `beta`, not `main`. The full dev setup, testing, and release process live in the [Contributing](https://scriptwonder.github.io/unity-mcp/contributing/dev-setup) docs.
> Wu, S., & Barnett, J. P. (2025). MCP-Unity: Protocol-Driven Framework for Interactive 3D Authoring. In *SA Technical Communications '25*. Association for Computing Machinery. https://doi.org/10.1145/3757376.3771417
97
-
98
-
**BibTeX**
88
+
If MCP for Unity helped your research, please cite it.
If your work uses a particular subsystem (tool registry, transport, custom tools, etc.), a link back to this repository is appreciated alongside the citation.
Copy file name to clipboardExpand all lines: website/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# MCP for Unity — Documentation Site
2
2
3
-
Docusaurus 3.x site for MCP for Unity. Deployed to https://coplaydev.github.io/unity-mcp/ by `.github/workflows/docs-deploy.yml` on every push to `beta` or `main` that touches `website/**`, `docs/**`, or the Python tool registry.
3
+
Docusaurus 3.x site for MCP for Unity. Currently deployed to https://scriptwonder.github.io/unity-mcp/(Scriptwonder fork preview) by `.github/workflows/docs-deploy.yml` on every push to `docs/v2-wiki-refresh` or `beta` that touches `website/**`, `docs/**`, or the Python tool registry. When upstream Pages is enabled, the canonical URL flips to `coplaydev.github.io/unity-mcp`.
Copy file name to clipboardExpand all lines: website/docs/contributing/docs.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -118,7 +118,7 @@ Do not hand-edit `releases.md` or the `recent-updates` block in `README.md` —
118
118
119
119
## Deploy
120
120
121
-
The live site at `https://coplaydev.github.io/unity-mcp/` deploys automatically on push to `beta`. No manual step per change.
121
+
The live site at `https://scriptwonder.github.io/unity-mcp/` deploys automatically on push to `beta` or `docs/v2-wiki-refresh`. No manual step per change. Once the docs land on upstream, the deploy flips back to `coplaydev.github.io/unity-mcp` from upstream's `beta`.
0 commit comments