prepare_submission
Needs sign-in (connect this server with OAuth, or pass an API key as the Authorization: Bearer header). Fills in the whole YouGame listing of a staged build and saves it as a draft for the creator to review. Needs the creator signed in on this connection (or their API key). Stage a local build folder with Node 22+: download https://yougame.co/upload-build.mjs, then run node upload-build.mjs with YOUGAME_URL=https://yougame.co and YOUGAME_UPLOAD_TOKEN (from upload_token) or YOUGAME_API_KEY set. It applies the website's path fixes locally and streams files through POST /api/upload/start, PUT /api/upload/file (a file over 100 MB goes up in 64 MB parts through /api/upload/file/parts), and POST /api/upload/complete. The same limits as the website apply: up to 5 GB per build, 512 MB per file, 5,000 files. Pass the build folder or the build's .zip: the helper unpacks a zip on your machine and sends its files the same way. The result includes uploadId, testUrl and the static check report; fix a broken verdict and upload again. When you change a build you already uploaded, add --from <your game's slug or your last uploadId>: files this helper sent before and that haven't changed are copied instead of sent again, so a small change is quick even on a big game. A ROM mod (kind "patch") is its one patch file (.ips, .ups, .bps or .xdelta) and no index.html: pass the file itself to the helper and it is staged as a package with no page to check; a cosmetic's folder is staged with --package (by hand, POST /api/upload/start with package: true beside files). On an "Ideas and test builds only" connection (scope build) the helper works with upload_token's token and stages a private test build; upload_token's reply there gives the steps. The reply has the uploadId, a testUrl where the build already runs, and the check report; if the verdict is broken, fix it and upload again. Then call this tool with the uploadId and every listing field, decided from what you know about the game: title, description, genres, controls, play mode, phones, mature, the score kind (time when the build posts a run's milliseconds to gameOver, else points), a maximum score (or fastest possible time) if the game has a natural one, and a thumbnail. Ask the creator first about anything you cannot decide from the game itself (a thumbnail when the build has no 16:9 image: offer to make one or to use theirs; whether it is for adults), and again about anything the reply lists under questions, then call this tool again with the answers. The reply has the review link: give it to the creator. They see every field filled in, change what they want, and press Publish; nothing is live until they do. Never call publish_game instead of handing over the link unless the creator explicitly asked you to publish without reviewing.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"uploadId": "<uploadId>",
"title": "<title>",
"description": "<description>",
"genres": "<genres>",
"controls": "<controls>",
"play_mode": "<play_mode>",
"mobile": "<mobile>",
"mature": "<mature>"
},
"name": "prepare_submission"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | "game" (default). "patch": a remix of a game the player already owns and that YouGame must never host, such as an N64 ROM or a disc image: a port, a balance patch, new characters, a community engine. Anything that changes how the game plays, however slightly, is a remix. It is listed as a Remix of the base game (its own page, online play and ladder; remixes are not compatible with each other online), the player picks their own copy of the base game once on the site (hashed and kept in their browser, never uploaded), and the build asks for the bytes with YouGame.baseGame() at launch (a web build; a native build gets the disc as {disc} / YOUGAME_DISC_BASE, SDK reference "Native builds on the player's own discs"). "mod": a cosmetic (skins, textures, stage art, music, HUD) a remix loads on top through YouGame.cosmetics(); it changes looks and sounds only, has no build to run (no index.html), players add it from the base game's hub, and it never changes a match. Both need base_game, must contain none of the base game's data (uploads are scanned for game images). | |
| notes | No | Up to 2000 characters, shown to the creator above the form: what you chose and why, and what you assumed (the genres, the score kind, the max score, why mobile is off). | |
| remix | No | Whether other people may remix this game (copy its build, change it, and publish the result as their own game) and on what terms. The creator decides; leaving it out means no remixes. A version of another game (base_game) is never monetized, so its remixes are always free. A mod cannot be remixed. A remix made under given terms keeps them even if the creator changes them later. | |
| title | Yes | 1–80 characters. | |
| genres | Yes | Up to 3; the first is the main one. | |
| ladder | No | The ranked ladder that ranked online matches feed (joinLobby with queue: "ranked"), shown on the game page. Default true; only matters for a game with online multiplayer. | |
| mature | Yes | True when the game is for adults only (blood and gore, realistic violence against people such as real-looking people hurt or killed or a realistic war setting, strong language, mature themes, casino-style gambling such as poker, slots or roulette even with play money). Cartoon, fantasy and stylized combat is not mature. Ask the creator if the game's content leaves it unclear. | |
| mobile | Yes | True only when you played the whole game with touch: every menu and action by tap or through YouGame.input, the layout right after fullscreen and rotation at 390×844 and 1024×768 (an iPad), no page scroll or zoom. Phones and iPads list only games with this on and Play there is the whole experience, so a wrong true puts an unplayable game in front of everyone it is shown to. The check report says what input the source handles; a keyboard-only or mouse-only build is false. Not sure, or could not run it on a touch screen or emulator: false, and say why in notes. A ROM mod (kind "patch" with base_game.rom_patch) is the exception: it runs in the site's emulator, which has its own on-screen controls, so pass true unless the mod cannot be played that way. | |
| licence | No | Creator-owned listing licence: all-rights-reserved, MIT, Apache-2.0, CC-BY-4.0 (art and sound), or custom. Omit or use null for not stated. Custom needs an https link in licence_url. Community open-source listings keep YouGame's AGPL licence. Unreal Engine games can't use GPL-family or CC BY-SA licences. | |
| controls | Yes | How the game is played. Default Keyboard. | |
| platform | No | web (default): plays in the browser. desktop_app: native build only; upload from Manage → Desktop builds. Forces mobile false. Never ship a web page telling players to download the app. | |
| uploadId | Yes | From the upload reply (32 hex characters). | |
| base_game | No | With kind "patch" or "mod": the base game the player must own. For a remix, the player's file is normalised for the system and its SHA-1 compared with `accepted`; a match in `rejected` tells the player why that dump will not do. For a cosmetic only key, name and system matter, plus `mod`. | |
| max_score | No | Optional: the highest score the game can produce (a points board), or the fastest run it can possibly produce in milliseconds (a time board). Scores past it are refused. Work it out from the game, or leave it out. | |
| play_mode | Yes | single (solo only), multiplayer (online only), or both. Default: multiplayer when the build calls YouGame.multiplayer.joinLobby, else single. | |
| thumbnail | No | The path, inside the build, of a 16:9 PNG/JPG/WebP/GIF under 8 MB for the game's card. Not needed again once one was sent with PUT /api/agent/media. | |
| score_kind | No | The leaderboard this game gets, if any. "points" (default): the game calls YouGame.gameOver(score) with whatever it counts, higher is better. "time": a game against the clock (a speedrun, a level or puzzle to finish fast) calls YouGame.gameOver(elapsedMs) with the run in milliseconds; the board ranks fastest first and shows runs as times (1:23.45). Pick "time" whenever the build posts a time. "none": no leaderboard at all, which is the right answer for a head-to-head game (a fighter, a chess clone, anything only ever played one against one) that has no solo run worth ranking; the game page shows its ranked ladder instead. Never invent points so a game can have a board. Who sees a points or time board is the creator's call, carried by leaderboard and friends_board below; the ranked ladder by ladder. | |
| visibility | No | "public" (default) lists the game everywhere at once. "private" is a private launch: the game is published but nothing on YouGame lists it, and only the creator and people who open one of its invite links can see or play it (an alpha or beta for testers before the public launch). Publishing makes the first invite link; the creator makes more, sees who joined, and launches publicly from the game's Manage page. Pick it when the creator says the build is for testers, a private group, or not ready for everyone. | |
| description | Yes | Up to 1000 characters, but keep it to two or three short, casual sentences a player reads on the game page: what the game is and what makes it fun (online play, a leaderboard). No control lists, rules tables, tech details or how YouGame works. Write it from the game. | |
| leaderboard | No | The everyone leaderboard: every player ranked together, and the top score on the game's card. Default true with a points or time board. false with friends_board true is a friends-only board, the right pick for a game meant to be played among friends. score_kind "none" turns both switches off whatever is sent. | |
| licence_url | No | An https link to the creator's licence text; required for custom, optional for other licences. No whitespace or control characters. Omit to keep it on updates; null clears it. | |
| screenshots | No | Optional: up to 8 image paths inside the build. | |
| also_requires | No | With kind "patch" only: the other games the build needs besides base_game (a mashup, such as a randomizer that combines two games), in order, at most 4. Each is a known game described like base_game (catalog, key, name, system, extensions, accepted, rejected; retail dumps only), plus the slot the build asks for its copy by: YouGame.baseGame("<slot>") in the browser; in the desktop app a GameCube or Wii disc reaches a native build as {disc:<slot>} in its yougame-native.json args ("discs": {"<slot>": true}) and the YOUGAME_DISC_<SLOT> variable. Play waits for every required copy; an optional one (required: false) never blocks Play. Such a build plays online in its own pool: not with base_game.plays_with. Leave it out for a game that needs one game. Not on a Steam base or a YG Dolphin runtime (base_game.runtime) yet. A native build: the SDK reference's "Native builds on the player's own discs" has a complete Melee + Brawl example. | |
| friends_board | No | The friends leaderboard: the same scores, each signed-in player seeing only themself and their friends. Default true with a points or time board. Needs no game code: the one gameOver call feeds both boards. | |
| match_replays | No | Creator opt-in for automatic browser match recordings, live watching and player account copies. Default false. Requires YouGame.replay.matches in the game. | |
| button_default | No | How the YouGame button over the game starts. "fade" (default): it shows at start, then fades; a game that calls YouGame.setGameState hides it while playing and shows it while paused or in a menu. "hidden": fully hidden from the start; players open YouGame with Shift+Tab or Back+Start, and a player's own choice still wins. Only when the creator asked for it. | |
| voice_everyone | No | Voice chat with everyone in a match, not just friends. Default false: players hear only their friends (and everyone in a friends lobby), which is right for almost every game. true only when the creator asked for it, for a game built around talking to other players (proximity chat as a core mechanic, social deduction): then every signed-in player seated in a match can hear every other one, matched by the queue or not. Needs no game code; blocked players stay muted and nobody is on the mic until they join. Covers match rooms (the first ten players seated in each), not worlds. | |
| whole_game_lobby | No | true when online play is a single lobby that starts the whole game together; false when players pick among several lobby or mode types inside the game (no Play together button on its page). Omit if unsure; null clears the setting. |