xpipe/extension/README.md

19 lines
897 B
Markdown
Raw Normal View History

2022-03-11 07:38:57 +13:00
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.xpipe/extension/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.xpipe/extension)
[![javadoc](https://javadoc.io/badge2/io.xpipe/extension/javadoc.svg)](https://javadoc.io/doc/io.xpipe/extension)
2022-03-10 10:51:04 +13:00
## X-Pipe Extension API
The X-Pipe extension API allows you to create extensions of any kind for X-Pipe.
2022-06-18 10:29:41 +12:00
This includes:
2022-10-16 03:06:02 +13:00
2022-06-18 10:29:41 +12:00
- Custom data stores, including configuration GUI and CLI
- Custom data sources, including configuration GUI and CLI
- Custom preferences entries
2022-03-10 10:51:04 +13:00
### Custom data sources
2022-06-18 10:29:41 +12:00
A custom data source type can be implemented by creating a custom
[DataSourceProvider](src/main/java/io/xpipe/extension/DataSourceProvider.java).
2022-03-10 10:51:04 +13:00
This provider contains all the information required for proper handling of your custom data sources,
whether you access it from the CLI, any API, or the X-Pipe commander gui.