Table of Contents

  1. About
  2. Changelog
  3. Theming and UI Mode
  4. Options
  5. Donation

About


You will need to put information about yourself (and whoever else helped you) into /res/values/dev_about.xml. This should be mostly self-explanatory; each item in each array represents a card in the About page. The card titles (people's names) go in the items in about_titles, descriptions go in about_descriptions, etc.

You can easily change the buttons displayed at the bottom of each of your cards. The names go in the first array, the links they lead to go in the second. Each button name/link is separated by a pipe (|) character.

Important note: do not remove the bottom 3 arrays in each item, doing so will violate the terms of using this dashboard free of charge.


Changelog


Not much explanation should be needed for this, but you can enable/disable showing a changelog for new versions in /res/values/dev_changelog.xml. You can even use basic HTML formatting in each list item.


Theming and UI Mode


The first boolean in the image below (allow_theme_switching) determines whether or not users will be able to switch between the light and dark theme from the dashboard UI. When true, there will be a checkbox in the overflow menu. The second boolean (dark_theme_default) sets whether the dashboard will use the dark theme initially. By default, it will not; it will use the light theme initially.

The values under the "light theme" and "dark theme" comments allow you to switch out the colors used throughout the dashboard. Initially, they are set to use the default colors that we decided to use for Polar. It's recommended you change theme colors to fit your icon pack's branding.


It's likely you'd want to change what's displayed at the top of the navigation drawer if you choose to not use tabs. You can do so from the /res/layout/drawer_header.xml file.

android:scaleType should usually either be fitXY or centerCrop. You should also put the PNG you're using as the header in /res/drawable-nodpi.


Options


By default, Polar will use a tabbed UI. You can easily make Polar use a navigation drawer instead, just by setting nav_drawer_mode_default to true. allow_nav_drawer_mode_switch determines whether users are allowed to switch between the light and dark theme.

A lot of designers like to have a homepage that users will see when they first open the dashboard. We encourage you to try not using the homepage, but we included this function for those who really need it. You can enable or disable the homepage using the homepage_enabled boolean. The other settings should be self-explanatory.


Below, a few options are displayed.

  1. icon_request_email — an email that icon requests are sent to. Leave empty to disable icon requests.
  2. icon_request_maxcount — specifies a maximum number of icons users can request icons for (per icon request). Use -1 to disable this.
  3. icon_request_limit_interval — 0 or less to disable. An interval in seconds in which the user must wait after sending an icon request before sending another.
  4. licensing_public_key — the Base64 key from the Google Play Developer Console (Under Services & APIs).
  5. persist_selected_page — when true, the dashboard will open the last selected page when restarted.
  6. feedback_email — an email address feedback can be sent to from the About page. Leave empty to disable this feature.
  7. feedback_subject_line — a subject line used in feedback emails.



Donation

You can easily accept donation from your users. The donation_license_key is the same value you'd use for license_public_key. However, leaving it blank will disable donation. When enabled, a donation button will appear at the top of the About page.

donate_option_names should be pretty self-explanatory. donate_option_ids are in-app product IDs setup from the Developer Console: