Repository navigation
Manifest Reference
Every package has a manifest.json at its top level. Bunny Loader reads it
before anything else, to show the package in the launcher and to know how to
load it. This page lists every field it understands. Mod
structure explains the important ones with an
example, and Sharing your mod shows
what the page fields look like in the app.
| Field | Type | |
|---|---|---|
uid |
text |
Required. The package's identity: a lowercase UUID, such as 24f03eb3-c4c8-44cf-bddf-9e62105abe24. It is also the name of the package's folder once installed. Two packages with the same uid are the same package, so one replaces the other. A package without a valid uid does not install. |
id |
text |
Required. The internal name: letters, numbers and _, starting with a letter, up to 64 characters. The code is <id>.dll or <id>.cs, other mods find yours by it, and translation keys start with Mods.<id>.. |
name |
text | Required. The name shown in the launcher. |
version |
text |
Required. The version shown in the launcher, such as 1.0.0. In multiplayer it must match exactly between players. |
type |
text |
mod (the default), texture or font. Decides the group the package goes to. |
blVersion |
number |
Required. The package format: 3. Without it, or with an older number, the package counts as an old format and is refused. |
dependencies |
list of text | The mods that must load before this one, by id or uid. If one of them is not turned on or fails, this one is turned off for that game (Log messages). |
gameVersion |
list of numbers | The game versions the package was made for. Informative: Bunny Loader does not check it. |
| Field | Type | |
|---|---|---|
authors |
list | Who made it, in order. Each entry is a name ("You") or an object with name, role (such as "Art"), avatar (a picture in the package's authors/ folder), color (#RRGGBB, for the name) and link. Without an avatar, Bunny Loader looks for authors/<name>.png and for the name in lowercase with hyphens (authors/potato-labs.png), and without a picture it draws the name's first letter. |
author |
text | The older, short form of authors: one name. |
category |
text | A tag on the package's card. Textura, Armas, Jogabilidade, Cheat, Utilidade and Itens get their own color and icon; anything else shows as a plain tag. The default is Mod. |
summary |
text | One line on the package's card. |
localizedNames, localizedSummaries
|
objects | The name and the summary in other languages, by the game's culture code: { "pt-BR": "...", "zh-Hans": "..." }. |
description |
text | The page's text when the package has no description.md. The file, written in Markdown, is the better choice. |
license |
text | The license's short name, such as MIT. The full text goes in license.md, shown in the License tab. |
links |
list | Buttons on the page: [{ "title": "Source code", "url": "https://..." }]. |
pages |
list | Extra tabs, each one showing a Markdown file of the package: [{ "title": "Guide", "file": "guide.md" }]. |
updated |
text | The date of this version, YYYY-MM-DD. |
featured |
true or false | Asks for a place among the featured mods on the launcher's Home tab. |
theme |
object | The page's colors and background; see below. |
Colors are #RRGGBB or #AARRGGBB, and they only apply inside the package's
own page; the rest of the launcher keeps its colors. An empty field keeps the
launcher's color.
| Field | |
|---|---|
accent |
The chosen tab, links, section titles and the highlight of the changelog. |
panel |
The background of the page's panels. |
text |
Body text. |
heading |
Markdown headings. |
button |
The background of the page's buttons (download, remove, export, links). |
buttonText |
The text of those buttons. |
background |
The background behind the page: a color, or a picture from the package (background.png; a .gif animates). |
backgroundMode |
cover (fills the screen, cropping) or tile (repeats, like a texture). |
backgroundScale |
In tile mode, how many screen points each pixel of the picture takes. 2 by default. |
backgroundDim |
From 0 to 1: how much the background darkens so the text stands out. 0 by default. |
These are not fields, but the launcher reads them from the same place:
| File | |
|---|---|
icon.png |
The square picture on the card, on the page and in the game's menus, such as Mod Configuration. Without one, the launcher shows the category's icon. icon.gif animates in the launcher, while the game keeps icon.png. |
banner.png |
The wide cover at the top of the page, about 3.4 to 1. banner.gif animates; .webp and .jpg work too. |
description.md |
The Description tab, in Markdown. description_<culture>.md, such as description_pt-BR.md, is used for that language. |
changelog.md |
The Changelog tab. |
license.md |
The License tab. |
authors/ |
The authors' pictures. |
thumbnails/ |
The pictures of the page's gallery. |
Bunny Loader wiki ·
Discord ·
Repository ·
BL Editor
Written for Bunny Loader 0.5.5-beta and Terraria Mobile 1.4.5.8.6.
Bunny Loader is not affiliated with Re-Logic or 505 Games.
