Reference
Menu backgrounds
A main-menu background: an image in the mod, or an existing venue's backdrop. The menu shows one per launch from the highest priority present, so a pack can replace the core set outright (priority 10) or add to it (priority 0).
The main menu’s backdrop. Each record is a picture of your own ("image": "assets/menu/hall.webp") or an existing venue’s backdrop ("venueId": "core.venue.irwell-dome"), with an optional crop such as "focus": "60% 40%" and a weight. The menu picks one each time the game starts, from the records with the highest priority: give yours "priority": 10 to replace the base game’s picture, or leave it at 0 to join the rotation.
- Content type
menuBackgrounds- Files
data/menu.json,data/menu/- Shape
- A list of records, each with its own
id - Patch target
menuBackground:<id>, for examplemenuBackground:core.menu.board-wires- In the base game
- 1 record
Fields#
Indented fields belong to the field above them. [] marks the items of a list. A field that is not required may be left out; the default is used.
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
id | id | Yes | Namespaced id, e.g. "core.player.rory-calder" | |
image | file path | Asset path, relative to the mod | ||
venueId | id | Use this venue's backdrop instead of a file of your own. Names a venue record. | ||
focus | text | CSS object-position for the crop, e.g. "60% 40%" (default centre). Pattern: ^\d{1,3}% \d{1,3}%$ | ||
phoneFocus | text | Pattern: ^\d{1,3}% \d{1,3}%$ | ||
weight | number, at least 0 | 1 | ||
priority | whole number | 0 |
Example#
A record from the base game’s data/menu.json.
{
"id": "core.menu.board-wires",
"image": "assets/menu/board-wires.webp",
"focus": "50% 50%",
"phoneFocus": "44% 45%"
}In your pack the record’s id starts with your pack’s id instead of core, unless you mean to replace this one.