0xDocs 0x.limo

Docs / Getting started

Developer portal

The two browser pages for developers, the upload page (api.0x.limo/hosting/) and the store submission form (api.0x.limo/dev/submit), field by field.

You can do everything the CLI does from two pages in the browser. Both sign you in with your 0x username and password.

PageURLFor
Uploadapi.0x.limo/hosting/ (also 0x.limo/publish)Publishing a web game as a hosted site version
Submitapi.0x.limo/dev/submitStore listings, review issues, site policy reports, payouts
In-game itemsapi.0x.limo/dev/itemsItems you sell inside your game (see Monetization)

#Upload page: /hosting/

Sign in, or create an account on the same page. Then fill in:

FieldWhat it does
Site nameThe site's id: 3–40 characters, a-z, 0-9 and -, not starting or ending with -. It is globally unique, and its first upload creates the site. Your game is served at https://<site>-play.0x.limo/sites/<site>/<n>/. Platform host names (such as api, play, www, docs, store) are reserved.
Folder or .zipDrop the built folder, or choose a .zip. index.html must be at the top. Hidden files are skipped. Programs and installers are refused (see hosting limits).
Security policy (optional)What your page loads from other sites. Enter one origin per line for each kind: Connections (fetch, XHR, WebSocket; wss:// allowed), Images, Audio and video, Fonts, Scripts and Frames. Use https:// origins only. A wildcard is allowed only as the whole first label, as in https://*.example.com.
PermissionsTick only what your game uses: camera, microphone, location, USB, serial, HID, payment. Each one stays off unless ticked. Fullscreen, gamepad and autoplay are always allowed.
eval() / new Function()Allows eval in scripts ('unsafe-eval').
<style> elements made at runtimeAllows <style> elements that your scripts create.

The security section is the browser form of "csp" in 0x.config.json. Inline <script> and <style> that ship in your HTML are allowed automatically, by hash.

Publish uploads only the files the service does not already have (files are content-addressed by SHA-256). It then finalizes the version and shows the play URL. Each publish creates a new, immutable version number.

Tip

Add <script type="module" src="./x1/boot.js" data-entry="./main.js"></script> to index.html instead of loading your entry script directly. Without x1/boot.js, players load every file from the origin and nothing goes through the swarm. The x1/ runtime and x1-sw.js are added to every version for you.

#Submission form: /dev/submit

This form creates a store listing, or a new version of one you already have. The CLI equivalent is 0x submit. Every field and limit is described in Listing fields.

SectionFields
Your gameTitle (≤ 80), ID (3–64, a-z 0-9 -, your store id), Tagline (≤ 200), Description (≤ 4000), Tags (comma-separated, ≤ 16)
How players play itWeb game (hosted site), Hosted game server or My own Paper server. Then: Play URL (an https page), or Hosted site id + Site version; for Paper, Server host and port.
Release stageKeep the game's current stage (a new game: full release), Full release, or Playable demo of an upcoming release (listed under Upcoming releases). See Release types.
Age ratingeveryone, teen, mature or adults-only: your own declaration, which the reviewer checks. See Age ratings.
ArtCapsule (PNG, ≤ 1 MiB, required on the first submission). Screenshots (PNG or JPEG, up to 6, ≤ 2 MiB each). See Store art.
Trailer (optional)A YouTube or Vimeo link, or an MP4/WebM file of at most 60 MB. If you leave it empty, an update keeps the current trailer. Remove the current trailer deletes it.
Details (optional)Controls (keyboard and mouse, gamepad, touch), Works on phones, Single-player / Multiplayer, Most players at once (1–100000), Languages, Download size in MB (measured for you on hosted sites), Release notes for this version (≤ 4000)

Your submissions lists each listing with its latest version, status (pending, approved, rejected), the reviewer's note and review issue counts. The same page also has these panels:

  • Review issues: threads from reviewers, which you can answer and mark "fixed in version N". The CLI equivalent is 0x issues.
  • Site security policy: the Content-Security-Policy and Permissions-Policy each of your hosted sites is served with, and what browsers reported blocking.
  • Payouts: your USDT payout address per network and the auto-payout threshold. This panel appears only when payouts are on for the service.

Note

The form says "Free games only for now". 0x submit always sends "price": "free". For paid games and in-game purchases, see Monetization.

#What happens after you submit

  1. Automatic pre-checks run immediately and are shown to you and the reviewer:

    • fields: title, description, age rating, play target and capsule are present;
    • link: the play URL answers;
    • hosted: the hosted version is final and built;
    • capsule: a warning if the capsule is tiny or nearly one color.

    A failed check does not block the submission. It tells you and the reviewer what to fix.

  2. A person reviews it. They play the game, look at the art, and check that the tagline, tags and age rating describe it honestly. Reviewers may open review issues.

  3. Approved: the listing is in the catalog (GET /v1/catalog), on the web store, and in every launcher. Its app id is 4000000 + listing id.

  4. Rejected: the reviewer's note says why. Fix it and submit again.

  5. Updates: submit a new version. The approved version stays live until the update is approved. A new pending version replaces an older pending one of the same listing. At most 10 of your submissions can wait for review at once.

Developer calls for listings:

CallWhat it does
POST /v1/listingsSubmits (the CLI does this)
GET /v1/listings, GET /v1/listings/<id>Your listings, with status and review notes
POST /v1/listings/<id>/withdrawWithdraws the pending version
POST /v1/listings/<id>/delistTakes the live listing out of the catalog