# Beautify Anki

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bU0Cd_2bCQQXOfPpF%2F-M8bYnu8pXKuV1GQ4lC-%2Fezgif.com-crop.gif?alt=media\&token=d2c9feb9-118f-48ea-90da-d2f6e145e6c0)

## What is Beautify Anki&#x20;

Beautify Anki is an [Anki ](https://apps.ankiweb.net/)add-on that attempts to give Anki's deck browser and deck overview pages a modern material design look. Giving the user total control over the settings and with preset themes for those who don't like tempering with configuration files.

{% hint style="warning" %}

#### ⚠️ Disclaimer

This is a beta version that has only been tested on Anki 2.1.22. and 2.1.26 It probably conflicts with other addons that do similar things ([**check the list of known conflicting addons**](https://beautify-anki.shorouk.dev/conflicting-addons)). For feature request and bug report please post an [issue ](https://github.com/my-Anki/Beautify-Anki/issues)on Github
{% endhint %}

## 📥 Download

{% hint style="info" %}
Be sure to read [THIS ](https://beautify-anki.shorouk.dev/before-install)first before installing this addon.
{% endhint %}

The latest version of Beautify Anki is available on [Ankiweb ](https://ankiweb.net/shared/info/1150874988)

* Older versions and un published  can be found [here](https://github.com/my-Anki/Beautify-Anki/releases)

## 🌟 **Features**

* Material design look
* 4 themes and the ability to create user themes.
* Five alternating backgrounds for the home screen.
* An icon for each deck.
* A background for each deck.
* Enhanced look for the statistics.
* Colorful buttons in the reviewer.
* Complete control over the colors

## 🙏 Acknowledgments

* This Addon uses the following CSS and Javascript libraries
  * [Bootstrap](https://getbootstrap.com/)
  * [Animate.css](https://animate.style/)
  * [plotly](https://plotly.com/)
* The Statistics part in the Deck Browser is based on [Carlos Duarte](https://github.com/cjdduarte) addon ["More Decks Stats and Time Left"](https://ankiweb.net/shared/info/1556734708) which is based on Dmitry Mikheev code, in add-on "More decks overview stats" and [calumks](https://github.com/my-Anki/Beautify-Anki/blob/master/calumks@gmail.com) code, in add-on "Deck Stats"
* The Statistics part in The Deck Overview pages is based on Kazuwuqt addon ["More Overview Stats 2.1 "](https://ankiweb.net/shared/info/738807903) which is based on the More Overview Stats 2 add-on by [Martin Zuther](http://www.mzuther.de/) which is in turn based on "More Overview Stats" by [Calumks](https://github.com/my-Anki/Beautify-Anki/blob/master/calumks@gmail.com)
* Icon made by [srip](https://www.flaticon.com/authors/srip) from [www.flaticon.com](https://www.flaticon.com/)

## 📄 License

Beautify Anki n is released under GNU AGPL, version 3 or later Copyright (c) 2020 [Shorouk Abdelaziz](https://shorouk.dev)

## ❤️ Support

&#x20;If you like this addon please rate it on [Ankiweb](https://github.com/my-Anki/Beautify-Anki/blob/master) , share it with other Ankiers,  and maybe [<img src="https://camo.githubusercontent.com/647d5ff5e637d84b6dba979ee6856306f1c20417/68747470733a2f2f63646e2e6b6f2d66692e636f6d2f63646e2f6b6f6669322e706e673f763d32" alt="Buy Me a Coffee at ko-fi.com" data-size="line">](https://ko-fi.com/B0B51L5RI)<br>

## <br>


# Before you install

## Conflicting add-ons

This addon does lots of changes to Anki's interface. So, many addons won't be working smoothly or working at all with it.

The following list is of add-ons that we know for sure is not compatible with Beautify Anki

* Any unofficial Heatmap addon. The only supported addon is [the official one ](https://github.com/glutanimate/review-heatmap/releases)
* &#x20;[More Decks Stats and Time Left](https://ankiweb.net/shared/info/1556734708)
* &#x20;[More Overview Stats 2.1](https://ankiweb.net/shared/info/738807903)
* [Custom Background Image and Gear Icon](https://ankiweb.net/shared/info/1210908941)
* [Set Font Size](https://ankiweb.net/shared/info/651521808)

The following addons will only work if you set the **`change answer buttons`** option  to **`false`**

* [Minimal Flat Big Buttons](https://ankiweb.net/shared/info/1042429613)
* [Large and Colorful Buttons](https://ankiweb.net/shared/info/1829090218)
* [Button Colours (Good, Again)](https://ankiweb.net/shared/info/2494384865)
* [Automatic Scoring 2](https://ankiweb.net/shared/info/238560501)

## **The backgrounds**

the size of the backgrounds you'll use will affect the performance of the app so keep them in a small size and quality as much as possible

## Finally..

This addon is still in development. So keep that in mind when installing it and using it.


# Backgrounds and deck icons

### Deck Browser Backgrounds

There are five images that alternate in the home screen of Anki The images are placed in:\
`addon folder ➡️ assets` and named\
`background.jpg` , `background2.jpg` , `background3.jpg` , `background4.jpg` , `background5.jpg`

you can replace any of them with your favorite images.

{% hint style="info" %}
Use small size images for best performance. large images will slow down your Anki
{% endhint %}

### Decks' Icons

<div align="left"><img src="https://github.com/my-Anki/Beautify-Anki/raw/master/screenshots/icons.png?raw=true" alt=""></div>

* The default icon for all the decks is stored in:\
  `addon folder ➡️ assets ➡️ deck_icons ➡️ default.png` to change it replace `default.png` with your desired icon \[must be a png file]
* To add a custom icon for each Deck add an icon that matches the deck name in the folder\
  `addon folder ➡️ assets ➡️ deck_icons ➡️`

### Decks' Backgrounds

* The default background for all the decks is stored in:\
  `addon folder ➡️ assets ➡️ background.jpg` to change it replace `background.jpg` with your desired image \[must be a jpg file]
* To add a custom background for each Deck add an image that matches the deck name in the folder\
  `addon folder ➡️ assets ➡️ deck_backgrounds ➡️`


# Main settings

## Changing The main settings

The default customization settings are stored in the config.json file which you can access through:

> Anki's  menu bar ➡️ tools ➡️ add-ons choose "Beautify Anki" then > Configuration

and it looks like this:

```javascript
{
    "animation": true,
    "change answer buttons": true,
    "date_format": "eu",
    "note_correction_factors": {
        "English": 2,
        "Fr": 2
    },
    "theme": "default"
}
```

| Option                    | Usage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Default value | possible values                                                                                                                                                                                                                                        |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| animation                 | set it to ***true***. if you want the background to cycle through the 5 background images and to have text animation. Or, ***false*** to turn all the animation off.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | true          | true , false                                                                                                                                                                                                                                           |
| change answer buttons     | set it to ***true*** if you want to change the appearance of the answer buttons <img src="https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bbCoMkuURDOFKmYps%2F-M8be0pU345tiAF7VkBX%2FCapture.PNG?alt=media&amp;token=641a5e10-cb1a-43d5-8648-6a2405468c98" alt="" data-size="original">. Or, ***false*** if you are using other addons that changes the answer buttons like[ Minimal Flat Big Buttons](https://ankiweb.net/shared/info/1042429613) or [Large and Colorful Buttons](https://ankiweb.net/shared/info/1829090218)                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | true          | true , false                                                                                                                                                                                                                                           |
| date\_format              | to change the date format in the remaining widget in deck overview pages <img src="https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bbCoMkuURDOFKmYps%2F-M8bfQoToob3QZSn6jjg%2FCapture.PNG?alt=media&amp;token=cf1bbd61-9c05-42ff-8379-91ecc439e3c4" alt="" data-size="original">                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "eu"          | <p></p><ul><li>"us" displays as "%m/%d/%Y", meaning Month/Day/Year, ex: 04/26/1994</li><li>"asia" displays as "%Y/%m/%d", meaning Year/Month/Day, ex: 1994/04/26</li><li>"eu" displays as "%d.%m.%Y", meaning Day.Month.Year, ex: 26.04.1994</li></ul> |
| note\_correction\_factors | <p> If you want the add-on to display the number of notes in a deck, instead of the number of cards in the config Edit the <code>note\_correction\_factors</code> as follows to add a line that includes the beginning of the deck name (including all superdecks) and the number of different cards in the note type in the deck.<br>example :<br><code>"note\_correction\_factors": { "Custom": 2 , "English" : 3 }</code> <img src="https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bgLB2SAIp1eGleN3c%2F-M8bhF14MPutN4OGoB6L%2FCapture.PNG?alt=media&amp;token=cbe3d9de-9840-426d-93ff-d2f922ac3ed1" alt="" data-size="original"> </p><p><em>using note correction factor</em><img src="https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bgLB2SAIp1eGleN3c%2F-M8bhbCp2ORRdW9UpMwd%2FCapture.PNG?alt=media&amp;token=bf16a4bf-dc19-47b4-9271-bd0364c1699c" alt="" data-size="original"> </p><p>without using note correction factor</p> |               |                                                                                                                                                                                                                                                        |
| theme                     | to select the theme of the addon                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | "default"     | "default" , "starry" , "flamingo" , "sunrise" ,"***your custome made theme***"                                                                                                                                                                         |


# Customizing the themes

## Opening the theme file

{% hint style="info" %}
it's better if you duplicate the file before editing it. So, if something went wrong you can revert to the default version.
{% endhint %}

As for now, This ad-don comes with 4 preset themes each of which can be customized to your liking. To start customizing those themes, Head to&#x20;

> addon file / theme\_settings&#x20;

and open the file of the theme you want to edit.

This is what the `flamingo.json`  file ,for example, looks like.

```javascript
{

    "overlay-color1"    : "rgba(239, 83, 80, 0.55)",
    "overlay-color2"    : "rgba(4, 95, 95, 0.82)",
    "heatmap-background": true,

    "gear-icon-color"   :" rgba(55, 71, 79,1)",
    "buttons-color"     : " rgba(55, 71, 79,1)", 
    "bottombar-color"   : "rgba(128, 203, 196,1) ",
    "topbar-color"      : "rgba(128, 203, 196,1)" , 
    "topbar-position"   : "center",


    "large-areas-color"     : "rgba(215, 204, 200, 0.57)",
    "decks-border-color"    : "rgba(215, 204, 200, 0.57)",
    "decks-font-color"      : "rgba(0, 44, 66,1)",
    "filtered-deck-color"   : "rgba(59, 84, 208,1)",
    
    "DECK-BROWSER": {

        "wedgits-font-color"    : "rgba(238, 238, 238,1)" ,

        "overview-wedgit-bg"    : "rgba(77, 182, 172 , 0.8)" ,
        "average-wedgit-bg"     : " rgba(239, 83, 80,0.8)" ,
        "remaining-wedgit-bg"   : "rgba(198, 40, 40,0.8)" ,
        "new-wedgit-bg"         : "rgba(0, 131, 143,0.8)" ,
        "due-wedgit-bg"         : "rgba(120, 144, 156,0.8)" ,
        "total-wedgit-bg"       : "rgba(161, 136, 127,0.8)" ,

        "overview-wedgit-icon"  : "playlist_add_check" ,
        "average-wedgit-icon"   : "access_alarm" ,
        "remaining-wedgit-icon" : "timer" ,
        "new-wedgit-icon"       : "card_giftcard" ,
        "due-wedgit-icon"       : "edit" ,
        "total-wedgit-icon"     : "donut_small" 

    } ,
    "DECK-OVERVIEW" :{

        "wedgits-font-color"    : "rgba(255, 255, 255,1)",

        "total-notes-wedgit-bg" : "rgba(77, 182, 172 , 0.8)" ,
        "remaining-wedgit-bg"   : "rgba(198, 40, 40,0.8)" ,
        "new-wedgit-bg"         : "rgba(0, 131, 143,0.8)" ,
        "learning-wedgit-bg"    : "rgba(120, 144, 156,0.8)" ,
        "review-wedgit-bg"      : " rgba(239, 83, 80,0.8)",
        "total-wedgit-bg"       : "rgba(161, 136, 127,0.8)" ,

        
        "remaining-wedgit-icon" : "timer" ,
        "new-wedgit-icon"       : "card_giftcard" ,
        "learning-wedgit-icon"  : "description" ,
        "review-wedgit-icon"    : "edit" ,
        "total-wedgit-icon"     : "donut_small" ,

    
    "PIE-CHART":{
        "wedgits-font-color" : "rgba(224, 97, 0,1)"
    }
    }

}
```

## Changing the colors

All the colors values are [CSS colors](https://www.w3schools.com/cssref/css_colors.asp). If you already know what CSS is then just skip this part. If, on the other hand, you have no idea what is CSS, then all you need to know is that CSS is markup language that is used to style web-pages and Anki pages too.&#x20;

CSS colors are  a way of telling Anki (or any browser) what color should your element be. there're a few formats you can use to express a color for example: CadetBlue ,  #5F9EA0 , rgb(95, 158, 160) are all valid formats to express this color <img src="https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bhtjPpNGb7rl3dfst%2F-M8bmLAOfCZS9lJNVN1h%2FCapture.PNG?alt=media&amp;token=44e592a9-f6a0-4765-92bf-f16701a4fd3c" alt="" data-size="line"> .

The way I choose to express colors are this one :&#x20;

```javascript
rgba(77, 182, 172 , 0.8)
```

the first three values expresses the color it self and the last value expresses the opacity of the color and ranges from ( 0  which means transparent to  1 ).

If all you need to change is the transparency of the color then just modify the last value. if you want a completely different color then change the whole thing. and remember you can use whatever format you like not just the rgba() one I use.

## Changing the statistics icons

&#x20;This addon uses [materialize css](https://materializecss.com/) library. So, to change any of the default statistics widgets iconsyou'll need to get the icon name from [here](https://materializecss.com/icons.html) and replace the existing icon name with the one you chose.

## A map to what each option refers to

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bom2ZHEg_SF6qM1dt%2F-M8buN7sjWm3cUhF7wf5%2Fszoter_annotated_image.jpeg?alt=media\&token=0acb1cb6-31a3-4395-b5e3-bde06ea92e08)


# Creating your own themes

A good way to start  creating your themes  is copying one of the default themes and renaming it to your favorite name.Then, start changing the valus of each option. After you're done. change the theme value in the config file to the name of your new theme and restart Anki

> Anki's  menu bar ➡️ tools ➡️ add-ons choose "Beautify Anki" then > Configuration


# FAQ

## Where is the addon folder?

To open the addon folder: head to&#x20;

> Anki's  menu bar ➡️ tools ➡️ add-ons choose "Beautify Anki" then > view files

## I don't want a background image what should I do?

Set the **`animation`** option to **`false`**. and, delete all the background images and you'll be left with the color overlay only.

## Can I keep the default Answer buttons for other addons compatibility?

Yes,  set the **`change answer buttons`** option  to **`false`**

## I don't want the background behind heatmap review ?

you can disable it by editing the file of the theme you're using and changing **`heatmap-background`** option to **`false`**

## How do I report a bug , request a feature or ask for help ?

Post an issue on [Github](https://github.com/my-Anki/Beautify-Anki/issues). comments on Ankiweb and reddit might be considered but not for sure.


# Default theme

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bZOpmzwTVIoFlO6N1%2F-M8bZxk8J2jiS4vsYKS7%2Fanki_hkehnUnfBf.jpg?alt=media\&token=bd1efed1-adbc-461d-adba-4bf9098baa45)

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8bZOpmzwTVIoFlO6N1%2F-M8b_9NSnSZ0mGAuWYsH%2Fanki_RFWVKQmCFg.png?alt=media\&token=a0ac5fa5-b813-47b1-9913-ff9429310677)


# Starry theme

Recommended theme for Anki's night mode

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8b_RVmV2aKKgR6N26P%2F-M8b_ZPzCgy2PlNLpda3%2Fanki_ePLBL86car.png?alt=media\&token=5ce0f422-4faa-4ab9-b9e5-c6fce5de837d)

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8b_RVmV2aKKgR6N26P%2F-M8baKrfXNstnzSKhj2Y%2Fanki_9B04XtFVl5.png?alt=media\&token=57c3cb58-0441-44c5-b342-f7b92253952d)

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8b_RVmV2aKKgR6N26P%2F-M8b_yN_20NDqTrWcDw9%2Fanki_12yWF3reHg.png?alt=media\&token=2af3400d-6f51-4179-9ad5-769e4ad69b1f)


# Flamingo theme

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8baa0gq3EKEuZklrfp%2F-M8baf2EwG055lJJ4odr%2Fanki_3AIxrTVnf4.jpg?alt=media\&token=449f24b3-5d55-4987-a8fd-8818b21cd88e)

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8baa0gq3EKEuZklrfp%2F-M8baoYn6H4p6Tv2SqBu%2Fanki_5ckRI3vjCn.png?alt=media\&token=c0cf42e8-169d-496c-85b5-92c3cfe26f1e)


# Sunrise theme

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8baufAoLXCNgq5NP0f%2F-M8bb1--NOUaSK9jzE5i%2Fanki_QpNxEbqarg.png?alt=media\&token=16047dcb-647c-4713-814f-4f84215db394)

![](https://3070945225-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8bIX1VrL7AvQYQHy62%2F-M8baufAoLXCNgq5NP0f%2F-M8bb8MrUpiXVAQH1FaA%2Fanki_uY2r0tOWgM.jpg?alt=media\&token=5bdc9419-dd3f-424a-9442-10ebcde2699b)


