1.0.0¶
Manifest¶
schema_version = "1.0.0"
# Example of manifest file for a Blender extension
# Change the values according to your extension
id = "my_example_extension"
version = "1.0.0"
name = "Test Extension"
tagline = "This is another extension"
maintainer = "Developer name <[email protected]>"
# Supported types: "add-on", "theme"
type = "add-on"
# Optional: add-ons can list which resources they will require:
# * "files" (for access of any filesystem operations)
# * "network" (for internet access)
# * "camera" (to capture photos and videos)
# * "microphone" (to capture audio)
permissions = ["files", "network"]
# Optional link to documentation, support, source files, etc
# website = "http://extensions.blender.org/add-ons/my-example-package/"
# Optional list defined by Blender and server, see:
# https://docs.blender.org/manual/en/dev/extensions/tags.html
tags = ["Animation", "Sequencer"]
blender_version_min = "4.2.0"
# Optional: maximum supported Blender version
# blender_version_max = "5.1.0"
# License conforming to https://spdx.org/licenses/ (use "SPDX: prefix)
# https://docs.blender.org/manual/en/dev/extensions/licenses.html
license = [
"SPDX:GPL-2.0-or-later",
]
# Optional: required by some licenses.
copyright = [
"2002-2024 Developer Name",
"1998 Company Name",
]
Required values¶
Field | Description | Example |
---|---|---|
blender_version_min | Minimum supported Blender version - use at least 4.2.0 . |
"4.2.0" |
id | Unique identifier for the extension. | "my_example_extension" |
license | List of licenses, use SPDX license identifier. | "SPDX:GPL-2.0-or-later" |
maintainer | Maintainer of the extension. | "Developer Name <[email protected]>" |
name | Complete name of the extension. | "Test Extension" |
schema_version | Internal version of the file format. | "1.0.0" |
tagline | One-line short description - cannot end with punctuation. | "This is another extension" |
type | "add-on", "theme". | "add-on" |
version | Version of the extension - must follow semantic versioning. | "1.0.0" |
Optional values¶
Field | Description | Example |
---|---|---|
blender_version_max | Maximum version of Blender that can run this. | "4.2.0" |
website | Website for the extension. | "http://extensions.blender.org/add-ons/my-example-extension/" |
copyright | Some licenses require a copyright, copyrights must be "Year Name" or "Year-Year Name". | ["2002-2024 Developer Name", "1998 Company Name"] |
permissions | Add-ons can list which resources they require. The available options are ["files", "network", "camera", "microphone"]. | ["files"] |
tags | List of tags. See the list of available tags. | ["Animation", "Sequencer"] |
Note
All the values present in the manifest file must be filled
(i.e., cannot be empty, nor text ""
, nor list []
).
If you don't want to set one of the optional values just exclude it from the manifest altogether.
Changelog¶
- Initial version.