Skip to content

Commit 1102512

Browse files
committed
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.
1 parent 156cefd commit 1102512

6 files changed

Lines changed: 29 additions & 36 deletions

File tree

.github/workflows/docs-deploy.yml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
name: Docs — Build & Deploy
22

3-
# Builds the Docusaurus site under /website and, on push to beta, deploys
4-
# to GitHub Pages at https://coplaydev.github.io/unity-mcp/.
3+
# Builds the Docusaurus site under /website and deploys to GitHub Pages.
4+
# Currently configured for the Scriptwonder fork preview:
5+
# https://scriptwonder.github.io/unity-mcp/
6+
# When upstream Pages is enabled, change `branches: [docs/v2-wiki-refresh]`
7+
# to `branches: [beta]` and revert the url/organizationName in
8+
# docusaurus.config.js back to CoplayDev.
59
#
610
# PR runs only build (no deploy) as a preview-validation step.
711
# Re-deploys also fire when the Python tool/resource registry changes,
812
# so M3's auto-generated reference pages stay fresh.
913

1014
on:
1115
push:
12-
branches: [beta]
16+
branches: [docs/v2-wiki-refresh, beta]
1317
paths:
1418
- website/**
1519
- docs/**
@@ -62,23 +66,23 @@ jobs:
6266
run: npm ci
6367

6468
- name: Setup Pages
65-
if: github.event_name == 'push' && github.ref == 'refs/heads/beta'
69+
if: github.event_name == 'push' && (github.ref == 'refs/heads/beta' || github.ref == 'refs/heads/docs/v2-wiki-refresh')
6670
uses: actions/configure-pages@v5
6771

6872
- name: Build
6973
working-directory: website
7074
run: npm run build
7175

7276
- name: Upload Pages artifact
73-
if: github.event_name == 'push' && github.ref == 'refs/heads/beta'
77+
if: github.event_name == 'push' && (github.ref == 'refs/heads/beta' || github.ref == 'refs/heads/docs/v2-wiki-refresh')
7478
uses: actions/upload-pages-artifact@v3
7579
with:
7680
path: website/build
7781

7882
deploy:
7983
name: Deploy to GitHub Pages
8084
needs: build
81-
if: github.event_name == 'push' && github.ref == 'refs/heads/beta'
85+
if: github.event_name == 'push' && (github.ref == 'refs/heads/beta' || github.ref == 'refs/heads/docs/v2-wiki-refresh')
8286
runs-on: ubuntu-latest
8387
environment:
8488
name: github-pages

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
#### Proudly sponsored and maintained by [Aura](https://www.tryaura.dev/) — the AI assistant for Unreal & Unity.
77
##### And don't miss [Godot AI](https://github.com/hi-godot/godot-ai), the new open source MCP/AI project from the makers of MCP for Unity.
88

9-
[![Docs](https://img.shields.io/badge/Docs-unity--mcp-4f46e5)](https://coplaydev.github.io/unity-mcp/)
9+
[![Docs](https://img.shields.io/badge/Docs-unity--mcp-4f46e5)](https://scriptwonder.github.io/unity-mcp/)
1010
[![Discord](https://img.shields.io/badge/discord-join-red.svg?logo=discord&logoColor=white)](https://discord.gg/y4p8KfzrN4)
1111
[![](https://img.shields.io/badge/Website-Visit-purple)](https://www.coplay.dev/?ref=unity-mcp)
1212
[![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=blue 'Unity')](https://unity.com/releases/editor/archive)
@@ -22,7 +22,7 @@
2222

2323
## Read the Docs
2424

25-
### **[coplaydev.github.io/unity-mcp](https://coplaydev.github.io/unity-mcp/)**
25+
### **[scriptwonder.github.io/unity-mcp](https://scriptwonder.github.io/unity-mcp/)**
2626

2727
---
2828

@@ -34,13 +34,13 @@ In Unity: **Window → Package Manager → + → Add package from git URL**, pas
3434
https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#main
3535
```
3636

37-
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).
3838

3939
Then **Window → MCP for Unity → Configure All Detected Clients**. That's it — try a prompt:
4040

4141
> Create a red, blue, and yellow cube in the current scene.
4242
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).
4444

4545
---
4646

@@ -54,7 +54,7 @@ Full walkthrough: [Your First Prompt](https://coplaydev.github.io/unity-mcp/gett
5454
* **[v9.6.5](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.5)** (2026-04-03)
5555
* **[v9.6.4](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.4)** (2026-03-31)
5656

57-
Full history: [Release Notes](https://coplaydev.github.io/unity-mcp/releases).
57+
Full history: [Release Notes](https://scriptwonder.github.io/unity-mcp/releases).
5858

5959
</details>
6060
<!-- recent-updates:end -->
@@ -70,32 +70,22 @@ Full history: [Release Notes](https://coplaydev.github.io/unity-mcp/releases).
7070

7171
## Contributing
7272

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.
7474

7575
## Advanced
7676

77-
- **Multiple Unity instances**[Multi-Instance Routing](https://coplaydev.github.io/unity-mcp/guides/multi-instance)
78-
- **Tool groups (vfx / animation / ui / testing / etc.)**[Tool Groups](https://coplaydev.github.io/unity-mcp/guides/tool-groups)
79-
- **Roslyn script validation**[Roslyn Validation](https://coplaydev.github.io/unity-mcp/guides/roslyn)
80-
- **Remote-hosted server with auth**[Remote Server Auth](https://coplaydev.github.io/unity-mcp/guides/remote-server-auth)
77+
- **Multiple Unity instances**[Multi-Instance Routing](https://scriptwonder.github.io/unity-mcp/guides/multi-instance)
78+
- **Tool groups (vfx / animation / ui / testing / etc.)**[Tool Groups](https://scriptwonder.github.io/unity-mcp/guides/tool-groups)
79+
- **Roslyn script validation**[Roslyn Validation](https://scriptwonder.github.io/unity-mcp/guides/roslyn)
80+
- **Remote-hosted server with auth**[Remote Server Auth](https://scriptwonder.github.io/unity-mcp/guides/remote-server-auth)
8181

8282
## Star History
8383

8484
[![Star History Chart](https://api.star-history.com/svg?repos=CoplayDev/unity-mcp&type=Date)](https://www.star-history.com/#CoplayDev/unity-mcp&Date)
8585

8686
## Citation
8787

88-
If MCP for Unity helped your research, teaching, or writing, please cite the paper that introduces the framework.
89-
90-
**Paper.** *MCP-Unity: Protocol-Driven Framework for Interactive 3D Authoring* — Shutong Wu and Justin P. Barnett, 2025.
91-
Published in **SA Technical Communications '25** (ACM SIGGRAPH Asia), Association for Computing Machinery.
92-
DOI: [10.1145/3757376.3771417](https://doi.org/10.1145/3757376.3771417) · ISBN: 979-8-4007-2136-6.
93-
94-
**APA**
95-
96-
> 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.
9989

10090
```bibtex
10191
@inproceedings{wu2025mcpunity,
@@ -111,8 +101,6 @@ DOI: [10.1145/3757376.3771417](https://doi.org/10.1145/3757376.3771417) · ISBN:
111101
}
112102
```
113103

114-
If your work uses a particular subsystem (tool registry, transport, custom tools, etc.), a link back to this repository is appreciated alongside the citation.
115-
116104
## Unity AI Tools by Aura
117105

118106
Aura offers 2 AI tools for Unity:

website/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCP for Unity — Documentation Site
22

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`.
44

55
## Local development
66

website/docs/contributing/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Do not hand-edit `releases.md` or the `recent-updates` block in `README.md` —
118118

119119
## Deploy
120120

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`.
122122

123123
### First-time setup (maintainers only)
124124

website/docusaurus.config.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ const config = {
2626
tagline: 'AI-driven game development for the Unity Editor',
2727
favicon: 'img/favicon.png',
2828

29-
// Hosted on GitHub Pages under the CoplayDev org.
30-
// Custom domain (CNAME) deferred — see plan Phase 2.
31-
url: 'https://coplaydev.github.io',
29+
// Currently hosted under the Scriptwonder fork until upstream Pages
30+
// is enabled. Flip url + organizationName back to CoplayDev once a
31+
// maintainer turns on Pages there.
32+
url: 'https://scriptwonder.github.io',
3233
baseUrl: '/unity-mcp/',
3334

34-
organizationName: 'CoplayDev',
35+
organizationName: 'Scriptwonder',
3536
projectName: 'unity-mcp',
3637
deploymentBranch: 'gh-pages',
3738
trailingSlash: false,

website/static/robots.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
User-agent: *
22
Allow: /
33

4-
Sitemap: https://coplaydev.github.io/unity-mcp/sitemap.xml
4+
Sitemap: https://scriptwonder.github.io/unity-mcp/sitemap.xml

0 commit comments

Comments
 (0)