os-thm

Stable version: 3.0.3 Development version: (Not planned yet)

[]() []() []() []() []() []()

Written by members of ThatCakeID: リェンーゆく, and Iyxan23. Some app's UI design & theme made by: thatcakepiece.

os-thm (stands for: opensource-theme) is a piece of software that can manage, edit, import, export or remove theme. One of the os-thm's key feature is that the theme can be applied globally, means the theme can used by apps that have implemented os-thm. os-thm is intended to be open-source, rich, and easy to use.

WARN: os-thm is not maintained anymore

So, let's get started!

For Users

os-thm is an easier way to change your theme globally for every single app that has implemented os-thm with a single click of a button.

Make sure to have the os-thm Manager app installed, as it's supposed to be the manager for all os-thm themes. You can download it here.

For Developers

os-thm is an easier way to make theme accessible to the user without worrying about managing themes, all of that (adding, importing, removing, editing themes) are managed by os-thm, and the best part is, it's open source!

How to implement os-thm to your app?

(Note: for sketchware users, you might want to use os-thm-sketchware)

• Add Jitpack repositories to your root build.gradle

  allprojects {
      repositories {
          maven { url 'https://jitpack.io' }
      }
  }

• Add os-thm implementation to your build.gradle

  dependencies {
          ...
      implementation 'com.github.ThatCakeID:os-thm-android:3.0.3'
      ...
  }

  ..or if you have trouble while implementing the library, try downloading the .aar file in the package tab and import it as library on android studio.

• Grant Read and Write External Storage Permission

  That's it.

  How to use the library?

  How to apply the current applied theme with os-thm

  OsThmTheme currentTheme = osthmEngine.getCurrentTheme();
  myFab.setBackgroundColor(currentTheme.colorAccent);
  rootView.setBackgroundColor(currentTheme.colorBackground);
  etc...

  This system may change in the future.

  That's it!

  Colors meanings

  Here is a table showing the meanings of the colors:

  Num	Color Name	Color Meaning
  1	colorPrimary	The primary color for your app (ex: actionBar)
  2	colorPrimaryDark	The darker primary color for your app (ex: statusbar)
  3	colorAccent	The accent color for your app (ex: Button & FAB)
  4	colorStatusbarTint	The tint color of the statusbar icon (can only be black[0] and white[1])
  5	colorBackground	The background color for the root container
  6	colorBackgroundText	The text color for TextView(s) that's inside the root container
  7	colorPrimaryText	The primary text color
  8	colorAccentText	The text or tint color for the button/FAB's image source
  9	shadow	The boolean value to determine if shadow is enabled or not (can only be 1 and 0)
  10	colorControlHighlight	The ripple color
  11	colorHint	The color for the EditText hint
  12	colorPrimaryTint	The color for the ActionBar icons or items
  13	colorBackgroundTint	The tint color for images in a root container
  14	colorBackgroundCard	The background color for the card in a root container
  15	colorBackgroundCardTint	The color tint for an ImageView in a card in a root container
  16	colorBackgroundCardText	The TextView color in a card inside a container that's in the root container
  17	colorPrimaryCard	The background color for a card inside an appBar
  18	colorPrimaryCardTint	The color tint for an ImageView in a card inside an appBar
  19	colorPrimaryCardText	The TextView color in a card that is inside of an appBar
  20	colorDialog	The background color for the root dialog container
  21	colorDialogText	The text color for TextView(s) that's inside the dialog root container
  22	colorDialogTint	The tint color for images in a dialog root container

  If you didn't understand the table above, you can use the Theme Editor on os-thm Theme Manager to determine which colors points to which.

Branches:

• master: Current latest and stable version of os-thm-android.

• dev: Current canary branch with newest features, bug patches, and still in development state.

  Documentation written by Iyxan23 and slightly edited by リェンーゆく

  (c) Copyright 2020 ThatCakeID