Welcome to the official Plugin Registry for KoBar!
This repository serves as the central database for all community-created plugins available in the KoBar marketplace. The registry is fully automated and powered by GitHub Actions.
- Source of Truth: Developers submit their GitHub repository names to the
plugins.jsonfile in this repository. - Automated Bot: A GitHub Action runs automatically every midnight (or when a new PR is merged).
- Data Fetching: The bot visits every registered repository, reads their
kobar.jsonmetadata file, and fetches the latest version and release notes from the GitHub Releases API. - Registry Generation: The bot compiles all this data and generates a single
registry.jsonfile. - Client App: The KoBar desktop application downloads this lightweight
registry.jsonfile to instantly display the most up-to-date plugins to users without hitting API rate limits.
If you have developed a plugin for KoBar and want it to appear in the official Plugin Store, follow these simple steps:
Ensure your plugin's repository has a kobar.json (or manifest.json) file in its root directory. This file provides the store with your plugin's display information.
Example kobar.json:
{
"id": "my-awesome-plugin",
"name": "Awesome Plugin",
"description": "This plugin does amazing things for KoBar.",
"version": "1.0.0",
"versionNote": "Updated plugin images.",
"author": "YourName",
"entry": "index.js",
"isBeta": false,
"githubRepo": "your-name/your-plugin",
"icon": "library_books",
"image": "https://raw.githubusercontent.com/YourName/your-repo/main/banner.png",
"storeImage": [
"https://raw.githubusercontent.com/YourName/your-repo/main/banner.png1",
"https://raw.githubusercontent.com/YourName/your-repo/main/banner.png2",
"https://raw.githubusercontent.com/YourName/your-repo/main/banner.png3",
]
"categories": ["Utility", "Productivity"],
"languages": [
"en",
"tr",
"de",
"fr",
"es",
"ja",
"ru",
"ar",
"zh",
"hi"
]
}(Note: You do not need to specify the version here. The bot automatically fetches the version number and release notes from your latest GitHub Release!)
Make sure you have created at least one Release on your GitHub repository (e.g., v1.0.0) and attached your plugin's .zip file to it.
- Fork this
kobar-plugins-registryrepository. - Open the
plugins.jsonfile. - Add your repository path (
Username/RepositoryName) to the array.
Example plugins.json:
[
"eedali/emoji-picker",
"YourName/your-repo"
]Submit a Pull Request (PR) to this repository. Once the KoBar team reviews and merges your PR, the bot will automatically index your plugin, and it will appear in the KoBar app within a few minutes!
- KoBar Main Project: https://github.com/Kobar-Project/KoBar
- Plugin Development Documentation: (Coming Soon)
Made with ❤️ by the KoBar Community.