camohan/layersthemeplugin_example

Example Theme for the new Layers Manager

Layers Theme PluginExample

Welcome to the example theme which will help you to convert your Layers team to a proper plugin which can be used with the Layers Manager app since version 4.0

If you want to learn what a plugin overlay is and how to use it, have a look at the Wiki found here https://github.com/BitSyko/LayersThemePlugin_Example/wiki

The current plugin Version is 1.1 which was released on the twenty second of July 2015.

• Whats new in Version 1.1?

  • Easier adoption for new themers:
  • Move most of the changes a themer has to make from android manifest to strings.xml
  • Split the Layers_OverlayNames into NormalOverlaynames and StyleSpecificoverlayNames
  • New recommended screenshot height: 750px (to prevent the layers Manager app from crashing on Low Memory devices)
  • A new documentation on how to make a Plugin Overlay

• Whats new in Version 1.0?

  • Initial Release

How to use Plugin Version 1.1 or greater: https://github.com/BitSyko/LayersThemePlugin_Example/wiki/How-to-make-a-Plugin-Overlay

Outdated HOW TO: Only works with plugin Version 1.0

##How to use ###Download & open download the sample app from https://github.com/LayersManager/LayersThemePlugin_Example/releases open Android Studio, click on File, import project. Select the downloaded project.

###Changes to Manifest

• inside the project navigate to the AndroidManifest.xml

• at the top part of the Manifest you have to change the following things:
  change the marked part in android:sharedUserId to your theme name. (example: exampleUI)
  change the marked part in android:label the desired app Name (shown in android in the settings app (example: Example UI)

• at the bottom you have to add some basic information about your theme

  • Layers_Name = the name of your theme (it can contain spaces)
    
  • Layers_Developer = your name
    
  • Layers_Colors = if you include some overlays which are available in different colors, add the colors here.
    
  • Layers_Description = Short description about your theme
    
  • Layers_WhatsNew = Whats new in your themes latest update.
    
  • Layers_OverlayNames = Names of the apps you include Overlays for.
    
    • BE AWARE: If you use...
      • Only "normal" Overlays: the list is like: "App,App,App,App,App, "
      • Only color specific Overlays: the list is like: " ,App,App,App,App,App"
      • both normal and color specific Overlays: the list is like: "App,App,App, ,App,App"

###Change Package Name Look at the project panel in android studio (the one on the left). In the top right corner you will see a little gear icon. Click on it. You will see the following:

In this dialog you have to click on Compact Empty Middle Packages
Select the schnettler folder (in JAVA/com/ and rightclick it. Choose refactor and then rename.
A warning window will pop up. Just click on Rename package.
Enter the desired first part of your package name and click refactor.
At the bottom of the screen a refactoring preview will appear. Just click on DO REFACTOR at the left corner.

Do the same with the exampleUi folder, name it like your desired second part of the packagename

Finally open the build.gradle and change the package name there too.

###Changes to the resources

In a file explorer open the following location of the project:

• Drawables (app\src\main\res\drawable-xxhdpi)
  • You have to replace the following drawables with your own ones:
    
    • Heroimage: A image displayed at the top of your themes page (dimensions should be about 1598*1052)
      
      
  • icon: An icon displayed in the overlay chooser of the Layers Manager
    
    
    
  • screenshot1,2,3: Screenshots visible on your themes installation page (height about 1100px)
    
    
    
• Overlay zips (app\src\main\assets\Files)
  • How to name the Overlay apk´s: ThemeName_OverlayedAppNameWithoutSpaces.apk (OverlayedAppNameWith... = one item you put into the OverlayNames list, but without the spaces)
  • if
    • Only normal Overlays: Generate a zip Named: ThemeName_General.zip (ThemeName = Name defined in the Manifest, but without spaces, ex: ExampleUi) and put the Overlays into it
    • Only Color Overlays: Generate zips named: ThemeName_AColor.zip and put the Overlays into it.
    • both normal and color: Generate a zip named ThemeName_General.zip and for each color a ThemeName_AColor.zip and put the Overlays which are only available in one color into the General zip and the others into the Color zips

##You are Ready

Compile/run the app and test it in the new Layers Manager :) I hope the tutorial was understandable and if you still have any questions or a suggestions on how to improve the tutorial, just let me know...