01 · Install
Copy and enable the addon
Copy addons/prototir into the project and enable Prototir SDK under Plugins.
The Godot addon adds a project dock, safe setup fixes, export guard, automatic manifest generation, and a GDScript adapter for Prototir capabilities. Choose how you build below: setup, export, manifest, SDK and testing follow your choice.
Godot Web documentation selected
01 / Godot setup
Selected: Godot
This section changes with the platform selector. Shared packaging, publishing, page, and community guidance stays below it.
01 · Install
Copy addons/prototir into the project and enable Prototir SDK under Plugins.
02 · Prepare
Resolve blocking issues, apply available safe fixes, and review target-specific recommendations.
03 · Export
Export Web to a clean folder, ZIP its contents, upload, and test the production sandbox.
Good fit
Scenes, nodes, resources, animation, and Godot input can stay in the project. The addon connects the exported game to Prototir and checks the Web preset before export. Project > Tools > Prototir: Publish to Prototir (Web) exports, uploads, and opens the upload page with the build already attached.
Current boundary
Forward+ rendering, threaded Web exports, GDExtension, PWA/service workers, and Godot C# Web output are not supported by this profile.
Install and connect
Install the tagged addon into the project. The editor checks for a newer addon once a day and offers it in the Prototir dock with one click. On Prototir, your web build always runs the current feedback tools, without exporting again:
1. Download the v0.4.0 release.
2. Copy addons/prototir into the project.
3. Enable Prototir SDK under Project Settings > Plugins.
4. Open the Prototir dock and review the setup report.The addon installs Prototir as an autoload. Signal readiness from the first usable scene.
extends Node
func _ready() -> void:
Prototir.ready()
Prototir.event("scene_ready")Supported profile
Input and player behavior
The generated canvas fills the player, but your project still owns input actions, pause behavior, touch controls, and its response to focus or fullscreen changes.
02 / Start
Prototir hosts finished client files, not a source repository, editor project, or development server. Browser builds need an HTML entry and their runtime assets in a ZIP. Native builds need the executable and its runtime files, packaged for each supported platform and architecture. You can publish either format or both on one prototype page.
Example · Godot Web export
WebBuild/
|-- index.html
|-- index.js
|-- index.wasm
|-- index.pck
`-- prototir.jsonGodot is selected. Changing the platform above updates this export, setup, manifest, SDK syntax, and testing guidance together.
03 / Build
A root-level prototir.json lets the upload pipeline validate the correct runtime
profile, entry, devices, permissions, thumbnail, and platform features. The Unity and Godot
SDKs generate it during export; Web creators can write it directly.
{
"entry": "index.html",
"thumbnail": "auto",
"devices": ["desktop", "mobile"],
"orientation": "landscape",
"runtime": {
"engine": "godot",
"engineVersion": "4.3",
"profile": "standard"
},
"permissions": [],
"ai": { "mode": "disabled" }
}| field | accepted values | purpose |
|---|---|---|
runtime | web, unity, or godot · standard profile | Declares the engine and exact engine version so Prototir can validate the exported shape. |
entry | relative HTML path | Use a generated entry outside the root, which Prototir copies to the served root. |
thumbnail | auto, or a bundle-relative image path | auto captures the first available visual frame after upload,
including an intro or cutscene. A bundle-relative PNG, JPEG, or WebP travels
with the ZIP and prototir.json, bypasses runtime capture, and is the deterministic
choice when the representative scene appears later. Alternatively, upload a
Prototir-hosted custom image (up to 2 MB); it overrides the portable source
until you switch back in Studio. The last source you save wins. Use 1280×800
(16:10) where possible. Cards center-crop it to 16:10 and 16:9. |
modules | Web builds · exact name@version specs | Prototir starter modules, added to an import map. Other libraries: import them from a public CDN with an exact version and the upload copies them into the build. Unity and Godot dependencies must be included by their exporter. |
permissions | camera, microphone, geolocation, clipboard, midi | The player asks the visitor before granting device access, and remembers the answer for that prototype until they change it. clipboard allows copying only, never reading. |
network | Up to 10 domains, e.g. api.example.com, *.supabase.co | The only external sites the build may fetch, open WebSockets to, or load images and media from. Players see the list. Scripts still load only from the Prototir CDN. |
devices | array of desktop, mobile, xr | Declares every supported device target. Legacy desktop, mobile, and both strings remain accepted. |
xr | modes and WebXR features | Required when devices contains xr; controls explicit WebXR capability delegation. |
orientation | any, portrait, landscape | Shows the intended viewport orientation. |
ai | disabled, managed | Enables Prototir's provider-neutral managed gateway. API keys, provider names, and model ids do not belong in the manifest. |
Supported by every browser build path. Test keyboard, pointer, focus, audio, resize, and fullscreen.
Supported by every browser path when the experience has touch controls, responsive layout, and a tested orientation.
Use only a target guide that explicitly supports your WebXR stack. Declare xr devices, modes, and features before requesting a session.
04 / Build
Web, Unity, and Godot use APIs shaped for their runtime. Capabilities differ between browser and native builds. The selector above is currently showing Godot. Call Ready only after the first meaningful interaction is possible. For browser builds, preview generation does not wait for Ready. Native-only publications require a cover image.
Prototir.ready()
Prototir.event("level_complete", {"level": 2})
Prototir.score(1200)| Capability | Kind | What it can do |
|---|---|---|
| Ready | function | Starts a real session after the prototype becomes interactive. |
| Event | function | Records a small, non-personal milestone. Its normalized name, sessions reached,
and total triggers appear in creator analytics. Use stable names made from
letters, numbers, _, -, ., or :. |
| Score | function | Reports the current numeric score. |
| Storage | member | Contains asynchronous get, set, and remove functions
for browser-local strings scoped to the prototype and player, with up to 64 keys and 64 KiB of UTF-8 data per value. |
| Managed AI | member | Provider-neutral generation when managed AI is enabled for the browser build. |
| Seeded RNG | function | Returns deterministic local randomness. Currently exposed by the browser SDK. |
Prototir.ai.generate() works in two ways, chosen per prototype on its own page.
Either way visitors never pay and never see a key, prompts and replies are scanned, and
the player shows an AI-powered disclosure. Prompt text leaves the device.
model in the call; the page's choice wins.var save_request := Prototir.storage_set("difficulty", "hard")
await save_request.completed
var load_request := Prototir.storage_get("difficulty")
var difficulty = await load_request.completedvar request := Prototir.ai_generate(
"Give the player a short quest hook.",
80
)
request.completed.connect(func(text): print(text))
request.failed.connect(
func(code, message): push_warning("%s: %s" % [code, message])
)prompt is required and limited to 32,000 characters.maxTokens is optional, must be positive, and is capped at 4,096 output tokens
or the remaining allowance.model is optional and only used with your own key, when the prototype's
page leaves the model empty, for example 'openai/gpt-5-mini' on OpenRouter.{ code, message }. Handle sign_in_required, quota_exceeded, team_fair_share_exceeded, prototype_allowance_exceeded, ai_rate_limited, ai_blocked, missing_creator_key, moderation errors, provider_error,
and timeout.The rest is configured on the prototype's own page, not in code, under "AI": the mode, the provider and model for your own key or the Prototir AI model and fallbacks, whether a visitor must sign in to use it, and an optional daily token cap per visitor. Defaults (AI off, sign-in required) are chosen to be safe and cheap out of the box. Turning off sign-in lets anonymous visitors use AI too, metered per visitor by IP instead of by account. You still pay either way; there's just no account to individually rate-limit, so it's a frictionless-demo versus coarser-abuse-protection trade.
With Prototir AI, each model costs what it costs to run plus Prototir's margin, taken from your plan's daily allowance. Once that is spent, AI keeps working out of any purchased AI credits (one-time top-ups you buy from Studio). Once both are spent, Prototir AI pauses until the next daily reset, or more credits. A Team org's daily allowances and credits are shared across every prototype the org owns.
First action, onboarding completion, important tool use, level completion, creation/export, retry, and a clearly named abandonment point.
Use stable short names and small values. Never place names, email addresses, free-form messages, secrets, or other personal data in event payloads.
05 / Build
A session is one play. Prototir counts it as real once it lasts at least three seconds and reports at least one event, and almost everything you care about is built on real sessions rather than on opens.
That threshold is also the reason a prototype can look unplayed while people are clearly playing it. A build that never calls Ready and never reports an event has no real sessions, so its analytics stay near zero and it has no real use to rank with. Browser comments require real play; native feedback from an approved device uses its pairing authorization.
Starts the clock. Call it on the first frame the visitor can actually do something, not when loading finishes: a two minute cutscene before any input is not two minutes of play. Calling it twice does not restart anything.
Marks a milestone. One event is what turns an open into a real session, so report the first meaningful action early rather than only at the end of a level nobody reaches.
Reports a number. The best score of the session is the one kept, so a run that ends badly does not erase what the player achieved. Challenge leaderboards are built from scores on real sessions.
Names are lowercased and must be 1 to 64 characters of letters, numbers, _, -, . or :. Anything else is dropped rather than corrected, so Level Complete records nothing while level.complete records what you meant.
Pick names once and keep them. A name that changes between builds splits one behaviour across two rows and makes the before and after impossible to compare. Prototir keeps up to 50 distinct names per session; past that the events still count towards the total, but the per-name breakdown stops growing, which is what stops one runaway loop from becoming your entire analytics page.
Your prototype's analytics shows each event by name with two numbers: how many sessions reached it, and how many times it fired in total. The two together are the useful part. A step reached by few sessions is a wall; a step fired many times within few sessions is a retry loop. Duration buckets sit beside them as a rough drop-off curve.
A web build runs inside the shell, which watches it and reports for it. A native build has no shell, so the SDK keeps its own count and sends one session for the play instead of a request per event. The SDK reports periodically and when the window loses focus. You can also flush at a natural break; unsent data is retained for the next launch.
A native build also reports nothing until a tester has paired it, because until then there is nobody to attribute the play to. Running from the editor never reports: your own testing does not belong in your own numbers.
06 / Build
A prototype is one page with one set of comments, and it can be reached in more than one way: played in the browser, run as a native build on Windows, macOS or Linux, or both at once. Each of those is a build, they sit side by side, and none of them is the main one.
The publish form starts empty with one Add a build button, and the browser build is the first option in the same list as the rest. What you add decides how the prototype is delivered: a browser build alone plays on the page, platform builds alone are native only, both gives you both. Nothing is a one-way door, and the rest can be added later from Studio.
For a web prototype we take a screenshot of it running. A native build never runs on our machines, so there is nothing to capture. Your cover is the only picture the prototype has, on its page and everywhere it is listed.
Each platform build says which processor it is for, because a visitor handed the wrong one gets an app that will not start. The words differ per platform, on purpose: they are the words owners of those machines use for their own hardware.
Windows and Linux. x86-64 for the usual desktop processor, ARM64 for machines like a Snapdragon X laptop, and Any 64-bit for one file that runs on either.
macOS. Intel and Apple Silicon, which is how Apple splits its own machines and what About This Mac says, plus Universal for a binary holding both.
We do not say "Intel or AMD" for the desktop processor. That names two companies for what is really an instruction set: other vendors make chips that run it, and a Snapdragon X laptop is a Windows machine with neither company inside it.
A web prototype runs inside our sandbox and we are accountable for containing it. A native build runs on the visitor's own computer, where we have no such control, and the prototype page says so plainly rather than leaving people to assume otherwise.
We do not sign or notarize your build, and we do not broker anyone else doing it. Expect Windows SmartScreen and macOS Gatekeeper to warn people before opening an unsigned app, and expect the occasional antivirus false positive on engine builds. Signing is yours to arrange if you want those warnings gone.
The Godot addon adds Project > Tools > Prototir: Export for Prototir (Native). It exports with your preset for the machine you are on, zips the result, and writes the build id beside it. Exporting for the other desktop platforms needs their export templates, so those stay in the normal Export dialog.
A zip, not a bare executable: an executable on its own leaves its data folder behind, which is the most common way a download arrives broken.
A native build has no browser session, so it cannot know who is playing, and a sign-in inside an embedded browser is both refused by most providers and a bad idea anyway. Instead the build shows a short code and a QR, the tester approves it on prototir.com, and the build receives a token for that one prototype. They approve once per machine, not once per session, and they can revoke any build from their account settings.
Until that happens the build reports nothing and cannot send feedback, which is deliberate: there is nobody to attribute a play to. Draw the code however suits your game. The SDK hands you the code, the link and a ready-made QR and draws none of it, because it cannot know your art direction, your input model, or whether you are in VR.
You do not set the slug. It does not exist until the prototype does, so there was no value you could have put in the first export anyway. Prototir writes it into the .zip while you upload, and the build reads it on the machine it is downloaded to. Export once, upload once, done.
Set it by hand only when you need to override that: in Project Settings > Prototir for a build you ship outside Prototir, or an installer we cannot write into. The injected slug wins wherever both exist, because it travelled with that exact download.
As the file arrives, Prototir looks for the SDK in it and writes your slug beside the executable. If it cannot find the SDK, it says so on the prototype page straight away, because a build without it can download perfectly and still report nothing, and there is no later moment when you would find that out.
Both of those are checks against a mistake, not against someone determined. A native build runs on someone else's machine where we can check nothing, and anyone who wanted to fake the reports could. We would rather say that than imply a guarantee we cannot make.
The slug can only be written into a .zip. An installer or a disk image gets uploaded as it is, and you set the slug in the SDK yourself.
prototir-build.json into the build, and Prototir records that id from the archive you upload. A running build reports
the same id when it pairs, so a mismatch tells you a tester is playing an older build than the
one on the page. That is all it does, and nothing depends on it: both sides come from a file
you control, so it is not verification, not security, and not anti-cheat.Adding builds also changes how people find you. Discover asks two separate questions: what device someone is holding, and how they want a prototype to reach them. A build for Windows, macOS or Linux puts you in the second one, under How you play › Native, and again under the operating systems you actually ship. Drop a platform in a later release and you leave that filter, because it matches the build on offer now rather than one you used to have.
Everything lives under Studio › your prototype › Builds: one collapsible panel per platform, the browser build among them rather than above them. Add a platform you did not ship at first, replace one, or remove one, at any time. If a browser build remains, removing the last native build leaves a browser-only prototype. Native builds have independent versions; replacing a browser build does not remove them.
Platforms drift apart in practice: a Windows crash gets fixed the same evening while macOS waits for the next build. One version for the whole prototype would have to be wrong about one of them, so each keeps its own and the page shows which is which.
Replacing your browser build does not touch the others, and neither does rolling back to an earlier one.
Comments and plays are recorded against the build they happened on, so "this crashes on launch" stays attached to the build it was true of. Two different files both called v1.2 would make that a lie, which is why Prototir asks you to move the number.
The build you replace is kept, so you can put it back at any time. Anything older than that is deleted for you, and there is nothing to decide or tidy up: once several platforms each have their own history, choosing per replacement means nobody can tell which builds are still taking up space. Records outlive the files either way, so the feedback on a build you replaced stays attached to it.
Because feedback knows which build it came from, the comments on a prototype page can be narrowed to one platform, and every comment says whether it came from the browser or from a particular build. A crash report from Windows v1.2 is a different fact from the same words typed in a browser, and the page no longer makes you guess which you are reading.
07 / Publish
Show what can be touched, clicked, typed, dragged, or controlled. Avoid an unexplained blank canvas or loader with no progress.
Fill the available player, react to resize and fullscreen changes, avoid fixed desktop-only dimensions, and honor the declared orientation.
Test keyboard, pointer, touch, focus, Escape, and visible controls using the APIs or input system of your selected runtime. Pointer lock must start from a visitor action and release cleanly.
Give visitors a restart path, useful empty states, and a clear response when an optional permission, storage call, or AI request is denied.
Compress exported assets, defer secondary content, cap rendering cost, and test the first load on a real phone and ordinary connection.
Use readable contrast, semantic or accessible controls, labels, keyboard access, reduced-motion handling, and alternatives to audio-only or color-only information.
The Godot input, device compatibility, packaging, and testing checks are in the setup section above. Change the platform selector to replace them without opening another guide.
08 / Publish
09 / Publish
Only publish files you own or are allowed to distribute. Keep third-party license and attribution files in each build. Browser source download and templates apply to the browser ZIP; compiled native builds do not provide an editable engine project. If you enable browser source download, choose a license that actually grants the permissions you intend.
Visitors can download the original browser ZIP under your stated license. Platform-generated provenance is added to the downloaded manifest.
Declare the source slug or re-upload a Prototir browser source download. The origin remains linked and conflicting lineage is rejected.
A template is a complete browser starter prototype with source download enabled. Its downloads carry template provenance into later uploads.
10 / Publish
Anything a browser renders is delivered to that browser. An authorized visitor can inspect network requests and save JavaScript, models, textures, audio, video, WebAssembly, and data. Private visibility prevents anonymous access, but it cannot stop an invited viewer from capturing files they are allowed to run. This is equally true for direct Web code, Unity WebAssembly, and Godot Web exports.
The browser publisher can rewrite served .js files into compact,
less-readable code. This deters casual copying; it is not encryption or DRM. It does
not transform WebAssembly, engine data files, .mjs, inline code, source
maps, models, textures, or other assets. Unity and Godot already compile/package much
of their runtime output, but that output is still downloadable. The retained original
ZIP remains unchanged. Native builds are delivered as uploaded; arrange code signing
or notarization yourself when required by the operating system.
Keep production masters outside the ZIP. Export a runtime derivative: remove editor data and source maps, reduce geometry and texture resolution, use formats such as GLB with Draco or Meshopt and KTX2 where appropriate, and consider a visible or forensic watermark. Compression and renamed files add friction, but do not make client-rendered assets secret.
Rule of thumb: if disclosure would cause serious harm, do not include that file in a browser-delivered prototype. Use a reduced derivative, a watermark, or a server-side rendering approach instead.
11 / Publish
A replacement is an internal build of the same prototype. It keeps the stable URL, comments, and aggregate analytics, and does not count as another Free, Pro, or Team prototype. For browser builds, the current version stays live while the candidate is tested. Native versions are managed independently for each platform and architecture.
Browser builds support rollback and cleanup after a replacement passes. Native builds keep their own versions, and replacing the browser build does not remove native builds. Comment attribution remains tied to the build used. Publish a separate public release only when you want another listing, URL, and prototype slot.
12 / Grow
Every build that uses the SDK gets a Feedback & tools control, with nothing for you to add: Screenshot, Comment, Console and Performance. Testers point at what they mean and send what they saw with their comment.
Captures the moment without the control on it. The tester places a pin on the image and writes what they mean, because a seed and a timestamp do not reproduce a procedural scene.
A plain comment on the prototype, with the same moderation and wall controls as any other.
Recorded from the moment the build starts, so the error a tester saw before opening the panel is already there. They can copy it or attach it to a comment, where it shows collapsed and capped to its last 200 lines.
A frame-rate chart with the slowest frame and memory, recorded only while the panel is open. A summary can be copied or attached to a comment.
A screenshot, a console log or a performance summary is always sent with a message: it is what the comment is about, never a comment on its own. Recording costs almost nothing while the panels are closed.
Inside the Prototir player, Feedback & tools sits beside Restart and Fullscreen.
In embeds it sits in the Prototir badge, which stays visible while feedback is on. On
your own site, set project and the SDK draws the control itself.
Prototir.review_enable("my-prototype")Turning comments off for a prototype turns feedback off with it.