[TUTORIAL] Comprehensive Guide for AROMA Installer For Beginners!! | 27/08/13

I.1- CREATING DIFFERENT TYPES OF SUB WINDOWS

Now Lets create a sub window to be displayed when the first option of the Menu is selected in the Installer

Scroll n Find this code

Code:

##
#  Select Type of Install
#

if prop("menu.prop","selected")=="1" then

Since this is the first option in menu window, that's why we have =="1" here

I.1.1 SELECT BOX SUB WINDOW

Now Scroll down and find this Code-

Code:

##
# Sub Window 1
#

selectbox(
  #-- Title
    "TITLE 1",
  
  #-- Sub Title
    "SUB TITLE 1",
  
  #-- Icon:
     "icons/install",
	 
  #-- Will be saved in /tmp/aroma/window1.prop
    "window1.prop",
  
	  #----------------------------------[ Selectbox With Groups ]-----------------------------------#
	  # TITLE            |  SUBTITLE                                                 | Initial Value #
	  #------------------+-----------------------------------------------------------+---------------#  
  
       "Select One",        "",                                                        2,         #-- Group 1. key = "selected.1"
        "OPTION 1",         "OPTION 1 DESCRIPTION",                                       0,      #-- selected.1 = 1
        "OPTION 2",         "OPTION 2 DESCRIPTION",                                       1       #-- selected.1 = 2
   
	  #--------[ Initial Value = 0: Unselected, 1: Selected, 2: Group Item, 3: Not Visible ]---------#

);

The type of window used is of selectbox attribute, Which means that only one out of the above Option can be selected at a time

Edit the TITLE, SUBTITLE, OPTION 1 and OPTION 2 as well as their DESCRIPTION as per your requirement

Here OPTION 2 has initial value 1 which means that It is selected by default,
(1 stands for Selected n 0 stands for Unselected)

NOTE: The last string has no comma "," after its initial value, Its not a typo

Method to add new Option--
Add this--

Code:

        "OPTION 3",         "OPTION 3 DESCRIPTION",                                       0       #-- selected.1 = 3

Note that if this is your 3rd Option then then in 2nd option add "," after its initial value

So after adding new option this is how it looks on Text Editor

And this is how it looks in Installer

-> SUB WINDOW 1 HAS BEEN SUCCESSFULLY CREATED


So now lets create sub window 2

Now Scroll down and find this Code-

Code:

##
# Sub Window 2
#

selectbox(
  #-- Title
	"TITLE 2",
	  
  #-- Sub Title
    "SUB TITLE 2",
	  
  #-- Icon:
	"@default",
	  
  #-- Will be saved in /tmp/aroma/window2.prop
	"window2.prop",

  
	  #----------------------------------[ Selectbox With Groups ]-----------------------------------#
	  # TITLE            |  SUBTITLE                                                 | Initial Value #
	  #------------------+-----------------------------------------------------------+---------------#  
  
	
      "Select One",          "",                                                        2,         #-- Group 1. key = "selected.1"
      "OPTION 1",            "OPTION 1 SUBTITLE",                         			      1,       #-- selected.1 = 1
	  "OPTION 2",   		 "OPTION 2 SUBTITLE",                  				          0,       #-- selected.1 = 2
	  "OPTION 3",            "OPTION 3 SUBTITLE",                                         0,       #-- selected.1 = 3
	  "OPTION 4",         	 "OPTION 4 SUBTITLE",                    	                  0        #-- selected.1 = 4

  	  #--------[ Initial Value = 0: Unselected, 1: Selected, 2: Group Item, 3: Not Visible ]---------#

);

The type of window used is of selectbox attribute, Which means that only one out of the above Option can be selected at a time

Edit the TITLE, SUBTITLE, OPTIONS as well as their DESCRIPTION as per your requirement

Here OPTION 1 has initial value 1 which means that It is selected by default,
(1 stands for Selected n 0 stands for Unselected)

NOTE: The last string has no comma "," after its initial value, Its not a typo

NOTE: The same method as described above is to be used to create more options

And this is how it looks in Installer

NOTE: If you just want a single sub window, delete the entire code for sub window 2

NOTE: If you want to add a new sub window, add the above code again but edit some values as listed below-

TITLE, SUBTITLE, OPTIONS as well as their DESCRIPTION as per your requirement
Also edit "window2.prop", to "window3.prop",

NOTE: The same method as described above is to be used to create more options

-> SUB WINDOW 2 HAS BEEN SUCCESSFULLY CREATED

NOW I ASSUME THAT YOU HAVE SUCCESSFULLY LEARNT TO CREATE THE SUB WINDOWS of selectbox attribute,
RE READ THE CODE AGAIN TO DEVELOP MORE UNDERSTANDING,
IF THIS IS YOUR FIRST TIME IT MIGHT TAKE SOME TIME TO FIGURE OUT THINGS, BUT ITS NEITHER TOO DIFFICULT

Click to expand...

Click to collapse

I.1.2- CREATING CHECKBOX SUB WINDOW

NOW WE SHALL LEARN TO CREATE A CHECKBOX BASED SUB WINDOW FROM WHICH WE CAN SELECT MORE THAN ONE OPTION

Scroll and find this code in aroma-config-

Code:

##
# Sub Window with CheckBoxes
#

checkbox(
  # Title
	"TITLE OF CHECKBOX",
  
  # Sub Title
	"SUB TITLE OF CHECKBOX HERE",
 
  # Icon
	"@update",
  
  # Will be saved in /tmp/aroma/checkbox1.prop
	"checkbox1.prop",
  
  #----------------------------------[ Selectbox With Groups ]-----------------------------------#
  # TITLE            |  SUBTITLE                                                 | Initial Value #
  #------------------+-----------------------------------------------------------+---------------#
  
	"AVAILABLE OPTIONS",     "",                                                            2,      #-- group 1
	"I AM A REAL DEV",    "IF YOU ARE THE REAL DEVELOPER",                               1,      #-- item.1.1
	"I AM A NOOBS",       "IF YOU ARE THE REAL NOOBS",                                   0,      #-- item.1.2
	"I AM XDA-DEVELOPERS","IF YOU HAVE AN ACCOUNT IN XDA-DEVELOPERS.COM",                0,      #-- item.1.3
	
	"YOUR PROJECTS",      "",                                                            2,      #-- Group 2
	"CUSTOM ROM",         "IF YOU MADE A CUSTOM ROM",                                    1,      #-- item.2.1
	"CUSTOM TROLL",       "IF YOU POST MANY TROLLS IN FORUM",                            0       #-- item.2.2
	
	  #--------[ Initial Value = 0: Unselected, 1: Selected, 2: Group Item, 3: Not Visible ]---------#
);

The type of window used is of checkbox attribute, Which means that only one out of the above Option can be selected at a time

Edit the TITLE, SUBTITLE, THE OPTIONS VALUE, AND THE OPTIONS' DESCRIPTION as per your requirement

Here item.1.1 and item.2.1 has initial value 1 which means that It is selected by default,
(1 stands for Selected n 0 stands for Unselected)

NOTE: The last string has no comma "," after its initial value, Its not a typo

NOTE: If you want to create a new item add this string

Code:

	"CUSTOM TROLL 2",       "IF YOU BLAH BLAH",                                          0       #-- item.2.3

Note that if this is your 3rd item in 2nd Group, so now add "," after item.2.2's initial value

So after adding new option this is how it looks on Text Editor

And this is how it looks in Installer

NOTE: If you dont want a sub window with checkboxes, delete the above code

NOTE: If you want to add a new sub window with checkboxes, add the above code again but edit some values as listed below-

TITLE, SUBTITLE, OPTIONS as well as their DESCRIPTION as per your requirement
Also edit "checkbox1.prop", to "checkbox2.prop",

NOTE: The same method as described above is to be used to create more options

-> SUB WINDOW WITH CHECKBOXES HAS BEEN SUCCESSFULLY CREATED

NOW I ASSUME THAT YOU HAVE SUCCESSFULLY LEARNT TO CREATE THE SUB WINDOWS of checkbox attribute,
RE READ THE CODE AGAIN TO DEVELOP MORE UNDERSTANDING,
IF THIS IS YOUR FIRST TIME IT MIGHT TAKE SOME TIME TO FIGURE OUT THINGS, BUT ITS NEITHER TOO DIFFICULT

Click to expand...

Click to collapse

Click to expand...

Click to collapse

Now I am going to teach you some additional optional commands


1- ALERT BOX
Scroll and Find this Code-

Code:

##
# Alert Window
#

alert( "Attention", "PLACE YOUR TEXT HERE");

This code is for creating additional popup alert
Edit the text to be displayed as per your desire

If you don't want alert popup simply delete the Code above

This is how it looks in Installer

-> NOW YOU HAVE SUCCESSFULLY CREATED A POPUP ALERT BOX

2. PRE INSTALLATION UI

Now scroll and find this code-

Code:

# Installation UI

ini_set("text_next", "Install Now");
ini_set("icon_next", "@installbutton");
  
viewbox(
  #-- Title
    "Ready to Install",

  #-- Text
    "ROM is ready to be installed.\n\n"+
	"Press <b>Install</b> to begin the installation.\n\n"+
	"To review or change any of your installation settings, press <b>Back</b>.\n\n"+
	"Press Menu -> Quit Installation to quit.",

  #-- Icon
    "@install"
);

This is to create a window just before installation process starts

If you don't want Pre installation window simply delete the Code above,


This is how it looks in Installer

Now you have successfully learnt to create the above Optional windows n popups
These are the two Optional windows which are frequently used in the Installer to make it more Interactive

Click to expand...

Click to collapse

Now scroll and find this code just below the Installation UI Window

Code:

endif;

REMEMER DONT DELETE THE "endif;" It is in the continuation from the above "if prop("menu.prop","selected")=="1" then" code

Now comes the last and Important window for Installer

Scroll and find this code in aroma-config-

Code:

##
# INSTALLATION PROCESS
#

if prop("menu.prop","selected")== "1" 
then

ini_set("text_next", "Next");
ini_set("icon_next", "@next");

install(
  "YOUR ROM/Mod NAME™ Installation",
  getvar("rom_name") + "\n" +
  "Please wait while this ROM blows up your device :P" +
  "",
  "icons/install"
);

ini_set("text_next", "Finish");
ini_set("icon_next", "@finish");

checkviewbox(
  #-- Title
    "Installation Completed",
	
  #-- Text
    "<#selectbg_g><b>Congrats...</b></#>\n\n"+
    "<b>"+ini_get("rom_name")+"</b> has been installed into your device.\n\n",
    
#-- Icon
    "@welcome",

  #-- Checkbox Text
    "Reboot your device now.",

  #-- Initial Checkbox value ( 0=unchecked, 1=checked ) -  (Optional, default:0)
    "1",

  #-- Save checked value in variable "reboot_it" (Optional)
    "reboot_it"
);
endif;

###
# Check if reboot checkbox was checked

if
  getvar("reboot_it")=="1"
then
  #
  # reboot("onfinish");   - Reboot if anything finished
  # reboot("now");        - Reboot Directly
  # reboot("disable");    - If you set reboot("onfinish") before, use this command to revert it.
  #
  reboot("onfinish");
endif;

This is the code for creating an Installation Progress and logs User Interface and the Reboot Now Option

Edit this string in above code to your ROM/Mod name
"YOUR ROM/Mod NAME™ Installation",

Rest of all the code is fine

This is how it looks like in Installer

Click to expand...

Click to collapse

Now save the file aroma-config with Ctrl+S or save button

Click to expand...

Click to collapse

NOW YOU HAVE SUCCESSFULLY CREATED THE AROMA-CONFIG FILE FOR INSTALLER

THIS WAS ALL ABOUT CREATING THE AROMA INSTALLER USER INTERFACE...
I HAVE COVERED ALL THE FREQUENTLY USED COMMANDS IN THE TUTORIAL
THANKS TO @amarullz FOR WONDERFUL AROMA INSTALLER
IF ANY DOUBTS/ERRORS POST THEM HERE

IN THE NEXT POST WE ARE GOING TO LEARN ABOUT UPDATER-SCRIPT CORRESPONDING TO THE AROMA-CONFIG

In this tutorial we are going to learn about creating updater script corresponding to the Aroma config we have created
This part is very easy indeed if you have read all my aroma-config guide

So the very first thing you have to do manually is to take a update-binary from any custom rom/mod from your device forum...

You can find update-binary in this directory- meta-inf\com\google\android\
replace it with custom update-binary so that your installer will not give errors while installing the mod/rom

Click to expand...

Click to collapse

1.) understanding the basics
so now lets start, open the updater-script file located in the directory- meta-inf\com\google\android\ in notepad++

scroll and find this code-

Code:

if
    file_getprop("/tmp/aroma-data/menu.prop","selected") == "1"
     then

so now you know why "menu.prop" was declared there in aroma-config
the == "1" signifies here that the we are now going to define the sub windows inside the first option of menu.prop

now edit this code to your mod/rom name

Code:

		ui_print("-> installing rom/mod name");

scroll and find this code-

Code:

		ui_print("-> mounting system...");
	run_program("/sbin/busybox", "mount", "/system");

this is for mounting the system partition so that you can add/delete files from system partition

Click to expand...

Click to collapse

2.) Defining the sub windows

Now we will define the coding for working of sub menus we created in aroma-config

2.1.) For sub window 1

Scroll and find this code-

Code:

if
    file_getprop("/tmp/aroma/window1.prop","selected.1") == "1"
     then
    ui_print("-> installing option 1...");
	package_extract_dir("aroma/window1/option1", "/system");
endif;

edit the ui_print("-> installing option 1..."); string as per your rom/mod option you defined in aroma-config

now place your option 1 customisation app to the folder aroma\window1\option1\app
if it is a framework folder file, place it to aroma\window1\option1\framework folder

now use have successfully defined option1 for the window 1

repeat the same for option 2, and for 3,4.... If you have created them also

now you might have learnt how to define the corresponding options for mods/rom sub window 1 you created in aroma-config


2.2.) For sub window 2
now scroll and find this code-

Code:

if
    file_getprop("/tmp/aroma/window2.prop","selected.1") == "1"
     then
    ui_print("-> installing option 1...");
	package_extract_dir("aroma/window2/option1", "/system");
endif;

edit the ui_print("-> installing option 1..."); string as per your rom/mod option you defined in aroma-config

now place your option 1 customisation app to the folder aroma\window1\option2\app
if it is a framework folder file, place it to aroma\window1\option2\framework folder

now use have successfully defined option1 for the window 2

repeat the same for option 2, and for 3,4.... If you have created them also

now you might have learnt how to define the corresponding options for mods/rom sub window 2 you created in aroma-config

2.3.) for check box sub window

scroll and find this code-

Code:

if
	file_getprop("/tmp/aroma/checkbox1.prop","item.1.1") == "1"
		then
		ui_print("-> installing item 1.1 ");
	package_extract_dir("aroma/checkbox1/item-1.1", "/system");
endif;

edit the ui_print("-> installing item 1.1 "); string as per your rom/mod option you defined in aroma-config

now place your item 1.1 customisation app to the folder aroma\checkbox1\item-1.1\app
if it is a framework folder file, place it to aroma\checkbox1\item-1.1\framework folder

now use have successfully defined option1 for the check box window

repeat the same for item 1.2, 1.3 and for 2.1, 2.2 too (and also for additional items if you have created them)

now you might have learnt how to define the corresponding items for mods/rom checkbox window you created in aroma-config

Click to expand...

Click to collapse

3.) Important for rom developers!

Now if you have made this aroma installer for a rom, you have to make aymlinks and fix permissions for your rom binaries
for that open the updater script from any rom from your forum and find the word "symlink" and then copy all the lines to your updater script
if you are not able to find the code, try adding this code to your updater script-

Code:

ui_print("-> making symlinks...");
symlink("toolbox", "/system/bin/start");
symlink("toolbox", "/system/bin/lsmod");
symlink("toolbox", "/system/bin/r");
symlink("toolbox", "/system/bin/vmstat");
symlink("toolbox", "/system/bin/ifconfig");
symlink("toolbox", "/system/bin/ionice");
symlink("toolbox", "/system/bin/schedtop");
symlink("toolbox", "/system/bin/wipe");
symlink("toolbox", "/system/bin/reboot1");
symlink("toolbox", "/system/bin/rmdir");
symlink("toolbox", "/system/bin/route");
symlink("toolbox", "/system/bin/chown");
symlink("toolbox", "/system/bin/lsof");
symlink("toolbox", "/system/bin/getevent");
symlink("toolbox", "/system/bin/mkdir");
symlink("toolbox", "/system/bin/netstat");
symlink("toolbox", "/system/bin/renice");
symlink("toolbox", "/system/bin/uptime");
symlink("mksh", "/system/bin/sh");
symlink("toolbox", "/system/bin/smd");
symlink("toolbox", "/system/bin/sync");
symlink("toolbox", "/system/bin/mount");
symlink("toolbox", "/system/bin/printenv");
symlink("toolbox", "/system/bin/top");
symlink("toolbox", "/system/bin/log");
symlink("toolbox", "/system/bin/sendevent");
symlink("toolbox", "/system/bin/ps");
symlink("toolbox", "/system/bin/dmesg");
symlink("toolbox", "/system/bin/umount");
symlink("toolbox", "/system/bin/kill");
symlink("toolbox", "/system/bin/stop");
symlink("toolbox", "/system/bin/newfs_msdos");
symlink("toolbox", "/system/bin/iftop");
symlink("toolbox", "/system/bin/chmod");
symlink("toolbox", "/system/bin/rmmod");
symlink("toolbox", "/system/bin/setconsole");
symlink("toolbox", "/system/bin/mv");
symlink("toolbox", "/system/bin/rm");
symlink("toolbox", "/system/bin/id");
symlink("toolbox", "/system/bin/watchprops");
symlink("toolbox", "/system/bin/hd");
symlink("toolbox", "/system/bin/ctrlaltdel");
symlink("toolbox", "/system/bin/sleep");
symlink("toolbox", "/system/bin/ls");
symlink("toolbox", "/system/bin/cmp");
symlink("toolbox", "/system/bin/insmod");
symlink("toolbox", "/system/bin/nandread");
symlink("toolbox", "/system/bin/date");
symlink("toolbox", "/system/bin/dd");
symlink("toolbox", "/system/bin/getprop");
symlink("toolbox", "/system/bin/cat");
symlink("toolbox", "/system/bin/df");
symlink("toolbox", "/system/bin/touch");
symlink("toolbox", "/system/bin/ioctl");
symlink("toolbox", "/system/bin/setprop");
symlink("toolbox", "/system/bin/notify");
symlink("toolbox", "/system/bin/ln");

ui_print("-> fixing permissions...");
set_perm_recursive(0, 0, 0755, 0644, "/system");
set_perm_recursive(0, 2000, 0755, 0755, "/system/bin");
set_perm(0, 3003, 02750, "/system/bin/netcfg");
set_perm(0, 3004, 02755, "/system/bin/ping");
set_perm(0, 2000, 06750, "/system/bin/run-as");
set_perm_recursive(1002, 1002, 0755, 0440, "/system/etc/bluetooth");
set_perm(0, 0, 0755, "/system/etc/bluetooth");
set_perm(1000, 1000, 0640, "/system/etc/bluetooth/auto_pairing.conf");
set_perm(3002, 3002, 0444, "/system/etc/bluetooth/blacklist.conf");
set_perm(1002, 1002, 0440, "/system/etc/dbus.conf");
set_perm(1014, 2000, 0550, "/system/etc/dhcpcd/dhcpcd-run-hooks");
set_perm_recursive(1000, 1000, 0771, 0644, "/data/app");
set_perm_recursive(0 ,0 , 0755, 0755, "/system/etc/init.d");
set_perm(0, 0, 0755, "/system/etc/be_movie");
set_perm(0, 0, 0755, "/system/etc/be_photo");
set_perm(0, 0, 0755, "/system/etc/be_album");
set_perm(0, 2000, 0550, "/system/etc/init.goldfish.sh");
set_perm(0, 2000, 0755, "/system/bin/sysinit");
set_perm_recursive(0, 0, 0755, 0555, "/system/etc/ppp");
set_perm_recursive(0, 2000, 0755, 0755, "/system/xbin");
set_perm(0, 0, 04755, "/system/xbin/busybox");
set_perm(0, 0, 06755, "/system/xbin/su");

Click to expand...

Click to collapse

3.) Fixing permissions for both rom and mod users

now scroll and find this code-

Code:

ui_print("-> fixing permits :p");
package_extract_file("fix_permissions", "/tmp/fix_permissions");
set_perm(0, 0, 0777, "/tmp/fix_permissions");
run_program("/tmp/fix_permissions");
ui_print("-> finished installation...!");
ui_print("-> enjoy...");
ui_print("-> ...");
ui_print("-> done....");

endif;

run_program("/sbin/busybox", "umount", "/system");

show_progress(1, 0);

run_program("/tmp/fix_permissions"); is for fixing the permissions

the endif; present here is in the continuation from file_getprop("/tmp/aroma-data/menu.prop","selected") == "1"

the command run_program("/sbin/busybox", "umount", "/system"); is for unmounting system partition as the installation is complete now

Click to expand...

Click to collapse

now save the file updater script with ctrl+s or save button

Click to expand...

Click to collapse

NOW YOU HAVE SUCCESSFULLY CREATED THE UPDATER-SCRIPT FILE FOR INSTALLER


THIS WAS ALL ABOUT CREATING THE CORRESPONDING AROMA INSTALLER UPDATER-SCRIPT...
I HAVE COVERED ALL THE FREQUENTLY USED COMMANDS IN THE TUTORIAL
IF ANY DOUBTS/ERRORS POST THEM HERE

Click to expand...

Click to collapse