# addon.json

{% hint style="warning" %}
As of <mark style="color:orange;">`April 3rd 2022`</mark>\
All addons are required to have an <mark style="color:purple;">`addon.json`</mark> file in their jar file\
Like how plugins require a <mark style="color:green;">`plugin.yml`</mark> file in theirs
{% endhint %}

## Required Keys

This file has a few required keys needed

<table><thead><tr><th width="182.528063644095" align="center">Key</th><th width="378.50635208711435">Description</th><th align="center">Type</th></tr></thead><tbody><tr><td align="center">name</td><td>What is the name of the addon you made?</td><td align="center"><mark style="color:green;"><code>STRING</code></mark></td></tr><tr><td align="center">author</td><td>Who is the author of the addon<br><mark style="color:green;"><code>(Used for when there is only one author)</code></mark></td><td align="center"><mark style="color:green;"><code>STRING</code></mark></td></tr><tr><td align="center">authors</td><td>Who is contributed to the development of the addon<br><mark style="color:green;"><code>(Used for when there is more then one author)</code></mark></td><td align="center"><mark style="color:orange;"><code>ARRAY</code></mark></td></tr><tr><td align="center">version</td><td>What is the version of the addon<br>Example: <mark style="color:blue;"><code>0.1</code></mark></td><td align="center"><mark style="color:blue;"><code>DOUBLE</code></mark></td></tr><tr><td align="center">supported-build</td><td>What build of SimplePets does this addon work on?<br><mark style="color:green;"><code>Example:</code></mark> SimplePets version <mark style="color:purple;"><code>5.0-BUILD-160</code></mark><br>So the build number would be <mark style="color:yellow;"><code>160</code></mark></td><td align="center"><mark style="color:yellow;"><code>INT</code></mark></td></tr><tr><td align="center">description</td><td>Give a brief description of what the addon does, Color codes can be used in the text<br><mark style="color:green;"><code>(This will also be displayed on the addon item)</code></mark></td><td align="center"><mark style="color:green;"><code>STRING</code></mark> / <mark style="color:orange;"><code>ARRAY</code></mark></td></tr></tbody></table>

## Example addon.json file

```json
{
  "name": "AwesomeAddon",
  "author": "Steve",

  "version": 0.1,
  "supported-build": 160,

  "description": [
    "&7This addon adds multiple awesome",
    "&7features in to SimplePets"
  ]
}
```