info.json
Outline basic information about your Element
Last updated
Outline basic information about your Element
Last updated
We are Realmac Software. We make nice things.
The info.json file outlines the basic information about an Element. The file consists of a series of keys and values. It's required for an Element to function. View example below.
The Elements info.json file supports the following key-value pairs.
Key | Type | Notes |
---|---|---|
You can use the following code as a starting point for your own info.json file.
identifier (Required)
string
The identifier is the unique ID for your Element. We recommend using a reverse DNS format. This should be a string consisting of just lowercase characters and periods without spaces.
author (Required)
string
The name of the author of the Element. This would usually be the developer name, or the name of the company publishing the Element.
title (Required)
string
The name of the Element. This will be displayed inside of RapidWeaver. A unique and descriptive name is preferable. Overly long names will get truncated, check inside of the RapidWeaver UI for readability.
group (Required)
string
Elements are grouped in the Elements Catalogue inside of RapidWever . You can use this key to group your Elements together.
build (Required)
string
The build number of an Element. The number should be an integer value, like "100". We recommend increasing the value with each release.
version (Required)
string
The version of an Element. We recommend the following convention (as used by many apps): major.minor.patch. and in practice that might look like "1.0.0" for an initial release.
tags
array
A list of tags relevant to the Elements.
helpURL
string
A URL to the location of the help documentation online.
infoURL
string
A URL to the location of the marketing page online.
missingURL
string
The URL to redirect users to when this Element is uninstalled or missing.
framework
string
Elements are grouped in the Elements Catalogue inside of RapidWever . You can use this key to group Elements from the same Framework togther.
assets
array
A list of required assets for the Element. This can be a mixed list of images and files for example.