addedInput schema / properties / also_requires
Added value: +{
+ "description": "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.",
+ "items": {
+ "properties": {
+ "accepted": {
+ "items": {
+ "properties": {
+ "content_sha1": {
+ "description": "A GameCube dump only, as the catalog lists it.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "partition_offset": {
+ "description": "A Wii dump only, as the catalog lists it.",
+ "type": "number"
+ },
+ "partition_sha1": {
+ "description": "A Wii dump only: its game partition's content hash, as the catalog lists it (copy it with the dump).",
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string"
+ },
+ "size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "sha1",
+ "name",
+ "size"
+ ],
+ "type": "object"
+ },
+ "maxItems": 16,
+ "type": "array"
+ },
+ "adds": {
+ "description": "An optional game only: what it adds, in a few words (at most 60 characters), shown beside its link step.",
+ "type": "string"
+ },
+ "catalog": {
+ "description": "The game's Wikidata id in YouGame's game catalog, as for base_game.catalog.",
+ "type": "string"
+ },
+ "extensions": {
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "key": {
+ "description": "The game's base key, as for base_game.key; never base_game's own key.",
+ "type": "string"
+ },
+ "name": {
+ "description": "What the player must own, up to 80 characters.",
+ "type": "string"
+ },
+ "rejected": {
+ "items": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string"
+ },
+ "size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "sha1",
+ "name",
+ "size",
+ "reason"
+ ],
+ "type": "object"
+ },
+ "maxItems": 32,
+ "type": "array"
+ },
+ "required": {
+ "description": "Default true: Play waits for the player's copy. false: optional, the build gets null when the player has none.",
+ "type": "boolean"
+ },
+ "slot": {
+ "description": "How the build asks for this copy: 1-16 characters of a-z, 0-9 or -, starting with a letter, never \"base\" (the main game's). Example: \"mm\".",
+ "type": "string"
+ },
+ "system": {
+ "enum": [
+ "n64",
+ "snes",
+ "nes",
+ "gb",
+ "gbc",
+ "gba",
+ "genesis",
+ "sms",
+ "gg",
+ "gamecube",
+ "wii",
+ "ps1",
+ "ps2",
+ "psp",
+ "dreamcast",
+ "nds",
+ "xbox",
+ "file"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "slot",
+ "key",
+ "name"
+ ],
+ "type": "object"
+ },
+ "maxItems": 4,
+ "type": "array"
+}
removedInput schema / properties / api_key
Removed value: -{
- "description": "Only when the key could not be set as the Authorization header of the MCP connection: the creator's API key (yg_…). Prefer the header (or the YOUGAME_API_KEY environment variable): a key passed here ends up in the agent's transcript and tool logs.",
- "type": "string"
-}
addedInput schema / properties / base_game
Added value: +{
+ "description": "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`.",
+ "properties": {
+ "accepted": {
+ "description": "The dumps the patch runs on (No-Intro or Redump hashes of the canonical image).",
+ "items": {
+ "properties": {
+ "content_sha1": {
+ "description": "A GameCube dump only, as the catalog lists it.",
+ "type": "string"
+ },
+ "name": {
+ "description": "What the player sees when it matched: the game title and region.",
+ "type": "string"
+ },
+ "partition_offset": {
+ "description": "A Wii dump only, as the catalog lists it.",
+ "type": "number"
+ },
+ "partition_sha1": {
+ "description": "A Wii dump only: its game partition's content hash, as the catalog lists it (copy it with the dump).",
+ "type": "string"
+ },
+ "sha1": {
+ "description": "40 hex characters.",
+ "type": "string"
+ },
+ "size": {
+ "description": "Bytes of the canonical image.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "sha1",
+ "name",
+ "size"
+ ],
+ "type": "object"
+ },
+ "maxItems": 16,
+ "type": "array"
+ },
+ "catalog": {
+ "description": "The game's Wikidata id in YouGame's game catalog, returned by the catalog search: a base game has to be a known game. Search the catalog over plain HTTP, no sign-in: GET https://yougame.co/api/base/search?q=<title> (each match lists the base games already defined for it: reuse one's key and this can be left out). A new key without it is accepted only when name, less any \"(System, Region)\" tail, is exactly one catalog game's name. On every system but file, accepted dumps must be known No-Intro/Redump dumps: GET https://yougame.co/api/base/dumps?catalog=<id> lists them with the base game each belongs to; a new key is moved to that base game.",
+ "type": "string"
+ },
+ "emulator": {
+ "description": "A version with a build of its own only: false keeps the system's emulator (the browser runtime and the desktop app's in-window emulator) off the page, so players only get the build; for a build with online play the emulator lacks. Omit to offer both. A ROM mod (kind \"patch\" with base_game.rom_patch) cannot turn it off.",
+ "type": "boolean"
+ },
+ "extensions": {
+ "description": "File extensions the picker offers, without dots: [\"z64\", \"n64\", \"v64\"].",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "key": {
+ "description": "Groups patches of the same base so one stored copy serves them all: \"n64/ssb-usa\". 2–64 characters of a-z, 0-9, /, _ or -.",
+ "type": "string"
+ },
+ "mod": {
+ "description": "A cosmetic only: what it changes and its package format.",
+ "properties": {
+ "category": {
+ "description": "What the cosmetic changes; the hub filters by it.",
+ "enum": [
+ "characters",
+ "stages",
+ "music",
+ "hud",
+ "textures"
+ ],
+ "type": "string"
+ },
+ "format": {
+ "description": "The package format a remix has to list in mod_formats to load it, like \"texture-pack\".",
+ "type": "string"
+ },
+ "ranked": {
+ "description": "false when the cosmetic shows information other players do not see (hitboxes, frame data, a radar): players cannot have it on in a ranked match. Omit otherwise.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "category",
+ "format"
+ ],
+ "type": "object"
+ },
+ "mod_formats": {
+ "description": "A remix only: the cosmetic package formats its build loads through YouGame.cosmetics(), short handles like \"texture-pack\" or \"o2r-overlay\" (1–32 characters of a-z, 0-9, -). Cosmetics on the base game with one of these formats are offered to its players. Omit for none.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 8,
+ "type": "array"
+ },
+ "name": {
+ "description": "What the player must own, up to 80 characters: the game title, system and region.",
+ "type": "string"
+ },
+ "plays_with": {
+ "description": "The slug of your own full listing this patch is the same game as: with the player's base game applied it runs the same simulation, so the two listings share one set of online rooms, ratings and ladders and their players match each other. Both builds must come from the same source and use the same multiplayer compatibility string. The full listing must be published first, public, with online play on. Omit when the patch stands alone, and send it again whenever you resend base_game: the spec is replaced as a whole.",
+ "type": "string"
+ },
+ "rejected": {
+ "description": "Real dumps the patch recognises but cannot use (other regions, revisions), each with the reason the player reads.",
+ "items": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "reason": {
+ "description": "Up to 200 characters: \"the Europe release; only the USA ROM is supported\".",
+ "type": "string"
+ },
+ "sha1": {
+ "type": "string"
+ },
+ "size": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "sha1",
+ "name",
+ "size",
+ "reason"
+ ],
+ "type": "object"
+ },
+ "maxItems": 32,
+ "type": "array"
+ },
+ "rom_patch": {
+ "description": "A cartridge ROM hack's default patch and optional patches for specific accepted dumps. Upload every named file. The default applies when no variant matches the player's SHA-1.",
+ "properties": {
+ "file": {
+ "description": "Default patch's path inside the upload.",
+ "type": "string"
+ },
+ "format": {
+ "description": "Inferred from the file extension when omitted.",
+ "enum": [
+ "ips",
+ "bps",
+ "ups",
+ "xdelta"
+ ],
+ "type": "string"
+ },
+ "variants": {
+ "items": {
+ "properties": {
+ "file": {
+ "description": "This copy's patch path inside the upload.",
+ "type": "string"
+ },
+ "format": {
+ "description": "Inferred from the file extension when omitted.",
+ "enum": [
+ "ips",
+ "bps",
+ "ups",
+ "xdelta"
+ ],
+ "type": "string"
+ },
+ "sha1": {
+ "description": "One of accepted's SHA-1s; each hash appears at most once.",
+ "pattern": "^[0-9a-f]{40}$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "sha1",
+ "file"
+ ],
+ "type": "object"
+ },
+ "maxItems": 8,
+ "type": "array"
+ }
+ },
+ "required": [
+ "file"
+ ],
+ "type": "object"
+ },
+ "system": {
+ "description": "\"n64\": the file is an N64 ROM; .z64, .v64 and .n64 byte orders and a copier header are normalised before hashing, so list the big-endian (.z64) SHA-1. \"file\" (default): the bytes are hashed as they are.",
+ "enum": [
+ "n64",
+ "snes",
+ "nes",
+ "gb",
+ "gbc",
+ "gba",
+ "genesis",
+ "sms",
+ "gg",
+ "gamecube",
+ "wii",
+ "ps1",
+ "ps2",
+ "psp",
+ "dreamcast",
+ "nds",
+ "xbox",
+ "file"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "key",
+ "name"
+ ],
+ "type": "object"
+}
changedInput schema / properties / description / description
Previous value: -"Up to 1000 characters: what the game is and how to play. Write it from the game."New value: +"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."
addedInput schema / properties / friends_board
Added value: +{
+ "description": "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.",
+ "type": "boolean"
+}
changedInput schema / properties / genres / items / enum
Previous value: -[
- "Arcade",
- "Puzzle",
- "Platformer",
- "Shooter",
- "Strategy",
- "Idle",
- "Racing",
- "Roguelike",
- "Card",
- "Sports",
- "Horror",
- "Simulation",
- "Word",
- "Rhythm",
- "Tower defense",
- "Other"
-]New value: +[
+ "Action",
+ "Adventure",
+ "RPG",
+ "Arcade",
+ "Puzzle",
+ "Platformer",
+ "Shooter",
+ "Fighting",
+ "Strategy",
+ "Simulation",
+ "Sports",
+ "Racing",
+ "Party",
+ "Horror",
+ "Roguelike",
+ "Card",
+ "Idle",
+ "Rhythm",
+ "Tower defense",
+ "Word",
+ "Other"
+]
addedInput schema / properties / kind
Added value: +{
+ "description": "\"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).",
+ "enum": [
+ "game",
+ "patch",
+ "mod"
+ ],
+ "type": "string"
+}
addedInput schema / properties / ladder
Added value: +{
+ "description": "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.",
+ "type": "boolean"
+}
addedInput schema / properties / leaderboard
Added value: +{
+ "description": "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.",
+ "type": "boolean"
+}
addedInput schema / properties / licence
Added value: +{
+ "description": "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.",
+ "enum": [
+ null,
+ "all-rights-reserved",
+ "MIT",
+ "Apache-2.0",
+ "CC-BY-4.0",
+ "custom"
+ ],
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedInput schema / properties / licence_url
Added value: +{
+ "description": "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.",
+ "maxLength": 500,
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedInput schema / properties / match_replays
Added value: +{
+ "description": "Creator opt-in for automatic browser match recordings, live watching and player account copies. Default false. Requires YouGame.replay.matches in the game.",
+ "type": "boolean"
+}
changedInput schema / properties / mature / description
Previous value: -"True when the game is for adults only (blood and gore, strong language, mature themes). Ask the creator if the game's content leaves it unclear."New value: +"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."
changedInput schema / properties / max_score / description
Previous value: -"Optional: the highest score the game can produce. Scores above it are held for review. Work it out from the game's scoring, or leave it out."New value: +"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."
changedInput schema / properties / mobile / description
Previous value: -"True only when the game plays with touch (pointer events, on-screen controls, 44 px targets, fills the screen). Lists it for phones."New value: +"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."
removedInput schema / properties / paywalls
Removed value: -{
- "description": "The paywalls the build charges with YouGame.coins.charge(key), each priced by the creator: ask them for the price and kind. Leave it out when the game charges nothing.",
- "items": {
- "properties": {
- "key": {
- "description": "The key the game passes to YouGame.coins.charge.",
- "type": "string"
- },
- "kind": {
- "description": "unlock: pay once, owned forever. play: pay every time.",
- "enum": [
- "unlock",
- "play"
- ],
- "type": "string"
- },
- "label": {
- "description": "What the player sees on the purchase sheet, up to 60 characters.",
- "type": "string"
- },
- "price": {
- "description": "Whole coins, 1 to 5000.",
- "type": "number"
- }
- },
- "required": [
- "key",
- "label",
- "price",
- "kind"
- ],
- "type": "object"
- },
- "maxItems": 20,
- "type": "array"
-}
addedInput schema / properties / platform
Added value: +{
+ "description": "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.",
+ "enum": [
+ "web",
+ "desktop_app"
+ ],
+ "type": "string"
+}
changedInput schema / properties / play_mode / description
Previous value: -"single (solo only), multiplayer (online only), or both. Default: multiplayer when the build calls findMatch, else single."New value: +"single (solo only), multiplayer (online only), or both. Default: multiplayer when the build calls YouGame.multiplayer.joinLobby, else single."
addedInput schema / properties / remix
Added value: +{
+ "additionalProperties": false,
+ "description": "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.",
+ "properties": {
+ "allowed": {
+ "description": "May anyone remix the game at all. Default false.",
+ "type": "boolean"
+ },
+ "merge": {
+ "description": "Whether a remixer may propose their build as the original's next version: \"free\" (default: yes) or \"no\".",
+ "enum": [
+ "free",
+ "no"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
addedInput schema / properties / save
Added value: +{
+ "description": "Put the game in the creator's Saved games. Default true; pass false only when the creator asked not to.",
+ "type": "boolean"
+}
addedInput schema / properties / score_kind
Added value: +{
+ "description": "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.",
+ "enum": [
+ "points",
+ "time",
+ "none"
+ ],
+ "type": "string"
+}
addedInput schema / properties / visibility
Added value: +{
+ "description": "\"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.",
+ "enum": [
+ "public",
+ "private"
+ ],
+ "type": "string"
+}
addedInput schema / properties / voice_everyone
Added value: +{
+ "description": "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.",
+ "type": "boolean"
+}
addedInput schema / properties / whole_game_lobby
Added value: +{
+ "description": "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.",
+ "type": [
+ "boolean",
+ "null"
+ ]
+}