[Manila][12-Nov-2010] Co0kie's Home Tab v2.0.0 - Final Released

Intro:
While very cool, HTC Sense can be pretty limiting in the way of user customization. Co0kie’s Home Tab (CHT) is a modification for Sense 2.5 that completely replaces the existing home tab and brings lots of new features and customization options.

Please read all the instructions and user manual carefully before posting questions.

Thanks:
Thanks to MichelDiamond for way too many things to actually list, but here are some: chtstate that gives CHT access to system states and notifications, chttask that makes the tasks widget possible, the simply amazing CHTScheduler and his great all around support.
Thanks to johncmolyneux for his creating CHTEditor, and thanks to the guys currently helping me maintain CHTEditor: MichelDiamond, CLHatch, Tumys.
Thanks to Tumys for making the HVGA port of CHT.
Thanks to santod040 for his great graphics work and awesome support.
Thanks to JMHL for JMLToday - parts of which are used in CHT.
Thanks to Kisja & amarullz for their original work on the Manila Locker.
Thanks to CLHatch and dafunk2 for their graphics.
Thanks to CHT beta team (in alphabetical order): 12aon, CLHatch, caliban2, dafunk2, madindehead, Mariad, MaxCF, MichelDiamond, mike2nl, mkucuksari, mwalt2, myslee_ovi, santod040, Steve0007
Thanks to all the members of the CHT Development feedback group.
Thanks to everyone in the CHTS Beta Group.

About v2.0.0 Final:
CHT version v2.0.0 bring major changes. Most of the mod has been rewritten from the ground up, every line of code has been looked over and optimized for speed. Lots of new features have also been added along with an addon widget framework. Generally the mod is more configurable than ever.
You must uninstall any previous version of CHT and soft reset before installing this one.
If CHT was cooked into your custom ROM, install over the cooked version.

A new version of CHTEditor is also available: CHTEditor v2.0.0.0 final - you must use the final version of CHTEditor with CHT 2.0 final.
There is no backward compatiblity with versions 1.x.x, so you can't import old CHTE 1.x settings files.
But you can import saved files from 2.0 beta into 2.0 final. Similarly, future versions will be compatile going forward, so you will be able to import your 2.0.0 settings into any 2.x.x version.

Here are the highlights of what's new in v2.0.0. A full list of changes is very quite large and you should read the user manual to find out all that's possible.
These are just highlights, but I know you'll discover the details by reading the manual and of course while exploring the home tab itself
- left/right sliding pages confgurable from 1 to 7 pages (separately configurable for portrait, landscape and lockscreen)
- redesidned softkey area, bottom menu and tab slider (tap and hold the slider button, don't just tap and release)
- quick links can be configured in any row by column layout
- new links that are can be freely moved anywhere on the screen (free links - add from popup menu)
- free links have a slide-to-launch feature on the lockscreen
- more widgets: email, sms, RSS, weather, clocks (digital, flip and analog)
- widgets can be pinned into place and some can be freely resized
- addon widget framework: widgets can be made by anyone and installed as an addon cab

Quote:

Requirements and Compatibility:
Manila (Sense) 2.5 on a WVGA or VGA device is required. For HVGA an additional port cab needs to be installed - see this thread.
While the mod will run on any OS version, the CHT lockscreen that comes with the base cab requires Windows Mobile 6.5 or higher to work. For WM6.1 see the CHT lockscreen alternative addon cab below.
Starting with v1.8.5 .Net 3.5 is also required. You can download it here.

The mod is not compatible with other larger Manila mods (like MaxManila or MaxSense). Smaller home tab mods (like transparency) and mods that don't affect the home tab are fine.
CHT has built in wallpaper controls so bg4all mods or the hq wallpaper patch are no longer compatible (they are built in).

To check your Manila version: go to the settings tab in Sense, scroll down, select "About phone", and then "Software Information".
(If those options aren't available on your settings tab that means you have a Sense version that is older than 2.5.)
If you have any problems with this mod please report your full Manila version (e.g. 2.5.xxxxxxxx), the device and ROM you are using.

Samsung Omnia II compatibility: The Omnia II has a ported version of HTC Sense available. Because of the Sense port, CHT is only partially compatible with this device: edit mode will not work.

Quote:

Instructions
Download the cab and run it on your device.
If you have a problem installing it, try turning off Sense (All Settings -> Today), installing the cab and then turning Sense back on.

The base cab contains only the English languages. If your device uses a different language you will need to also install the CHT language pack found below.
If you are running WM6.1 and wish to use the lockscreen feature of CHT, you will need to install the WM6.1 lockscreen addon cab, also found below.

About exchange policies:
If you use exchange and have exchange policies applied to your device, this mod might not work for you. It depends on the type of policies which are enforced.
Some will not allow existing files to be replaced, which this mod requires. Others allow it and it will work.
You can try installing it - if it doesn't work it can be completely removed without a problem.
In case it doesn't work, your only option to get it working with your exchange policies is to flash a ROM with the mod cooked in.

Quote:

About the CHT lockscreen:
The CHT lock screen does not support any PIN code or password protected unlocking. Remove any unlock codes before turning on the CHT lockscreen or you will be permanently locked out of your device and you'll have to do a hard reset.
If you are using a gsensor app to automatically rotate the screen and you have it to always rotate, you should add the class "CHTLockscreen" to the exception list.
If you don't have the rotation app set rotate everything, but only a list of desired programs, then you don't have anything to worry about.
If you need to lock the CHT lockscreen externally, you can do it with this: "\Windows\CHT_Helper.exe -lock"

CHT lockscreen for WM6.1:
I've prepated an addon cab with an alternative CHT lockscreen for WM6.1 users.
Installing the addon cab will revert the CHT lockscreen to the older lock system used in v1.7.x. The downside of this is that the old lock system carries with it some flaws:
on some devices it might not lock all hardware keys, has a slower lock response on wakeup, on longer calls it might relock before the call is over, gsensor apps that rotate manila will also rotate it, doesn't integrate with the WM6.5 lock system (softkey in start menu, button assigned lock).
Of course, for those who really want to use the CHT lockscreen and don't mind those shortcomings, the ultimate upside is that is does work on WM6.1.

Quote:

About wallpapers:
-All wallpaper controls are now built into CHT, so there is no need to install any bg4all or hq wall patch. In fact don't install them because they are not compatible.
-3 wallpaper modes are available - take a look at the bottom of this post for a comparison: About v1.8.5

Notes on animated wallpapers:
-I had to remove the animated wallpapers - not the weather wallpapers, but the 3 animated wallpapers with circles and such. The weather wallpaper animations are fully intact.
I know, I know, some of you will miss them, but I'm guessing not that many. It was just one of those things that would be too much work for a minor feature.

Quote:

About Performance:
For HD2 users: It was made for the HD2 and it should run nice and slick on it. But I do recommend installing Chainfire's HD2/Leo 3D Driver Patch - it's great.
For non-HD2 users: Keep in mind that this was primarily made for the HD2 and it will be slower on other devices. To improve performance you have options to: reduce the animation level and reduce the number of quick links pages.General tip for more speed (both for HD2 and non-HD2): Disable full screen Weather animations: Tap to add a new Quick Link and add the "Weather Toggle".
It will then appear as a shortcut in your quick links, and can be used to quickly enable/disable weather animations.

Quote:

About ROM cooking:
Don't cook in the file "ManilaFull.xml". Originally it's a manila cache file that's generated on start up (based on the xml files in \windows\manilaxml\).
This file should never be cooked in because it will prevent changes to manila pages and menus.
The "ManilaFull.xml" in the cab is an empty file. It's only there to make manila regenerate it after install, because I've made changes to the home menu.
So make sure not to cook in that file in any form.

Don't cook in the CHT lockscreen as on by default. If you do that, users won't be able to turn it off!

If you're cooking a WM6.5.x ROM, you should set the reg value of CHTI.WinMo6.5.x to 1. The cab's setup.dll would do that normally.
If you're cooking in a specific configuration all the CHT.* values need to be cooked in an as well as the HKLM\Software\HTC\Manila\CHT values that hold layout information.
Make sure you also cook in CHTI.State.Timeout with the value 45 (decimal) and CHTI.AddonWidgets.Count with 20 (decimal). The rest of the CHTI.* values don't need to be cooked in.

Known issues with fixes
For all fixes: Extract file(s) from zip, copy to \windows, overwrite existing and restart sense.

- The email notification link will not work if a program is assignet to it (quick/free link, bar, lock screen - all email links affected)
- The "Exclude Outlook email count" option causing messed up screen
-> for both issues, here is the fix download.

Quote:

Known issues without solutions
These issues are known but have no solution at this time.

- Sense might restart if the tasks widget is active but there are no tasks.
- Pinned widgets sometimes don't fade out under extended lists.
- Edit mode might not respond sometimes.
- Sms and email widgets have animated transition even when the "no animations" option is set.
- Sense crashes when going directly from purchased music to home.

Quote:

Frequently asked questionsQ: I need transparent components.
A: Use this transparency mod.Q: Will you mod the people tab?
A: No.Q: I'm missing full screen weather animations?
A: The sun rays animation for sunny was disable, because it can't be moved to follow the clock. To re-enable it, use CHTEditor and turn on the option under misc. settings.Q: I'm using the retractable slider. Why is the weather animation cut off at the bottom?
A: I wasn't able to extend the weather animation. This is something your just going to have to live with.Q: Why is the sun rays animation over the sun instead of under it?
A: Unfortunately this can't be helped and it's part of the reason why it's disabled by default.
The original clock was made of 4 separate cameras: background, left tabs, right tabs, weather. I consolidated this to a single camera which:
1) Allows for easy moving of the clock.
2) Gives a performance boost, because only 1 camera needs to animated and not 4.
A side-effect is that the sun rays now can't be slotted in between the sun and clock background. Only under everything (where it isn't visible at all) or over everything as it is now. It's a trade-off, but I thought the pros outweighed the con.Q: How can I link directly to WM messaging and email apps?
A: Take a look at this post (thanks to Dishe).Q: Why can't I get Sense in landscape? All I get is black screen.
A: If you have Sense version 2.5.1920 or 2.5.1921, those versions do not support landscape mode.Q: Why can't I skin my taskbar and softkeybar?
A: This feature is only available on WM6.5.

Quote:

TroubleshootingQ: I'm having black screen or freezing problems with the lockscreen.
A: Unfortunately, the only advice I can give you if to disable the CHT lockscreen and go back to the default system lockscreen.Q: HTC shortcuts have white icons
A: This can happen on some older manila versions. To resolve this, go to reg key HKCU\Software\HTC\Manila\ and set IsShortcutEnabled to 0.
Next, with file explorer, go to \windows\start menu\programs and delete the white HTC icons. Then, download this zip and extract the shortcuts to \windows\start menu\programs.Q: Menu text has weird "IDS_" text.
A: You didn't install the CHT language pack or you installed some mod that changed the language files (like "no calendar text" mod). Reinstall the CHT language pack to get normal text back.Q: My quick links (or any other home elements) are disappearing.
A: The appointment and task lists are made to hide anything that's behind them (for easy reading). If you have one of them too close to another home item it will disappear. Move them a bit further apart and everything will be OK.Q: The bluetooth toggle doesn't work.
A: Get a bluetooth toggle that works for your device (you can easily find one on the forum), install it to your device and then link it to CHT by setting the Bluetooth application in CHTEditor.Q: I can't turn off the CHT lockscreen.
A: Go to \windows and delete lockscreen.dll.

About Addon widgets and links:
Addon widgets are new to CHT v2.0.0 - made possible by the widget framework.
These are true addons: Widgets that fully integrate with CHT, but at the same time can be added and removed without affecting other widgets or the base CHT installation.
They are compatible with all v2.x.x versions of CHT.
Version v2.0.0 supports a maximum of 20 addon widgets (this number does not include the built in widget that come with the CHT install).

As well as widget, link can also be added as addons.
Links like toggle switches, notifications, status indicators, tab links, etc.
Version v2.0.0 supports a maximum of 20 addon link cabs (a single addon links cab may have multiple links inside).

RSS widget - Probably the most requested widget of all. It's the RSS Reader that comes with Sense 2016+, but it will work on all ROMs with Sense 2.5 including the HD2 stock ROMs. The only requirement is that you have the RSSHub application on your device.
This is the exact same RSS reader the comes with the stock Sense wich means it also has it's limitations and bugs - this widget will be updated as HTC updates it's RSS Reader in stock Sense.
The future might also bring some better Sense RSS integration. For now this is no more and no less then what you get with Sense 2016+.

Weather widget - Standalone weather widget. (That is, in addition to the one in the main clock.) Features 2 layouts, both resizable. The second layout is pure eye candy when enlarged.

Digital clock - A real digital clock that is. No flipping and no space between the upper and lower part of the numbers.
The clock is extremely basic, but it is mainly made to be a base for skinners to make their own digital clocks since I know the flip clock doesn't make a good skinning base (because of the space between the upper and lower part).
For more info on modifying this widget see the developers guide (coming soon).

Flip clock - Not much to say here, just the same flip clock without weather as one of the main clock layouts. I thought it would be a good idea to have one more example widget for devs.

For chefs - How to cook in addons:
The process is a little different for widgets and links.

Addon widgets:
In the addon widget cab, the setup.dll does the most import part of the install. Doing it manually is a bit tricky. The easiest thing you could do would be add the cabs to an automated post flash customization.
But if you still want to cook it in this is what needs to be done:

1) In HKCU\Software\HTC\Manila\ create a new string value called: "CHTI.AddonWidgets.Slot0". For its value set the install dir of the addon cab you wish to cook in - they are usually "\CHTAddon\%widget_name%" (the install dir in the addon cab isn't actually used as an install destination, but as an unique widget id).
2) Next you'll need manilaHash.exe - you can find it on the forum.
3) Put "\Windows\HTC\Home\CHTWidgetSlot0.mode9" into manilaHash.exe and get the hashed ********_manila files name. Then rename CHTmode9_manila to that name.
4) Put "\Windows\HTC\Home\Scripts\Home\CHTWidgetSlot0.lua c" (it's ".luac" without a space) into manilahash, get the manila name and rename CHTlua_manila to that.

Repeat that for any additional widgets you want to cook in, just put in Slot1, Slot2, Slot3, etc.

Important note: manilahash.exe does not append leading zeros to hashed file names. For example if the name needs to be "008fa12b_manila" - manilahash.exe will output just "8fa12b_manila" without the leading zeros.
The hash code always needs to have 8 digits, so if manilahash.exe gives you something with less than 8, add the missing zeros manually. Otherwise you'll the widget will not be installed properly.

Addon links:
Very similar to the above, but a little simpler.

1) In HKCU\Software\HTC\Manila\ create a new string value called: "CHTI.AddonLinks.Slot0". For its value set the install dir of the addon cab you wish to cook in - they are usually "\CHTAddon\%links_name%" (the install dir in the addon cab isn't actually used as an install destination, but as an unique id).
2) Next you'll need manilaHash.exe - you can find it on the forum.
3) Put "\Windows\HTC\Home\Scripts\Home\CHTAddonLinkSlot0. luac" (it's ".luac" without a space) into manilahash, get the manila name and rename CHTlua_manila to that.

Repeat that for any additional link cabs you want to cook in, just put in Slot1, Slot2, Slot3, etc.

Localization:
The main cab only includes English text. To get other languages download the CHT language pack.
Not all languages have been translated. If you find that CHT is not fully translated to your language and you would like to translate, contact me.

Addon widget and links kitchens
Addon kitchens for making widgets and links are available in the attachment. A dev guide is included in the zip, along with code examples.
Making addon widgets and links is slightly different - that's why two different kitchens are available - read the included guide for details.

Quote:

Lua source code
The source code is freely available. You may modify it as you wish, but I do have a request:
If you're going to post a CHT modification publicly, post only the modified files and not the whole thing, so that the installation procedure is:
1) Install the main CHT cab first.
2) Install your modification.

Alternatively, if you want to use any part of this source code in your own independent manila project, you are free to do so, but please do post a mention that you're using this code and what parts.
That's the only thing I ask. I hope everyone will honour it. Thanks, here's the source, have fun with it.

XDA Developers was founded by developers, for developers. It is now a valuable resource for people who want to make the most of their mobile devices, from customizing the look and feel to adding new functionality.Are you a developer? | Terms of Service