mirror of
https://github.com/TemujinCalidius/SurvivorCore.git
synced 2026-08-14 09:02:29 +00:00
docs: make admin-plugin install explicit + discoverable
Owner feedback: synced the engine into a fresh place, couldn't find the admin plugin. Root cause is a docs gap — nothing told the reader that a plugin is installed separately from a place sync. - admin-plugin.md: lead the Install section with the key distinction (it's a Studio editor tool, not place content, so an engine sync does NOT install it); add per-OS plugins-folder paths (macOS / Windows); spell out the restart-once / hot-reload-after behaviour; and note the form needs a place with the engine synced (else the empty state), incl. the restart-drops-unsaved-sync caveat. - getting-started.md: link Survival Stats + the admin plugin from Next steps, flagging that the plugin installs separately from the engine. - README: add a "Tuning, no code" pointer to the admin plugin from the front page. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
4256edfd87
commit
2e7bd69c2c
+26
-4
@@ -6,16 +6,38 @@ It's the first slice of the [Builder / Admin plugin](https://github.com/TemujinC
|
||||
|
||||
## Install
|
||||
|
||||
Build it straight into your Studio plugins folder, then restart Studio:
|
||||
> **This is a Studio editor tool, not game content — so syncing the engine does _not_ install it.**
|
||||
> A Rojo sync (or the drop-in `SurvivorCore.rbxm`) populates a *place's* `ReplicatedStorage`. The
|
||||
> plugin is different: it lives in Studio's **local plugins folder** and runs in the editor across
|
||||
> every place you open. You install it **once**, separately from any place.
|
||||
|
||||
Build it straight into your local plugins folder:
|
||||
|
||||
```bash
|
||||
rojo build plugin.project.json --plugin SurvivorCoreStatAdmin.rbxm
|
||||
```
|
||||
|
||||
(Or build to a file — `rojo build plugin.project.json -o SurvivorCoreStatAdmin.rbxm` — and drop it
|
||||
into the local Plugins folder yourself: Studio → **Plugins** tab → **Plugins Folder**.)
|
||||
The `--plugin` flag writes the built model into Studio's plugins folder for you:
|
||||
|
||||
A **SurvivorCore › Survival Stats** button appears in the toolbar; click it to toggle the dock widget.
|
||||
| OS | Plugins folder |
|
||||
|---|---|
|
||||
| macOS | `~/Documents/Roblox/Plugins/` |
|
||||
| Windows | `%LOCALAPPDATA%\Roblox\Plugins\` |
|
||||
|
||||
(Prefer to place it by hand? Build to a file instead — `rojo build plugin.project.json -o
|
||||
SurvivorCoreStatAdmin.rbxm` — and drop it into that folder, or open it from Studio → **Plugins** tab
|
||||
→ **Plugins Folder**.)
|
||||
|
||||
Then **restart Studio** — a brand-new plugin's toolbar only registers when Studio loads it. (After
|
||||
this first install, re-running the `--plugin` build hot-reloads the plugin live, no restart needed.)
|
||||
A **SurvivorCore › Survival Stats** button then appears on the **Plugins** ribbon tab; click it to
|
||||
toggle the dock widget.
|
||||
|
||||
> **Open a place that has the engine in it.** The plugin tunes the stats of whatever place is open,
|
||||
> reading the live roster from `ReplicatedStorage.SurvivorCore` — so sync the engine (or drop in
|
||||
> `SurvivorCore.rbxm`) first. With no engine present it opens to an instructional empty state and
|
||||
> writes nothing. Note that restarting Studio drops an *unsaved* Rojo-synced place, so reconnect
|
||||
> Rojo and re-sync (or save the place before restarting) to bring the engine back.
|
||||
|
||||
## Using it
|
||||
|
||||
|
||||
Reference in New Issue
Block a user