Bring the repo's own front page up to what actually exists now
The root README was written when none of this was published, and it showed.
The install block was BROKEN in the same way the registry README's was, and I
fixed that one without looking here:
bunx vibe3d init
bunx vibe3d add @medieval-kit/wooden-barrel
`init` seeds `models.json` with `@scifi-kit` only, so the second line stops with
`Registry @medieval-kit is not configured in models.json`. The registry entry
and the two dependencies are now in the block, in the order they have to be run.
The npm link pointed at a file in this repository rather than at the package,
because when it was written there was no package to point at. There is now.
Neither document linked the live viewer at all — the one thing a stranger
landing here can use without installing anything. It is the second thing on the
page now.
REFERENCE's "publish your own registry, you need nobody's permission" section
gets the receipt: this registry is live and vibe3d was not involved. It also
gets the warning I would have wanted before doing it — npm stamps the
publishing account's email into the packument per version and later account
changes do not rewrite it, so the address on the account at that moment is
public permanently.
Checked every outbound link in both documents as a logged-out stranger: bun.sh,
vibe-stack/vibe3d and medieval.crt.fyi all 200. npmjs.com answers 403 to a
scripted request, which is its bot protection and not a broken link — the
registry API serves 0.1.1 as latest.
Still 404 for a stranger, and deliberately: github.com/CRTkafa/medieval-kit and
its /issues, which npm renders as the Repository and Issues links on the
package page. They come back the moment the repository goes public.
This commit is contained in:
parent
f2a8e304ce
commit
be8c7a485d
2 changed files with 38 additions and 5 deletions
35
README.md
35
README.md
|
|
@ -7,11 +7,14 @@ Vibe3D is a source-first model registry for Three.js: you install the
|
||||||
TypeScript that *generates* a model into your own project rather than depending
|
TypeScript that *generates* a model into your own project rather than depending
|
||||||
on an opaque package. This repository holds one such registry.
|
on an opaque package. This repository holds one such registry.
|
||||||
|
|
||||||
- **[`my-registry/`](my-registry/)** — the `@medieval-kit` registry, published
|
- **[`my-registry/`](my-registry/)** — the `@medieval-kit` registry, on npm as
|
||||||
to npm as [`@medieval-kit/registry`](my-registry/README.md).
|
[`@medieval-kit/registry`](https://www.npmjs.com/package/@medieval-kit/registry).
|
||||||
- **`src/`** — a demo app that installs from both `@medieval-kit` and the
|
- **`src/`** — a demo app that installs from both `@medieval-kit` and the
|
||||||
first-party `@scifi-kit`, so the two can be inspected side by side.
|
first-party `@scifi-kit`, so the two can be inspected side by side.
|
||||||
|
|
||||||
|
**[Open the viewer →](https://medieval.crt.fyi/)** — every model in the kit,
|
||||||
|
turn it over, pull its sliders, press play. No install, no sign-in.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
37 models and one shared library, **30,390 triangles** for the whole kit — less
|
37 models and one shared library, **30,390 triangles** for the whole kit — less
|
||||||
|
|
@ -45,11 +48,28 @@ overlay, and per-model GLB download.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
bunx vibe3d init
|
bunx vibe3d init
|
||||||
bunx vibe3d add @medieval-kit/wooden-barrel
|
bun add three
|
||||||
|
bun add -d @types/three
|
||||||
```
|
```
|
||||||
|
|
||||||
See [`my-registry/README.md`](my-registry/README.md) for the model list,
|
`init` writes `models.json` and seeds it with `@scifi-kit` only, so add this
|
||||||
configuration fields, and runtime contract.
|
registry to the `registries` object it created — `vibe3d add` resolves the
|
||||||
|
namespace through that map and stops without it:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"@medieval-kit": { "source": "npm:@medieval-kit/registry", "version": "latest" }
|
||||||
|
```
|
||||||
|
|
||||||
|
Then take one model, or the lot:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
bunx vibe3d add @medieval-kit/wooden-barrel
|
||||||
|
bunx vibe3d add @medieval-kit
|
||||||
|
```
|
||||||
|
|
||||||
|
See [`my-registry/README.md`](my-registry/README.md) for the model list, the
|
||||||
|
`tsconfig.json` the installed source needs, the configuration fields and the
|
||||||
|
runtime contract.
|
||||||
|
|
||||||
## Export to GLB
|
## Export to GLB
|
||||||
|
|
||||||
|
|
@ -170,6 +190,11 @@ to 404.
|
||||||
Beside it is `artifact.html`, the same viewer collapsed into one self-contained
|
Beside it is `artifact.html`, the same viewer collapsed into one self-contained
|
||||||
file. That is the one to hand to anyone who wants it without a server.
|
file. That is the one to hand to anyone who wants it without a server.
|
||||||
|
|
||||||
|
This output is what runs at [medieval.crt.fyi](https://medieval.crt.fyi/),
|
||||||
|
rebuilt on every push. The social card it links to is built there too, by
|
||||||
|
`bun run cover:build`, so the model count on the card is counted rather than
|
||||||
|
typed and cannot fall behind the kit.
|
||||||
|
|
||||||
## Layout
|
## Layout
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
|
|
||||||
|
|
@ -328,6 +328,14 @@ install with the same CLI. **You do not need anyone's permission** — you can
|
||||||
publish your own registry without touching the vibe3d repository. The
|
publish your own registry without touching the vibe3d repository. The
|
||||||
architecture document states this as an explicit goal.
|
architecture document states this as an explicit goal.
|
||||||
|
|
||||||
|
This one is live, which is how the claim stopped being theory:
|
||||||
|
[`@medieval-kit/registry`](https://www.npmjs.com/package/@medieval-kit/registry).
|
||||||
|
Publishing needed 2FA on the npm account and an org owning the `@medieval-kit`
|
||||||
|
scope; nothing was needed from vibe3d itself. Worth knowing before you publish
|
||||||
|
your own: npm stamps the publishing account's email into the packument per
|
||||||
|
version, and later account changes do not rewrite it — so whatever address is
|
||||||
|
on the account at that moment is public for good.
|
||||||
|
|
||||||
### Size warning
|
### Size warning
|
||||||
|
|
||||||
`registry.json` keeps all the source embedded. `@scifi-kit/registry@0.0.1` →
|
`registry.json` keeps all the source embedded. `@scifi-kit/registry@0.0.1` →
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue