https://github.com/robweber/kodi-shield
PHP script to create a shields.io badge for your Kodi addon project
https://github.com/robweber/kodi-shield
kodi php7
Last synced: 11 months ago
JSON representation
PHP script to create a shields.io badge for your Kodi addon project
- Host: GitHub
- URL: https://github.com/robweber/kodi-shield
- Owner: robweber
- License: gpl-3.0
- Created: 2019-10-09T20:18:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-07T15:39:45.000Z (over 2 years ago)
- Last Synced: 2025-05-12T20:29:01.218Z (about 1 year ago)
- Topics: kodi, php7
- Language: PHP
- Size: 39.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kodi Shield [](https://github.com/robweber/kodi-shield/blob/master/LICENSE)
This is a PHP application that can be used to generate a badge for your Kodi addon using the [Shields.io JSON endpoint](https://shields.io/endpoint) syntax. The result is badge you can include with your Kodi addon so people know at a glance what versions of Kodi your addon will run on.
## How It Works
When queried the application will pull the ```addon.xml``` file of your addon from it's repository and calculate the compatible Kodi versions based on the official [Kodi compatibility matrix](https://kodi.wiki/view/Addon.xml#Dependency_versions).
__Please note: this script assumes your project is hosted on Github and is the only project in a given repo, with the addon.xml file in the root of the project folder. I've noticed this is the setup for most Kodi addons__
## Install
You can install this script on any webserver that runs PHP using composer. It does use the Simple XML library for reading in the ```addon.xml``` file of your project so the correct Kodi version can be determined. A sample Apache ```.htaccess``` file using mod_rewrite is given, for other server configurations [PRs are accepted](https://github.com/robweber/kodi-shield/pulls)!
In the ```src/index.php``` file the following variables needed to be modified to fit your server setup:
```
//MODIFY THESE TO MATCH YOUR SITUATION
$domainPath = 'http://yourdomain.com' //set this to the full path of your server, can be an IP address if no domain name
$basePath = '/kodi-shield'; //set this to the base path on your server
```
## Usage
This script uses the [Shields.io JSON endpoint](https://shields.io/endpoint) to return the JSON needed to generate the badge. Read the information on the Shields.io website for more information on how this works. An example of using the badge within the markdown file of your project could be:
```
```
You can generate a URL of your own using the URL generator on the [Shields.io website](https://shields.io/endpoint) (scroll to the bottom of the page). The script takes the following URL parameters in the following order (some are optional):
```
/kodi-shield/:username/:repo/:branch/:shownames/:currentonly
```
* username __required__ - your Github username
* repo __required__ - the name of the repository for your addon
* branch - the branch name, master is assumed by default
* shownames - a true/false value on if the codenames for each Kodi version should also be shown
* currentonly - another true/false value. By default all compatible Kodi versions are shown, this shows only the most current supported version.
## Examples
### Default Badge:
```
```
### Badge with code names:
```
```
### Badge with only the most current version:
```
```
