Raw schema
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "The project id (r3_project_list)."
},
"settings": {
"description": "Only the settings to change, e.g. {\"worksOn\": \"keyboard\", \"seoDescription\": \"…\"}.",
"type": "object",
"properties": {
"worksOn": {
"description": "What the project works on: keyboard (desktop only — phone visitors see a \"made for a keyboard\" note and the project gets a \"desktop\" badge), touch (\"mobile\" badge), both, or untested (no note, no badge).",
"type": "string",
"enum": [
"keyboard",
"touch",
"both",
"untested"
]
},
"seoTitle": {
"description": "The title search engines and link previews show (up to 200 characters).",
"type": "string",
"maxLength": 200
},
"seoDescription": {
"description": "The description search engines and link previews show (up to 500 characters). Empty, they show a generic line.",
"type": "string",
"maxLength": 500
},
"autoStart": {
"description": "How the live page starts: auto (the default: a Start button only when the project has sound or physics, else it starts on load), startButton (always a Start button), firstGesture (the first click anywhere), load (on load: physics and code only, no audio).",
"type": "string",
"enum": [
"auto",
"load",
"startButton",
"firstGesture"
]
},
"autoStartLoad": {
"type": "object",
"properties": {
"physics": {
"type": "boolean"
},
"code": {
"type": "boolean"
}
},
"additionalProperties": false
},
"startButton": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 40
},
"position": {
"type": "string",
"enum": [
"center",
"top-center",
"bottom-center"
]
},
"starts": {
"type": "object",
"properties": {
"physics": {
"type": "boolean"
},
"audio": {
"type": "boolean"
},
"music": {
"type": "boolean"
},
"code": {
"type": "boolean"
}
},
"additionalProperties": false
},
"alsoFullscreen": {
"type": "boolean"
},
"removeAfterClick": {
"type": "boolean"
},
"before": {
"description": "What runs BEFORE the Start button (startButton and firstGesture modes), e.g. {\"code\": true} so code that builds the scene runs on load; the press starts the rest. Code and physics only: audio and music always wait for the press. Default: nothing.",
"type": "object",
"properties": {
"code": {
"type": "boolean"
},
"physics": {
"type": "boolean"
}
},
"additionalProperties": false
},
"poster": {
"description": "What the page shows before Start: scene (the default) or shareImage (the project's share picture fills the page behind the Start button until Start runs; with no share picture, the scene).",
"type": "string",
"enum": [
"scene",
"shareImage"
]
}
},
"additionalProperties": false
},
"controls": {
"description": "The always-visible pause / resume buttons on the live page.",
"type": "object",
"properties": {
"physics": {
"type": "object",
"properties": {
"show": {
"type": "boolean"
},
"position": {
"type": "string",
"enum": [
"bottom-right",
"bottom-center",
"bottom-left",
"top-right",
"top-center",
"top-left"
]
}
},
"additionalProperties": false
},
"audio": {
"type": "object",
"properties": {
"show": {
"type": "boolean"
},
"position": {
"type": "string",
"enum": [
"bottom-right",
"bottom-center",
"bottom-left",
"top-right",
"top-center",
"top-left"
]
}
},
"additionalProperties": false
},
"music": {
"type": "object",
"properties": {
"show": {
"type": "boolean"
},
"position": {
"type": "string",
"enum": [
"bottom-right",
"bottom-center",
"bottom-left",
"top-right",
"top-center",
"top-left"
]
}
},
"additionalProperties": false
},
"code": {
"type": "object",
"properties": {
"show": {
"type": "boolean"
},
"position": {
"type": "string",
"enum": [
"bottom-right",
"bottom-center",
"bottom-left",
"top-right",
"top-center",
"top-left"
]
}
},
"additionalProperties": false
},
"fullscreen": {
"type": "object",
"properties": {
"show": {
"type": "boolean"
},
"position": {
"type": "string",
"enum": [
"bottom-right",
"bottom-center",
"bottom-left",
"top-right",
"top-center",
"top-left"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"centerProject": {
"type": "boolean"
},
"attribution": {
"description": "The \"Built with r3js.org\" badge.",
"type": "object",
"properties": {
"show": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"gallery": {
"description": "R3 admins only: the landing gallery, e.g. {\"featured\": true} or {\"examplePrompt\": \"…\"}.",
"type": "object",
"properties": {
"featured": {
"description": "true pins the project to the top of the landing gallery; false unpins it.",
"type": "boolean"
},
"hidden": {
"description": "true keeps the project out of the landing gallery (its live page stays); false shows it again.",
"type": "boolean"
},
"examplePrompt": {
"description": "The exact prompt that made this project, shown with a \"Made by R3\" label and a Copy prompt button (up to 500 characters; empty clears it). Only on a project an R3 account owns.",
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
},
"address": {
"description": "The new project part of the live address, e.g. \"my-game\" (letters, numbers and dashes). Only for a project that is or was live; the old address redirects to the new one.",
"type": "string",
"maxLength": 120
}
},
"required": [
"projectId"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}