Created Themes (markdown)

Rsl1122 2017-09-25 21:59:07 +03:00
parent 24b19bee1b
commit d5630e06c3
1 changed files with 101 additions and 0 deletions

101
Themes.md Normal file

@ -0,0 +1,101 @@
![Plan Header](https://puu.sh/vQyow.jpg)
# Themes
Theme system is a new addition in version 4.0.0. It brings a lot more flexibility for colors, backgrounds and font used on the web pages.
## Themes
Here is a list of Themes currently available in version 4.0.0. (Click the link to view an image.)
- [Default](http://puu.sh/xIEC1/ccde460c15.png) (Green)
- [Blaze](http://puu.sh/xIEFD/e66ec6d592.png)
- [BlueGray](http://puu.sh/xIEIN/95a3a549cf.png)
- [DarkRed](http://puu.sh/xIEMd/f649022be8.png)
- [Greyscale](http://puu.sh/xIEPi/e0fc0545a8.png)
- [Indigo](http://puu.sh/xIESD/e6ea052617.png)
- [Night](http://puu.sh/xIF0G/6f95685e60.png)
- [Pink](http://puu.sh/xIF3e/991787fce1.png)
- [Purple](http://puu.sh/xIF5E/3ff85bb37a.png)
If you set `Theme.Base` as a theme that is not defined the page will look like [this](http://puu.sh/xIEXz/2f7678a2ac.png)
**All colors can be changed, so if you do not like a single color you can set it with the other settings.**
If you want a certain themed theme to be created just ask - They're one of the easiest things to implement.
Looking for the color codes?
- [Theme enum](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/java/com/djrapitops/plan/systems/webserver/theme/Theme.java)
## Base
`Theme.Base` is the main config setting that affects all other settings.
If a color-setting is set as "Base" it will use the color of the Base theme.
Example:
- Base is set as 'bluegray'
- Colors.Main is set as 'base'
- Theme system translates the setting to 'bluegray' (Without changing the config setting)
If a faulty color setting is used the Base color will be used instead.
## Borrow colors from other Themes
Let's say you like the default graph colors, but want to use another theme like Indigo.
Indigo will try to set the graph colors as a shade of blue.
Instead of figuring the color codes for the default theme's graphs, they can be used directly:
```
Theme:
Base: Indigo
...
Graphs:
PunchCard: Default
PlayersOnline: Default
TPS:
High-Threshold: 18
Medium-Threshold: 10
High: Default
Medium: Default
Low: Default
CPU: Default
RAM: Default
Chunks: Default
Entities: Default
```
[And voilá](http://puu.sh/xIGLR/11493d6446.png)
This applies to all settings that accept 'Base' as an option.
## Custom colors
All the settings except `Theme.Base` accept a Html color code.
This means that any setting can be set as any color.
**Example:**
`Colors.Secondary: '#ff75f3'`
![img](http://puu.sh/xIFnT/56cd9044bc.png)
## Background images
Some color settings accept image URLs as input.
Please note that when using Background images, elements such as the Plan Icon use the `Theme.Base` color
`Colors.Main: https://www.filterforge.com/filters/11635-v7.jpg` with `Theme.Base: Blaze`
![img](http://puu.sh/xIFyP/04f07a2602.png)
## Changing the Font
The font can also be changed.
By default Quicksand is in use. (`https://fonts.googleapis.com/css?family=Quicksand:300,400` and `'''Quicksand'', sans-serif'`)
If you want to use the Verdana font (Used in 3.6.4), set `FontFamily: 'Verdana, sans-serif'` and `FontStyleSheet: ''`
If you want to use another web font, set `FontFamily: '''WebFontName'', sans-serif'` and `FontStyleSheet: 'linkToFontStyleSheet'`
## Pie Chart colors
Pie charts require many different colors so defining each one of them per theme would have taken a lot of time.
Instead all of the color codes can be defined directly.
Format: `'"#000000", "#111"'`