Quickstart

Integrate a generator built with any tech stack into Atomm: create a generator → add one line of SDK and integrate capabilities → preview and debug locally in real time → submit for review and publish. No command-line tools required.

Any stack that outputs static web files works

Plain HTML, Vite, Vue, React — any tech stack works. Atomm communicates with your app through a browser-side SDK and doesn't constrain how you build it.

End-to-end flow

1. Create a generator in the Developer Console

Start by picking a name to serve as its public identifier (must start with a lowercase letter and contain only lowercase letters, digits, and hyphens -; it cannot be changed after creation, as it becomes part of the runtime subdomain and access path). After creation you'll land on the app detail page to continue setup. This name is used again in local preview and final publishing.

2. Add the SDK to your app and integrate capabilities

Add one script tag to your page to get the global atomm object:

<script src="https://static-res.atomm.com/scripts/js/generator-sdk/platform-sdk.js"></script>

Then integrate platform capabilities as needed. Taking export as an example, this takes two steps — place an export button placeholder element (the SDK renders it in place as an Export button), and register an export hook to supply the resulting file:

<!-- Place anywhere on the page; the SDK renders it in place as an Export dropdown -->
<div data-atomm-export-button></div>
// The platform calls back into your app for the result file when the user clicks export
atomm.lifecycle.on('export', async () => ({ filename: 'design.glb', blob }))

See the atomm object and export capability for details.

3. Start your local server, then preview and verify in real time in the browser

Start your local server (e.g. http://localhost:5173), build the preview URL using the generator name from step 1, and put your local address into ?local= (only loopback addresses such as localhost / 127.0.0.1 are supported):

https://www.atomm.com/creativetools/community/generator/<generator-name>?local=http://localhost:5173/

DevTool runs your local app inside the same environment it will run in live, and previews it there. The integration assistant panel on the right shows whether the SDK is loaded and lists the platform capabilities available to integrate, so you can verify in the preview that export and other capabilities are being invoked correctly. You can also open this directly from the "Local debugging" card on the app detail page by entering your local address. See Local debugging for details.

4. Upload the artifact, submit for review, and publish

On the app detail page's configuration card, add your listing information, upload the packaged artifact, and submit for review. Once approved, it's automatically published to https://www.atomm.com/creativetools/community/generator/[generator-name], and users can open and use it directly from the generator gallery — no installation required. See Submitting for review and publishing for details.

Ready to publish your generator?
Create a generator in the Developer Console, complete its listing details, and submit it for review — once approved, it goes live on the generator gallery.
Esc
Search all docs · to navigate · to open