0xDocs 0x.limo

Docs / Store page

Listing fields

Every field of a 0x store listing (POST /v1/listings), with its limits, where it appears, and the matching 0x.config.json key and form field.

A store listing is submitted with POST /v1/listings. 0x submit builds the request from 0x.config.json, and the submission form builds it from the page. Each submission is a new version of the listing, which waits for review. The approved version is what players see.

#Fields

FieldRequiredRules0x.config.jsonShown
idyes3–64 characters: a-z, 0-9, -, not starting or ending with -. It is the game's id in every launcher and its store URL (0x.limo/game/<id>). The first developer to use an id owns it. The launcher's own worlds (outgrid-earth, los-santos, war, earth) and issues and uploads are reserved.idURL, catalog
titleyes1–80 charactersnameEverywhere
taglineno≤ 200 characterstaglineCards, share previews
descriptionyes1–4000 characterslisting.description, else description, else taglineGame page
tagsno≤ 16 tags, each 1–32 characterstagsCards (first 3), tag pages, filters
age_ratingyesSee Age ratingslisting.age_ratingGame page ("Rated")
playyesSee Play targetlisting.play
priceno"free" (the default). {amount, currency} only when payments are on.
capsulefirst version{"png": base64}, ≤ 1 MiB, a real PNG. If left out, the last version's capsule is kept. See Store art.listing.capsule (path)Cards, game page, share image
screenshotsno≤ 6, each {"png": …} or {"jpeg": …}, ≤ 2 MiBlisting.screenshots (paths)Game page media strip
trailerno{"url": YouTube or Vimeo}, or {"upload": name} of a file sent to PUT /v1/listings/uploads/trailer (MP4 or WebM, ≤ 60 MB), or false to remove it. If left out, the current trailer is kept.listing.trailerFirst in the media strip
releaseno"demo" (a playable demo of an upcoming release) or "full". If left out, the game keeps its stage; a new game is a released game. See Release types.listing.release, --releaseUpcoming releases section, Demo badge
release_notesno≤ 4000 characterslisting.release_notes"What's new" on the game page
detailsnoSee Detailslisting.detailsGame page details
sourcenoSource declaration (rebuilt and compared by 0x; "Source verified" when it matches). See 0x submit --source.listing.source"Source verified" badge

#Play target

KeyMeaning
play.typeweb: a page in the browser. hosted-server: a web page plus a game server hosted on 0x. paper: your own Minecraft (Paper) server, not available on 0x.limo yet.
play.urlThe https page players open (http://localhost: and http://127.0.0.1: are accepted only for development). Not needed with site.
play.site, play.versionA hosted site version: it must be yours and final. Its origin becomes the play URL. If you also give url, it must be on that origin.
play.server{host, port} of the game server a native client joins. Required for paper.

#Details

KeyRules
details.controlsAny of keyboard-mouse, gamepad, touch
details.phonestrue or false: whether the game plays well on a phone
details.players{single: bool, multi: bool, max: 1–100000}. max above 1 needs multi to be not false.
details.languages≤ 40 names, each 1–40 characters
details.download_bytesA size in bytes. For hosted sites, the version's own size is used instead.

details.players.multi, play type hosted-server, or a tag matching multi/co-op/online/MMO put the game under the store's Multiplayer filter.

#Tags and developer pages

Tags are free text and matched case-insensitively. 0x.limo/tag/<tag> lists the games with that tag, and 0x.limo/developer/<slug> lists the games of a developer: your display name, lowercased, with runs of other characters turned into -. Use common genre words (Action, Arcade, Puzzle, Multiplayer, …) so your game shows up next to similar ones.

#Status and versions

StatusMeaning
pendingWaiting for review. A newer submission of the same listing replaces it. At most 10 per developer at once.
approvedLive in the catalog. The previous approved version becomes superseded.
rejectedSee the reviewer's note (0x submit status) and any review issues

You can withdraw a pending version (POST /v1/listings/<id>/withdraw) or take a live listing out of the catalog (POST /v1/listings/<id>/delist). An approved listing gets the app id 4000000 + listing id. Approved art is public at GET /v1/listings/<id>/art/<version>/<file>.

#Example request

bash
curl -s https://api.0x.limo/v1/listings \
  -H "authorization: Bearer $ZEROX_TOKEN" -H 'content-type: application/json' \
  -d '{
    "id": "my-neon-drift", "title": "Neon Drift",
    "tagline": "Catch stars, dodge meteors.", "description": "A tiny neon arcade game.",
    "tags": ["Arcade", "Casual"], "age_rating": "everyone",
    "play": {"type": "web", "site": "my-neon-drift", "version": 1},
    "price": "free",
    "capsule": {"png": "'"$(base64 -w0 art/capsule.png)"'"}
  }'

The response has id, listing, version, status and precheck (checks: [{check, ok, detail}]).