Publish a space
publishPublish a browser game, world, tool or wonder on Velven's hosting, from one HTML page or a small set of files (3 MB in all). Signed in: a private preview by default, or with prod: true the next live version after Velven's safety check. Not signed in: an unlisted page, live after the check, returned with a claim token that keeps it. A new space needs title, type and devices from the person. To update a space pass space (signed in) or claim (not signed in).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sdk | No | Add Velven's SDK script to the entry page. Default true. | |
| spa | No | Serve the entry page for any unknown path (a single-page app). | |
| html | No | A whole page as one HTML string, published as index.html. | |
| prod | No | Go live after the safety check instead of a preview. Signed in only. Default false. | |
| type | No | What it is. Required for a new space. | |
| claim | No | The claim token of an unlisted page: publishes its next version, or claims it when signed in. | |
| entry | No | The page that opens first, if not index.html. | |
| files | No | Files by relative path: text as a string, binary as { "base64": "..." }. Must include the entry page (index.html unless entry says otherwise). A velven.json, a dotfile, a dot-folder or node_modules, in any folder, is left out (never published; the result names the first 10 and counts the rest): send velven.json's settings as this tool's fields. | |
| space | No | Publish a new version of this space (yours, signed in). | |
| title | No | The space's name. Required for a new space. | |
| engine | No | What it draws with, if one of these. | |
| devices | No | Where it can be played. Required for a new space. | |
| how_made | No | How it was made, in the creator's words. | |
| description | No | One line under the name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| space | Yes | The space's slug. | |
| terms | No | The Terms line to show the person (no account). | |
| status | Yes | The version's status: preview, checking (in the safety check) or live. | |
| leftOut | No | Files not published (velven.json, dotfiles, node_modules), the first 10. | |
| pageUrl | Yes | The space's page on Velven. | |
| version | Yes | The version this publish made. | |
| claimUrl | No | Open signed in to claim the page (no account). | |
| watchUrl | No | Where to follow the check. | |
| expiresAt | No | When an unlisted page is deleted unless claimed (no account). | |
| claimToken | No | The unlisted page's claim token, shown once (no account). | |
| previewUrl | No | The private preview, for 24 hours (a preview only). | |
| leftOutCount | No | How many files were left out in all. |