# OMI Project Branding plugin for Kanboard

Project Branding plugin for Kanboard, to allow a custom logo and some brand colours per project.  
This is currently in progress. So far you can add a logo per project, and underline it with a custom colour .... yah!!!  
There is a lot of styles to build in yet and the header/title still needs fixing.  
I'm on it don't worry :)  

## Author
* Dwayne Pivac @ OMI NZ
* License MIT

## Requirements

* Kanboard 1.2 
* PHP 8.2.0
  
It is possible this works with other versions of Kanboard and PHP, but these are the version this was built and tested on.  

## How to install this plugin

All Kanboard plugins are found in the `plugins` directory. In general you just put your plugin there and that's about it!

### CLI

In a terminal window ( or command for Windoze ) browse/cd to your Kanboard `plugins` directory and issue this command  

#### git clone ( best method )

`git clone https://vcs.nz/ominz/OMIProjectBranding.git`  

#### wget

##### zip ( Windoze )

`wget https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip`   

`unzip main.zip`  

`del main.zip`  

##### tar ( Nix )

`wget https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz`  

`tar -xzf main.tar.gz`  

`rm main.tar.gz`  

### GUI

Download either zip file :  
* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip](https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip)
* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz](https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz)

and uncompress/unzip/untar into your Kanboard `plugins` directory  

### Upgrading

The best method is to use `git pull` if you installed via `git clone`.  
Otherwise the usual way is to use the Uninstall link in Kanboard, then copy the plugin directory into the 'plugins', directory.  
As your settings are kept in the database, you should back your database up before upgrading.  
Especially in the early versions where the database table will be modified.  
This message will change when the code is finalised :)  


## How to use

Use the "Branding" link in the left hand menu when you're in a project.  
You can modify the logo per project by entering an image URL ( no upload possible here ) into the 'Logo URL' field.  
The header colours, background and foreground can also be modified, via a dropdown list of built in colours and custom colours that you can add yourself [See the 'Custom Colours File' below](#custom-colours-file).  

## Custom Colours File

The dropdown colour picker uses a built in list, which has a limited number of colours.  
This plugin adds a set of custom colours to this list, and also allows you to modify the list so you can add your own colours.  
The list is a simple Name=Value style text file called `OMIProjectBrandingColours.txt` living in your data folder.  
It goes, **friendly colour name**=**css colour**   
e.g.  
```css
Light-as Yellow=#ff9
White=#fff
This is also white=#ffffff
HoT PinK=hotpink
Faded Red=rgba(255,0,0,0.5)
```  
Don't forget to back this file up if you upgrade your Kanboard.  

## Compatibility 
Compatibility with other Plugins.  
So far I've used it successfully with Customizer, and WeKanboard.  
It will override the global logo ( which is the point of this plugin ) in the header when you're in a project.  

Please let me know if there are any issues with the header styles, when using other plugins.  
[You can add issues here.](https://vcs.nz/ominz/OMIProjectBranding/issues/)  


## Maintainers

* Dwayne <dwayne at omi dot nz>
* OMI Ltd. <adm at omi dot nz>