> For the complete documentation index, see [llms.txt](https://developer.eagle.cool/plugin-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.eagle.cool/plugin-api/get-started/plugin-types/preview.md).
# Format Extension
The main purpose of format extension plugins is to enable Eagle to preview file formats that are not yet supported. Unlike other types of plugins, format extension plugins do not need to define the `main` attribute in `manifest.json`, but need to set the `preview` attribute. Here is an example code:
```json
"preview": {}
```
In the `preview`, you can define the file extensions you want to extend. For example, if you want Eagle to support the icns icon format, you can enter `"icns": {}`:
```json
"preview" : {
"icns": {}
}
```
If you need to set multiple extensions, you can use a comma `,` to separate different extensions for definition, for example:
```json
"preview" : {
"icns,ico": {}
}
```
Format extension plugins can be divided into two parts:
1. `"thumbnail.path"`: Provides the `.js` file for parsing the thumbnail of the file format to be extended.
2. `"viewer.path"`: Provides the `.html` file for previewing the format to be extended.
```json
"preview": {
"icns": {
"thumbnail": {
"path": "thumbnail/icns.js",
"size": 400,
"allowZoom": false
},
"viewer": {
"path": "viewer/icns.html"
}
}
}
```
After setting other `metadata.json` fields, the final code is as follows:
{% tabs %}
{% tab title="manifest.json" %}
```json
{
"id": "LARSKLB8OTOC2",
"version": "1.0.0",
"platform": "all",
"arch": "all",
"name": "Preview Plugin",
"logo": "/logo.png",
"keywords": [
"icns"
],
"devTools": false,
"preview": {
"icns": {
"thumbnail": {
"path": "thumbnail/icns.js",
"size": 400,
"allowZoom": false
},
"viewer": {
"path": "viewer/icns.html"
}
}
}
}
```
{% endtab %}
{% tab title="thumbnail/icns.js" %}
```javascript
const fs = require('fs');
const icns = require('./../js/icns-util.js');
const imageSize = require('./../js/image-size.js');
module.exports = async ({ src, dest, item }) => {
return new Promise(async (resolve, reject) => {
try {
// 1. parsing and generate thumbnail file to dest
await icns.icns2png(src, dest);
let size = await imageSize(dest);
// 2. Check if the result is correct
if (!fs.existsSync(dest) || size.width === 0) {
return reject(new Error(`icns file thumbnail generate fail.`));
}
// 3. update the item dimensions
item.height = size?.height || item.height;
item.width = size?.width || item.width;
// 4. return the result
return resolve(item);
}
catch (err) {
return reject(err);
}
});
}
```
{% endtab %}
{% tab title="viewer/icns.html" %}
```html
ICNS Viewer
![]()
```
{% endtab %}
{% endtabs %}
{% hint style="warning" %}
Please note that currently the format extension plugins do not support Eagle Plugin API and DevTools debugging functionality.
{% endhint %}
{% hint style="info" %}
**Complete Example Code:**\
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://developer.eagle.cool/plugin-api/get-started/plugin-types/preview.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.