Related
Here's a small replacement for the "Message" entry in the "New" menu. (There's no native "New" menu on WM5, but there are tools like here)
It's mainly made because the original entry doesn't work on my P525, but it might be useful for others, too. It should also work fine with WM2003(SE), though I haven't tested it.
Features:
- New entry "Message+" in "New" menu
- The original "Message" entry is deactivated, but can be activated in the settings (WM2003, rider in menu entries) or registry (HKLM\Software\Microsoft\Shell\Extensions\NewMenu\{1D210285-ABE7-11d2-8442-0000F87A584A}\Enabled).
- Can be invoked directly in the start menu or tools like PocketPlus, iLauncher, ... (\Windows\MortNewMsg.exe, if the link isn't created proberly)
- Choosable account/service (SMS is default if available otherwise the first entry)
- Ability to filter by groups, recipent types (cell phones, all phone number, eMail addresses) and recipent name (search over "Show as" field)
- Multiple recipents possible (unselect previous selection by tapping again if you tapped the wrong one!)
- Search field has focus after start; (de)selection in listbox is possible with fire button - so it's easy to use with keyboards (though it's better to switch to "abc" mode on P525)
- Activates message area in the system's dialog, so no tab or tapping is required
However, there might be some troubles (performance/memory usage) if there are very many contacts.
The screenshot's from the German version, but the attachment's in English.
There'll be no other translations, because that'd be a bit complicated in this case.
Edit: Patched missing "Cancel" translation.
Hey Mort!
Is there any chance to get the german version as long as your page is down?
You can get it here.
Hmm, my search didnt find it - thanks a lot!
Oops, created the link in Startup instead of Programs. Please move/delete it manually, or download again and reinstall it...
Great app!
Works on my Touch Pro WM6.5... a great tool for sending sms or email using categories or groups via pocket outlook..
suggestion: wish to have a "select all" button...
In my programs tab, Ive put 6 rows worth of programs. The 7th row shows up with the positive signs to add programs. When I attempt to add a program on the 7th row, the icon and the program aren't added. Is there a fix to this or am I stuck with the empty 7th row? I've also searched these forums and elsewhere for this same problem but no luck. Thanks in advance.
This is actually an easy one to fix, and does not even require a soft reset.
TF3D can have a maximum of 18 icons (2 screens of 9 in a 3x3 matrix) in the Programs tab. Sometimes TF3D allows the creation of additional squares; however, these additional squares are essentially useless, since you cannot assign a program to them. What's worse, they cannot be deleted from the interface, leading to a Gremlins-like proliferation of empty squares on the Programs tab.
They can be removed through the registry, however, by deleting the additional entries and (most importantly) leaving the proper entries alone.
First, open your registry editor (I use PHM RegEdit, there are plenty of others). As always, BACKUP YOUR REGISTRY before making any changes!
Navigate to "HKEY_LOCAL_MACHINE\Software\HTC\Manila\ProgramLauncher\"
There are 18 proper keys, listed from 0 through 17. Any keys that do not belong will have numbers above 17. Delete all keys other than those numbered 0 through 17. Exit the registry editor. If you are on the Programs tab, navigate away from it, then back, and you will see that the rogue squares are gone. That's it.
cguarino - thanks so much for that post! it was very helpful and much appreciated!
As has been pointed out in all of my articles dedicated to the excellent, lightweight browser Opera Mini, in addition to the lack of italic characters, probably the biggest problem with it has always been the lack of support for copying text from a Web page.
Now, this is fixed. While the way I've enabled copying is certainly inferior to the excellent copy capabilities of Teashark (see THIS), it's certainly working and, at last, enables anyone to copy anything out of any Web page, regardless of the platform you use. Yeah, it IS revolutionary.
How it works? Pretty easy: I've created a Web application that you need to pass the address (the URL) of the page you'd like to copy contents from. After entering (copying) the address, it presents you the contents of the page in a text area, which is already copy-enabled; that is, you can copy anything from them to your device's clipboard.
As mobile devices, in general, are only able to handle small(er) chunks of text in a text area, the dialog you're presented uses 2000-char-long chunks of text. You can easily switch between the block you're reading by just clicking the appropriate block link (0, 1, 2 etc.) There's also a way to force the application to display the entire page at once; note that, with pages over 10-15 kilochars, this may result in Opera Mini's slowing to crawl. That is, use it if you're absolutely sure your particular model / operating system lets for putting larger texts in an editable text area.
Now, let's see how this all works in practice.
1. add the Web page http://menneisyys.s156.eatj.com to your favorites in Opera Mini (the easiest way of doing this is reading this article in Opera Mini and clicking the link)
2. when you're on a(nother) page you'd like to copy something from, copy the address of the page you'd like to copy text from to the clipboard of your device. This needs to be done in the following way:
a. on Windows Mobile Pocket PC's (but not touchscreen-less Smartphones, where you need an additional app for copying):
a-1: press #1 (if your phone has a hardware dialpad) or go to Menu (left softkey) / Enter Address
a-2: If you haven’t disabled the new auto-completion address input field (the Auto-complete address input checkbox in Settings), press Down and go to Insert symbol… by pressing Up; and select it; you’ll be taken to the address input field of your Java environment. (You’re taken straight here if you disable the new, Opera Mini-specific address input field.)
a-3: select Menu (right softkey) / Current Address
a-4: As you can see, the address of the current page is displayed. Just copy it: highlight it entirely (under Jbed, to do this, click Shift, Ctrl and, finally, the left arrow on the on-screen keyboard) and press Ctrl-C on the virtual keyboard.
b. on Blackberry phones:
b-1: press #1 (if your phone has a hardware dialpad) or go to Menu / Enter Address
b-2: If you haven’t disabled the new auto-completion address input field (the Auto-complete address input checkbox in Settings), roll the trackball down, and, then, up, until you get to Insert symbol…. Now, you'll be taken to the address input field of your Java environment. (You’re taken straight here if you disable the new, Opera Mini-specific address input field.)
b-3: press the Shift button and roll the trackball down until the entire (current) address is selected
b-4: press Menu and select the (default) Copy.
b-5: to exit this dialog, press Back twice.
3. now that you've copied the address of the current page, switch to the previously (in bullet 1) stored page. When it loads, copy the URL of the previous page (the one you'd like to copy text from) to the "Enter the URL to convert" textfield. To do this, start editing the field and,
- on Blackberries, press the hardware Menu button and go down to Paste.
- on Windows Mobile devices, bring up the virtual keyboard and click Ctl, and, then, V
- on Symbian devices, long-press the Pen button until "Paste" is shown over the right softkey. Not releasing the Pen button, press the right softkey.
After some conversion, a new page is displayed, with a huge text area displaying the textual contents of the Web page. If the contents of the page is longer than 2000 characters, only the first 2000 is displayed (not to overburden the phone) and you can select the later ones by clicking 1, 2, ... n at the top of the page. You can also make the system display the entire content entirely, without cutting it in chunks, by clicking the "Click here to see the entire page!" link. Again, use this feature with caution - again, your phone may slow to a crawl, if the midlet manager's text area component is able to edit so huge blocks of text at all).
Finally, if you absolutely don't see anything and/or you'd like to see the entire markup of the page, click "Click this to switch to tag-enabled mode if you don't see anything".
After you've stepped into editing the text area displaying the (given chunk of) text, just look for the expression / URL etc. to copy to the clipboard. Once you've found it, highlight it and copy to the clipboard. This operation is supported on all the major smartphone operating systems and done in the same way as copying the address of the current page to the clipboard.
Hosting
Currently, the converter is hosted on a free JSP server that needs to be manually restarted every six hour (to force people to purchase a real Web package). That is, when you do check it out, it might not work at all. I will surely move it to another page / service provider if I don't find anyone else to voluntarily host it, depending on the price / conditions. (Currently, I don't really need a JSP/PHP-capable Webpage and, consequently, I've only subscribed to a static one for my database/picture/file back-end at http://www.winmobiletech.com/ ; this is why I can't currently host it myself.)
If you have the bandwidth and you'd like to help Opera Mini users, feel free to host the files yourself. If you have a JSP engine (Tomcat et al.), you'll find the web application (WAR) file HERE. If you only have a PHP or ASP engine, and don't want to struggle with porting the Java app into PHP or ASP, let me know and I convert it instead.
Source
The source of my converter is really-really small. The two, related files HERE and HERE, should you want to know how it works. The first is the main "landing" page you need to paste the URL to paste text from (it's a static HTML page as there is no need for any dynamic content in it); the second is the actual JSP page doing the work.
I've updated my eatj.com account: subscribed to a one-month plan (for $10). Now, the service should start working in 12 hours. There will be no pauses from now on. Feel free to use the service - and don't forget to provide me feedback on what you would welcome.
Also free to provide me with commonly visited pages (CNN etc.) that you think I could provide a more sophisticated engine - for example, only displaying article text and not displaying other stuff.
All in all, feel free to (publicly! NOT IN PRIVATE MESSAGES, they will all be ignored!) ask me to provide new functionality and/or site-based custom processing.
UPDATE:
In the meantime, based on public feedback (see selurus' and yitzy's requests on Wednesday, 3. June 2009, 18:13:35 and 23:30:15, respectively, at http://my.opera.com/community/forums/topic.dml?id=277592&t=1244154046 ), I've added the following two front-end pages:
http://menneisyys.s156.eatj.com/i2.html : if you paste the source page URL to this page, you'll be presented by all blocks in order. This way, you'll see (based on the text already visible in the beginning of each textarea) right away in which block you need to look. selurus reported it caused no slowdown on his handset; your mileage, on other handset models / operating systems may vary. That is, if you don't need this kind of breakup and/or it causes too much slowdown and you're sure you can find a given part of the text faster using the traditional links, use the first version instead. (Feedback is welcome!)
http://menneisyys.s156.eatj.com/i3.html : this displays UTF-8 pages properly (most oriental languages like Chinese / Japanese; Hebrew etc.). I've tested it with http://www.haaretz.co.il/hasite/spages/1090414.html (Hebrew) and http://fi.wikipedia.org/wiki/Romanit (Finnish; check out the letter "ž" in word gudžarati after "urdu, hindi, sanskrit ja"). NOTE: it's for UTF-8 source pages ONLY. Do not try to decode e.g. East-European languages using 8859-X with it. I plan to release a version compatible with these traditional, 8-bit encodings as well when I have the time so that charset setting becomes automatic.
As you can see, these front-ends 1. offer an alternative view (displaying the content of the entire page in multiple text areas, keeping in mind the text area editing limits) and 2. allow for copying from UTF-8-encoded pages.
------------------------------------------
Also in the Opera Mini Community forum, there's a nice tip posted by Yeswap: use "bookmarklets" to speed up invoking the converter. To do this, do the following:
1. from Opera Mini, go to http://o.yeswap.com/
2. click Tools or scroll down to Tools
3. click Copy Page Text
4. (seemingly) the same page reloads; NOW bookmark it as a standard bookmark (Menu / Tools / Add Bookmark or #7 if you have hardware buttons). However, don't save the bookmark yet - just open it for editing!
5. remove "http://o.yeswap.com/?" from the URL so that it becomes javascript:location.href='http://menneisyys.s156.eatj.com/om.jsp?q='+encodeURIComponent(location.href)+'&blocknr=0'
6. now, you can already save the edited bookmark.
7. you can quickly invoke the new bookmark: when you're on a Web page you'd like to copy to the contents to an editable text area (so that you can, later, copy text from), just go to your bookmarks (Menu / Bookmarks or, if you have hardware keys, #2) and click the just-added "Copy Page Text" entry. You'll be immediately taken to the target page - that is, no manual URL pasting is necessary any more! As you can see, this has really made all this very simple.
Note that you can safely change "om.jsp" to either "om2.jsp" or "om3.jsp" in the URL you bookmark (so that it becomes javascript:location.href='http://menneisyys.s156.eatj.com/om2.jsp?q='+encodeURIComponent(location.href)+'&blocknr=0' and javascript:location.href='http://menneisyys.s156.eatj.com/om3.jsp?q='+encodeURIComponent(location.href)+'&blocknr=0', respectively), should you want to have a direct link to the two new, alternative pages (display all the pages and use UTF-8) I've just added.
Also note that, strictly, you don't have to go to http://o.yeswap.com/ to add the bookmarklets. You can do the same by adding a new bookmark with the above contents (e.g., javascript:location.href='http://menneisyys.s156.eatj.com/om2.jsp?q='+encodeURIComponent(location.href)+'&blocknr=0' ). Also, you can name your bookmark anything - not strictly Copy Page Text.
I've implemented PDF support.
After a lengthy and careful evaluation of the current Java libraries used for PDF parsing, I've decided to choose Adobe's own one.
To use it,
1. navigate to http://menneisyys.s156.eatj.com/pdf.html and paste the URL to the PDF there.
2. if someone else has some seconds ago checked translated the document, you'll be presented its textual contents, in the usual multiple text areas (see http://menneisyys.s156.eatj.com/i2.html ) right away.
3. if it's the first time in the last few seconds that the document has been converted, you'll be dispatched to Adobe's page. After some 10-20-30 seconds of waiting, the conversion is finished and you'll be shown the textual version of the page.
4. NOW, just press Back until you get back to http://menneisyys.s156.eatj.com/pdf.html . Press the Submit button again. Now that it was just some seconds ago that you made Adobe convert your document, you'll be presented it, already in the text areas.
It's a bit convoluted but "hiding" the Adobe interface and make it even easier would have taken me too much time / effort.
Hope you'll like it
Thank you for all you useful information!
MiXplorer: Q&A and FAQ (User Manual)
Table Of Contents:
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917
Notes:
If you are just starting with MiXplorer then a general review of this FAQ might be helpful but if you seek information about a particular feature or workaround you can see if there is a "MiX Nugget" for it. MiX Nuggets are individual freestanding FAQ posts which describe a MiXplorer feature in enough detail for basic use without having to sift through whole FAQ. v. MiX NUGGETS (Freestanding Topical Posts).
Issues and workarounds of the moment:
As the android OS and individual apps evolve there are often clusters of issues for which there are common sets of symptoms and common workarounds. This section is to share a link to whatever is the latest such batch of such issues/workarounds.
MiX Nugget - Document provider Mash-Up: (accessing SD card and or /android/data and other directories on newer Android versions. https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-87626419.
--------------------------------------
i) INTRODUCTION
As mentioned in an introduction from the main thread: "MiXplorer (Mix of Explorers) is a fast, smooth, beautiful, reliable and fully-featured file manager with a simple and intuitive user interface." created by XDA member and Recognized Developer @HootanParsa
I (IronTechmonkey) am a MiXplorer user and who volunteered (was volunteered) to create the FAQ but I am not the/a developer. This FAQ attempts to describe configuration options, file & folder operations, UI options, and MiX utilities, as well as to share workarounds for known issues or usage cases. Please feel free to provide, suggestions, corrections, or additions which could be linked to or added to the OPs. Thanks to all for your input already as much of this comes from your questions and answers in the main MiXplorer thread. Thanks to @HootanParsa for such a good file management utility.
Please continue to direct bug reporting and tech discussion to the primary MiXplorer thread: http://forum.xda-developers.com/showthread.php?t=1523691.
Note: the developer is sometimes away for periods of time, days or weeks or even months, but is good about following up upon return.
SOME MIXPLORER HISTORY (MiXtory?)
This post by HootanParsa describes a how MiXplorer got started and some key events during its relationship with Google Play Store. https://forum.xda-developers.com/t/...y-featured-file-manager.1523691/post-77894840
Here is another note from HootanParsa regarding the history of MiXplorer on Playstore https://forum.xda-developers.com/showthread.php?t=1523691&p=73870110.
MiXplorer is closed source, and because the developer rarely if ever engages in discussions about closed vs. open source this is not discussed at length in the main MiX thread. This is not by any rule but rather by respect for the developer's decision. That being said, past discussions about closed vs. open source have been well informed and informative. Such discussions really do relate to software development, if not to the bugs to be fixed at any given moment, so please feel free to have such discussions here if/when they become too much for the main thread.
--------------------------------------
GETTING MIXPLORER
There are several ways to get MiXplorer and keep it updated and there are some methods which should not be used. In particular do not install MiXplorer via Magisk module or other system modification. This is known to cause significant problems and is not supported. Here are the ways to get MiXplorer:
1) XDA Version in Main Thread: https://forum.xda-developers.com/showthread.php?t=1523691:
This is the place for p the latest stable version, which is usually available in post 2. This is also where you can get the latest beta version. Note: it is always a good idea to check the main thread's OPs to see what version # is flagged as stable, as well as check the change-log. Add-ons can be obtained through the app which links to website.
2) Playstore (MiXplorer Silver). As announced by HootanParsa here https://forum.xda-developers.com/showpost.php?p=78465999&postcount=27232; "MiX Silver a bundle of MiX with Archive and SMB2 addons and the latest language resources is uploaded in Play store as a paid app to support the development of MiXplorer. If you liked it and installed it and found a problem, please let me know. Thank you very much. "
Note: The Playstore-Silver and XDA-Stable versions of MiXplorer are essentially the same (sometimes with small variation) but the Playstore-Silver version includes some add-ons (describe below and at Playstore page) which would have to be installed separately and manually in the XDA version; otherwise the 2 version are functionally the same.
3) APK Mirror: This is an unsupported repository of more versions of MiX than most people would need, but some of these builds may be helpful in some situations and it provides access outside of Playstore.
MiX at APK Mirror: https://www.apkmirror.com/apk/hootan-parsa/mixplorer-hootanparsa/
Old link (just in case) https://www.apkmirror.com/uploads/?q=pishrodevs.
If this link does not work then search Google for [MiXplorer APK Mirror]
As to upgrade paths: The Play Store gives a one-shot installation and upgrade path for the app and its included add-ons. The XDA stable version allows users to decide specifically which add-ons are installed but offers a similarly simple upgrade path from with the app.
4) [POSSIBLE INACTIVE] APKMirror RSS Feeds: https://www.apkmirror.com/apk/pishrodevs/mixplorer-hootanparsa/feed/
[inactive?]http://www.apkmirror.com/apk/hootanparsa/feed/ The ApkMirror RSS feeds are considered by many to be a similarly "stable" and up to date as the main MiXplorer thread and XDA Labs but it offers less information about the development progression of recent updates.
Add-ons: MiXplorer Add-ons can be installed from within the app like this:
Settings > Addons > and click add button > follow links to browse and download appropriate add-ons.
--------------------------------------
INSTALLATION:
After installing MiXplorer there are some things that must be done in order to give MiXplorer proper access to storage locations and root or SU access. It is a good idea to get these things out of the way as part of the installation (or update) of MiXplorer rather than on-the-fly as you need to perform file management tasks. Here is a brief walk-through of how to give MiXplorer it's requisite permissions. This is written for Android Nougat which has more of these prerequisites than earlier Android versions so please note that things may differ across different ROMs and SU/root methods:
Do this stuff first, immediately after installing MiXplorer but before configuring it and importing skins and or settings
- At first run of MiXplorer at prompt "Allow MiXplorer to access photos, media, and files on your device?" Select to Allow.
- Make sure root is enabled in MiX setting > Navigate to Root "/" to force first time SU permissions request > Select " allow" and "remember".
- Navigate to external SD and create a new folder. There should a prompt "Attention Please select Ext SD... to gain permissions". Note: In some situations you may not have to create a folder to invoke this prompt.
BUG REPORTING
- Please report bugs in the primary MiXplorer thread here: http://forum.xda-developers.com/showthread.php?t=1523691. Bug reports should include. details about your device (Android version, ROM version, Root status, SU method, MiXplorer version) as well as a step by step description of how to reproduce the issue and a log taken while the issue was reproduced. There are more suggestions for testing, logging and reporting bugs in this post: https://forum.xda-developers.com/showpost.php?p=65157367&postcount=7
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
1) Primary UI Components
2) Navigation
3) Drawer (Bookmarks/History)
4) Tabs
5) Views (file folder list)
6) "Home" page - described in MiX Nugget - Home Page - https://forum.xda-developers.com/showpost.php?p=82781209&postcount=1168
--------------------------------------
1) Primary UI Components
The names of various UI objects may be referenced throughout documentation (and are helpful to know when configuring theme). Here are the names of a few primary UI components along with the specific name for their background colors in the theme configuration. This is just as a reference point for the documentation. For more about skins and themes see that post.
Status Bar: TINT_STATUS_BAR
Main Bar: BG_BAR_MAIN
Tab Bar: BG_BAR_TAB
Tab Indicator: TINT_TAB_INDICATOR
Selected Tab: TINT_TAB_INDICATOR_SELECTED
Page: BG_PAGE
Tools bar: BG_BAR_TOOLS
Navigation Bar: TINT_NAVIGATION_BAR
I) Action Bar: BG_BAR_ACTION The Action Bar appears in place of the Main Bar when one or more items is selected.
J) Drawer: The Drawer can be opened by tapping Hamburger in Main Bar or swiping the Page from left edge toward right and takes it’s background color from BG_BAR_MAIN.
--------------------------------------
2) Navigation
To navigate through folders; Tap the name of he folder you want to enter, or select a bookmark or history item. Note: Tapping the icon to the left will select and highlight the folder.
To go to the previously accessed folder:; Press back button.
To go anywhere in the path you are browsing: Tap the Location button in Main bar then tapping the part of the folder tree you want to go to.
To go to a manually entered location: Long press the Address in the Main bar then tap “Enter the path”. Note the other things that can be done from this menu: Copy path, Copy name, Enter the path, Create shortcut, Clear thumbnails cache, Properties. Note: The items in lists like this may change as MiXplorer evolves.
To search for items: Tap the search icon, then you can start typing what you want to find in current folder.
To filter the search: tap the leaning-hamburger, then select an option.
To search recursively (into sub-folders): Tap the right-angle arrow icon, then choose options and search criteria. See this FAQ Nugget for recursive and advanced search options: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82781351
Regex: Regex is a fairly powerful method of using expressions (wild-cards and variables) to do searches, and can also be used for renaming files.
Harvesting information in this post https://forum.xda-developers.com/showpost.php?p=71218953&postcount=118
To change the View level of details: Tap the View button, then select an option.
To Add a file or folder: Tap the Add button
To refresh the View: Tap the Refresh button (or tap the Tab title, or tap the Location button in Main bar then tap the location).
To sort the view: Tap the Sort button (A-Z icon)
To show or hide an item flagged as hidden: With no items selected, tap overflow menu then tap "Show Hidden" or "Don't show hidden".
To exit MiXplorer: Long-press Back button.
------------------------------------
3) Bookmarks/History (Drawer)
To open the Drawer for Bookmarks and History: Tap hamburger in Main Bar, or swipe from the left edge toward right.
To create a Bookmark to a location on the device: Navigate to the location, then long press the Location in the Main (top) Bar, then tap "Add to...", then tap "Bookmarks"; or Navigate to one level above the folder, then long press the folder in the file/folder list, then tap overflow menu, then tap "Add to...", then tap "Bookmarks". :
To create a Bookmark to a network share, server or cloud: Open Drawer, then tap hamburger, then tap Add storage, then select and configure the type of storage. There is a "Custom" option at the bottom of the list. Here are examples of 2 common types of network bookmarks:
1) To access shared folder (SMB share) on PC or other computer on same local network.:
- Have a shared folder on a computer with file sharing and network discovery enabled.
- Open MiXplorer on device connected to same network.
- Bookmarks Drawer
- Hamburger button
- Add Storage
- Custom
- Search local
- Enter credentials
- If the search finds no shares there may be an issue with the sharing on the host or network between devices but you could try manual configuration.
2) To access an FTP Server on another device:.
- Have an FTP server to connect to.
- Bookmarks Drawer
- Hamburger button
- Add Storage
- Custom
- Enter server details (ftp://<ipaddress>:<port>, user-name password)
Notes about network and cloud bookmarks:
- When you create a connection to local network share or cloud via <Bookmark Drawer - hamburger - Add storage>, a Bookmark will automatically be created.
- Depending on the type of network location, when you browse the network location you may or may not be able to create bookmarks to locations within that tree as described above. This should work for SMB shares on a computer or folders on another Android device accessed via MiXplorer FTP and might work for others.
- When you save an off-device bookmark, some context sensitive additional configuration variables may or may not be added to the "Advance settings" field, which in some cases can be edited manually later.
To Delete or modify a bookmark: Open the Drawer, then swipe the bookmark name to the right, then select appropriate action.
To rearrange bookmarks: Open the Drawer, then tap and drag a bookmark by it’s icon up or down.
Sections are labels which can be added to the bookmark list to organize bookmarks into groups. Tapping a bookmark section will expand or collapse the bookmarks between that section and the next section below it. Sections can be edited and moved in the same manner as bookmarks. Note: Moving a section will not bring the bookmarks under it to the new location - just the section itself. Arrangements of the groups must be done manually.
To create a custom category (similar to custom bookmark for a search) in the bookmark list: Open 'All files' - Tap on the search button - Recursively - Enter file-name extensions eg; *.zip|*.rar|*.txt - Press GO - Long press the address bar - Add to bookmarks.
To reset the search-all-by=type folders (archive, apk,image, video, etc) if they are gray and don't work: If you are updating from an older version of MiXplorer you may have to click on bookmark menu and choose "reset default" (which should preserve your own bookmarks) to recreate the new versions of the search bookmarks, then you can delete the gray ones.
Bookmark functions via the Bookmarks Menu: Add storage Reset defaults; Remove all, Export. Note: To import bookmarks, open the exported .micfg file with MiXplorer and select import.
To switch between Bookmarks and History : Open Drawer then tap the Bookmarks or History label in top Bar.
To clear history: Open Drawer to History, then tap mini-hamburger.
--------------------------------------
4) Tabs
1st Tab is left-most. Last Tab is right-most. New tabs will open to the right of the active tab.
General Tab functions can be accessed via the tab menu and are context sensitive, based on Tab bar visibility and tab arrangement.
Some functions can can be accessed by long pressing on a Tab when the Tab Bar is visible.
To refresh a Tab’s view: Swipe down, or tap on the name in the Tab Bar, or tap the location name in main bar then tap it again in the drop down.
To open a new tab:
- Open Bookmarks/History
- Long press on the item that you want to open in a new tab
or
- Select a folder in the main page
- Tap the overflow menu in the action bar
- Tap "Open in new tab",
or;
- Tap the Tab menu then tap "Add new tab"
or;
- When on last (right-most) tab, Swipe from right edge to left (depends on "Settings" - ""More Settings" - "Swiping in first and last...")
Save single tab as default tab or to save a group of tabs (Note: "Save" may occasionally be referred to as "Pin")
To save an individual Tab be opened to a specific location at each app start (default tab)
- Have only one tab opened.
- Navigate to desired location.
- Long press on Tab Title then tap "Set as default".
- Open the Tab drop-down menu, select, "Save tabs", Tap "Now" (leave "On Exit" un-selected).
To save a group of tabs (tab-set) to be opened at each app start:
- Create the tabs, and open each to the location of your choice.
- To set the default tab (to be active at app start) long press on Tab Title then tap "Set as default".
- Open the Tab drop-down menu, select, "Save tabs", Tap "Now" (leave "On Exit" un-selected).
Note: View detail level and sort order should be remembered per tab.
To have MiXplorer save the tab-set that is in place at each app close (to be opened at next app app start):
- Open the Tab menu.
- Select check box: "On Exit".
To reset tabs to whatever was last saved by 'Save tabs - Now" or by "Save tabs - On exit":
- Open the Tab menu then tap Reset tabs. Each Tab's view level and sort order should be remembered and not be reset by this action.
5) Views (file folder list)
There are many ways to configure the file/folder list views using the "View" and "Sort" buttons which appear in the Tools bar at the bottom (in the default skin and configuration). Here are a few of the more notable functions:
- "View" button - "Recursive data": When "Recursive data" is enabled (and after a refresh of the view) MiXplorer will calculate and show the quantity of items and storage space uses in sub-folders.
- "View" button - "Reset defaults": When "Reset defaults" is enabled then pinch zoom settings can be reset to default for each drive independently by going to root of drive, then selecting a view mode (eg "Detailed"). To maintain the different zoom levels disable "Reset defaults".
- "Pin" an item to top of list: A folder or file can be "Pinned" so it stays at the top of the list view regardless of sort options. To pin/unpin an item: Select it then open menu then select pin/unpin. Similarly, apps in the "Open with" list can be pinned to the top of that list by long pressing the app then tapping "Pin"
- Create a custom thumbnail: To create a custom thumbnail for a folder (which would be used when "Auto folder preview" is enabled in main settings) put the image you want to use for the thumbnail in the folder and rename it to .preview.
- Gallery style view for search folders: For the search folders which show all of a certain file type (eg Audio, Document, Image, Video), there is a gallery style view which shows all images of the designated type on the device but grouped in folders by location similar to the way most default gallery apps work. To enable this mode: Tap the "Sort" button then enable "By parent". To show all items in one list without the folders, disable "By parent"
- App, User App, System App: When viewing contents of the "App" search bookmark, tapping on Location allows choice of App (all), User App, System App. To create a custom bookmark to any of those: Tap the Location in Main Bar, then select desired view (App, User App, or System App) then long press location and "Add to" bookmarks.
6) "Home" page
A full page panel containing locations with details, described in more detail here: MiX Nugget - Home Page - https://forum.xda-developers.com/showpost.php?p=82781209&postcount=1168
View Customization (more in Skins/Themes)
Disable Thumbnails (folder specific}: Place image in folder > rename to .nothumbnail
Custom Folder Icon (folder specific): Place image in folder > rename to .foldericon
Custom Folder Icon Preview (folder specific): Place image in folder > rename to. preview
Notes:
- Some image properties may not function properly. Icons can be optimized here: https://tinypng.com/
- Some of these may depend on a related setting within the app (eg .preview file and setting "Auto folder preview")
----------------------------------------------
----------------------------------------------
LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917
iii. WORKING WITH FILES & FOLDERS
Search, searching for items: Expanded description of search methods in this post. MiX Nugget - Searching for Files and Folders: https://forum.xda-developers.com/showpost.php?p=82781351&postcount=1170
Select a file or folder: Long press anywhere on the file, or tap on the icon at the left side.
Select multiple files and or folders: Select one file or folder as described above and then select additional items by tapping on the name of each item.
Select all files and folders in the current view: Tap the "Select all" button in the tools bar, or open overflow menu and tap Select all. Note: the Select all button and the Servers button can be swapped in the Tools Bar via Settings - More Settings.
Once you have selected any item(s) the Action Bar will appear (temporally replacing the Main Bar) and will show a counter of selected items with their size, and icons for some standard actions with an overflow menu for more actions. The downward pointing arrow now offers options to expand shift or invert the selection.
There are several ways to to Copy or Move items:
Task queue Select items, then choose an action (repeat process for multiple jobs), then navigate to destination, then tap Job Queue, then select queued task.
- Individual pending tasks or all pending tasks can be cleared from the queue.
- Pending Copy tasks in the queue can be repeated to different destinations.
Drag & drop: Select some items then long press on that selection and drag. A hovering pop-up will appear indicating how many selected items are being dragged.When the the destination folder becomes highlighted, release the selection and respond to the then a “Drop files” prompt which offers a choice to copy or move the selected items.
Copy To and Move To: To copy/move files to a folder to be selected during the process; select items, open menu, tap ]Copy To or Move To, navigate to location, tap OK.
Some long file operations can be paused using the play/pause button in the task status window. Also, from there the task can be canceled or sent to background.
Delete options. There are several delete methods, the visibility of which may be context sensitive, and MiXplorer has a native "recycle/trash" feature which can be enabled in Settings - More Settings - Undo.
Normal: Deletes file “normally”. As is the case with file deletions (not Recycle or Trash) in other OS, the deletion is non-reversible but the raw data may persist until incidentally written over by other system activity.
Trash: Similar to Recycle or Trash bins on desktops. The locations (drives/root paths) where “Trash” functions may very across ROMs and devices. When "Undo" is enabled as described above the following should occur:
- Deleted items are placed in hidden folders named .recycle at the root of each drive. Don't delete those manually unless you are not using the "Undo" feature.
- In the main menu there is an item called "Undo" which shows a list of available undo items. Long press on an item in that list to see the specific files that can be restored. Short press to restore that item/group of items.
- Menu > Undo > "Remove all"; will delete all the .recycle folders and their contents from all drives (if they exist). Also nota bene: only do this if you are sure you wont need to restore anything). Any time you "Trash" something when "Undo" is enabled the .recycle folder for that drive will be recreated. If you've already disabled "Undo" in settings and still have leftover material in the .recycle folders, those folders can be deleted manually (requires "Show hidden")
- In some cases you may be able to recover items manually from the .recycle folders.
- If the trash cannot be emptied, try the following: Main Menu > Undo > Remove all, or Settings > More Settings > deselect Undo. As with manually deleting the contents of the trash/recycle folder, make sure you dont need anything from there before doing this.
Shredder: Destroys files before deleting them. Only available for certain locations. May take longer for larger selections. Deletion by this method is non-reversible and leaves minimal if any recoverable data on the drive.
Batch Delete: When you try to delete a folder as "Normal", it also takes time to clean up database, removing thumbnails, etc... . You can use "Batch Delete" to remove that folder as fast as possible.
----------------------------------------------
----------------------------------------------
[LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917
iv. FTP and HTTP SERVERS and Send-to
NOTE: As of MiX 6.57 there were substantial changes to servers; ; TCP was removed, Send-to was merged into FTP server, TLS/SSL toggle and explicit/implicit and other switches were added, and multiple accounts can be configured. After updating to 6.57 a username and password will have to be reconfigured as will a few other things as described below. This post outlines the updated server configurations. The description of server configuration for older version of MiX (6.56 and previous) are in this post: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85896901
--------------------------------------------
There are multiple ways MiXplorer can make folders available to other devices including: FTP/Share server, HTTP/WebDav server, SFTP server, and SMB1 Server Each server types offers different functionality and may be applicable in different situations, but the FTP(S,ES)/Share server is most robust and can be accessed by FTP clients and by some native OS file managers so FTP Server was used to create this documentation. HTTP/WebDav server offers less functionality but can be accessed by web browsers and native file explorers on most other systems without any client software, just a full-featured web browser and the requisite credentials. The HTTP server is configured similarly to the FTP server. There are also SFTP and SMB1 servers which are newer and or experimental and which may (or may not) be documented elsewhere.
The MiX server will deliver a different “home” location (folder seen as working folder of directory tree by client) and will offer different levels of access to files on the server device according to: account settings, and method used to run the server, and which folder is in the active tab in MiX on the server device at the time the server is invoked. There is a more detailed description of the different home locations used in different situations below (see Home Path"
Starting Servers
The servers can be started or stopped by a variety of methods: Bottom bar button, main menu, server configuration panel, home screen widget, system tile.
The servers can also be toggled by using Tasker or some other app which can handle intents:
MiX Nugget - Turning Servers ON/OFF with Tasker and...
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-75400602
Some file operations can be performed via intents.:
MiX Nugget - COPY with Tasker and...:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-75389465
Deep Links:
Additionally, servers can be toggled on/off by using deep-links which are essentially web hyperlinks that can be used to create home-screen shortcuts or which can be run programmatically without requiring the management of other parameters. When invoked by a home screen shortcut or programatically the server will be toggled on or off. Home screen shortcuts can be created by any of many methods including:from within Launchers (eg Nova), or from within some web browsers, or by Tasker, Edge Gestures, Automate, or any app that can create a hyperlink shortcuts on the home screen.
For example here is a hack-ish but effective method that was used to create one of the shortcuts. Paste the link into a browser > attempted to connect > attempt fails because network is off or there is no website > use feature to create a home screen shortcut > the shortcut takes the name of the error page but effectively toggles the server > rename shortcut.
These are the deep-links links for toggling each server. Note: these links may be highlighted as hyperlinks in web browsers viewing this page but they are actually links to the MiX installation on the Android device.
https://mixplorer.com/app/ftp/trigger
https://mixplorer.com/app/sftp/trigger
https://mixplorer.com/app/http/trigger
https://mixplorer.com/app/smb/trigger
You can add the working directory at the end of the deeplinks for the servers. Example without and with specification of a working directory:
https://mixplorer.com/app/ftp/trigger
https://mixplorer.com/app/ftp/trigger/storage/emulated/0/pictures
--------------------------------------------
General Server Settings: The settings on the main edit server panel apply to the server in general and to all accounts which run on it.
To edit server: Open servers list by any method > edit (pencil icon).
Port: This is the port # which is appended to the IP address.
Time out (seconds): The duration of time after which the server turns off automatically.
IP address (optional): Experimental.
Toggle Start on boot: Sets the server to start on device boot.
Toggle TLS/SSL: Enable/disable encryption.
Explicit/Implicit: (FTP/Share only) Set Explicit or Implicit mode.
None/Basic/Digest: (HTTPWebDav only) [description needed]
Keystore: [description needed]
Certificate: [description needed]
More about TLS and Explicit/Implicit here: MiX Nugget: Server Security Settings https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85932885
--------------------------------------------
Account settings.
There must be one account (which is equivalent to a username and password configured for the server in the previous MiXplorer versions). Multiple accounts can be created for the same server with each account having different credentials and offering different type of access.
To use just one account: (similar to the username/password from the previous version) rename and configure the “admin” placeholder account or create a new account and delete the placeholder.
To create a new account: In the server edit box Tap Add > enter desired parameters > save.
To edit an existing account: Tap the account drop down (the displayed account name) > tap the name of the account you want to edit.
To delete an account: Tap the account drop down (the displayed account name) > tap the name of the account you want to delete > tap delete. Note: the delete button will not appear if there is only one account.
In the Account edit box the following can be set::
Username
Password
Home Path
Read only
Show hidden globally
--------------------------------------------
Home Path = The location that clients will see as working directory or root of directory tree
The root folder for clients is contextual, based on how the server was started: The servers can be started or stopped by a variety of methods: Bottom bar button, main menu, server configuration panel, home screen widget, system tile. If the server is invoked directly from bottom bar, then root to clients should be the same as the currently active folder in the MiXplorer UI on the server device. If the server is invoked from within the server configuration panel then root to clients should be the designated folder from the configuration panel.
Factors:
- If left blank then the the home directory will be auto populated by the root of internal storage (as you may have witnessed).
- Different clients may yield somewhat different behavior. Full client such as Filezilla on desktop recommended for testing and set up before using native Windows, iOS, or Linux file explorers.
Example Usage Case for multiple accounts: in one FTP server an account could be created with a specific home path so that connections to the server under that account will only see that directory, and another account could be created with no home path designated which allows access to the root of the FTP server device.
--------------------------------------------
Send To: To Use the FTP Server to receive files from another device running MiX via Send-to
- Configure FTP servers on both devices with the same port number. Note: The same port # is no longer required; the port can be set in the settings of the connecting device
- Run the server.
- On the client device: select a file > menu > send to > > tap settings to set port to match server port > select server device > in the authentication box enter a password for the displayed account or select a different account and use that account password > Tap OK.
- The regular MiXplorer file operation containing the typical options to abort the process or put it in the background will appear but for small files may not be on the screen for long enough to interact with; nice to have this if you want to gracefully abort a file transfer.
- The file will be copied to the location determined by the home path set for that account based on how server was started.
Note: subsequent file transfers during the same MiXplorer FTP server session may not require credentials and may proceed automatically. In that case in order to switch users the ftp server must be briefly stopped and restarted.
-----------------------
Link back to MiX FAQ Nugget Index: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-65157352
----------------------------------------------
LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917
MiX NUGGET INDEX
Nuggets are freestanding FAQ posts which describe a MiXplorer feature or workaround in enough detail for basic use without having to sift through the sprawling FAQ.
--------------
Add-ons (simple list):
https://forum.xda-developers.com/showpost.php?p=82834971&postcount=1182
--------------
Automated Intents (Tasker etc):
- COPY with Tasker, Automagic and...:
https://forum.xda-developers.com/showpost.php?p=75389465&postcount=422
- Turning Servers ON/OFF with Tasker and ... :
https://forum.xda-developers.com/showpost.php?p=75400602&postcount=424
--------------
Autotag:
https://forum.xda-developers.com/showpost.php?p=75366938&postcount=420
Auto Tasks:
Run specific user configured file operations (Copy, Move, Delete, Archive, Execute) according to schedule, or run manually from within MiX or via an OS home screen shortcut.
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-88674363
--------------
Batch Renaming and Regex:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-71218953
--------------
Bookmark Advanced Settings:
https://forum.xda-developers.com/showpost.php?p=80301547&postcount=932
- SMB shares on other LAN device.
- FTP servers on other LAN device.
- Bluetooth folder on other BT connected device running MiX
- Cloud
--------------
Date and Time formats:
https://forum.xda-developers.com/showpost.php?p=76749686&postcount=561
and
https://forum.xda-developers.com/showpost.php?p=76750741&postcount=562
--------------
Language package (for translators):
https://forum.xda-developers.com/showpost.php?p=75741128&postcount=469
--------------
Document Provider: For accessing OTG and or accessing /android/data, /android/media, android/obb, and or accessing locations in Android 13, and in other scenarios.
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85878051
--------------
Home Page: A full page panel of locations including details about the locations:
https://forum.xda-developers.com/showpost.php?p=82781209&postcount=1168
--------------
Merging Text (txt) files:
https://forum.xda-developers.com/showpost.php?p=75786123&postcount=480
--------------
Network: Optimizing Network Connections: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-84515405
--------------
Recycle Bin and Undo: Track and restore or undo deleted files and some file operations.
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-88077515
--------------
Searching for Files and Folders:
https://forum.xda-developers.com/showpost.php?p=82781351&postcount=1170
Regex can be used in searches as well as renaming:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308
582/post-71218953
--------------------------------------
SERVERS:
FTP and HTTP SERVERS and Send-to:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-65157350
Server Security Settings:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85932885
FTP, HTTP, TCP SERVERS; Servers configuration ONLY for older version of MiX:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85896901
Turning Servers ON/OFF with Tasker: and...:
https://forum.xda-developers.com/showpost.php?p=75400602&postcount=424
Old Server configuration: [URL]http...ers.com/showpost.php?p=75366970&postcount=421
--------------
Settings:
- Settings Overview:
https://forum.xda-developers.com/showpost.php?p=82834917&postcount=1181
- Settings (reset):
https://forum.xda-developers.com/showpost.php?p=83626647&postcount=1263
--------------
Storage Analyzer:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85942125
--------------
Tabs: Save (aka; pin), rearrange, close, clone Tabs:
https://forum.xda-developers.com/showpost.php?p=75580704&postcount=440
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-75580704
--------------------------------------
Tools: Find Duplicates, Find App Remnants
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-88077467
--------------
Troubleshooting:
Troubleshooting SD card & USB OTG access, and creating Document Providers.: A troubleshooting walk-through document providers and other issues regarding drive and directory access. This post contains many of the other workaround suggested here. https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-87626419
Set document provider for Android 13 (with some resets):
https://forum.xda-developers.com/t/mixplorer-q-a-a d-faq-user-manual.3308582/post-87492173
Reset Root:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-87492173
Cannot uninstall MiX from within Android OS, try doing do so via ADB:
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-87652917
Version Compatibility (possibly helpful for some older devices): URL unfurl="false"]https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-84468783[/URL]
Android-version specific workarounds:. including accessing /android/data on internal and external drives, and /data/data. Applicable primarily to A11 and up but might also be applicable elsewhere.
https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-85904825
--------------------------------------
--------------------------------------
Possible additions.
- App backups.
- Archive management.
- Description of available add-ins.
- MiXplorer Media Viewer usage description
- MiXplorer text Editor usage description
- MiXplorer code Editor usage description
Many things can be learned by exploring the app, most UI elements have a function, long press is your friend.
----------------------------------------------
----------------------------------------------
LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917
Themes and Skins
vi. SKINS and THEMES
Before getting to detailed skinning and theming, here are a few customizations which can be made outside app, skin, and theme settings,
View Customization (more in Skins/Themes)
Disable Thumbnails (folder specific}: Place image in folder > rename to .nothumbnail
Custom Folder Icon (folder specific): Place image in folder > rename to .foldericon
Custom Folder Icon Preview (folder specific): Place image in folder > rename to. preview
Notes:
- Some image properties may not function properly. Icons can be optimized here: https://tinypng.com/
- Some of these may depend on a related setting within the app (eg .preview file and setting "Auto folder preview")
Onward to Skins and Themes
Note: Thanks @FatalBulletHit for the excellent materiel and re-write of this post.
There are 2 ways to change the look of the MiXplorer UI: Skins, and Themes.
Skins:
- Skins primarily involve the colours of various elements, font parameters (eg bold/normal), icon parameters (eg round/square). There are many elements to keep track of but this is all accessible through the MiXplorer UI. Modifying skins can be done within the MiXplorer app by going to: 3 Dot menu > Settings > Skin. Until you learn the various elements, testing small changes incrementally may be advisable and is a good way to explore. eg Make one element bright red then check the UI to see what changed. Lather, rinse, repeat with different elements.
Here are some sources of custom skins and or discussion about them:
• Themes by @djdarkknight96
• Themes by @TerrorFlatRider
• Themes by Vladimir
• Windows Fluent Design theme by @marciozomb13
• Material Design theme by @marciozomb13
• Theme Corporate
• Guillaume Skins Gallery
• YandLiu Skins Gallery
• Skins by @scohut
There are also some skins at the MiXplorer website: https://mixplorer.com/skins/
To select a skin: Settings - Skin - <select skin>
To create new skin (based on default skin): Settings - Skins - Add - New
To modify an existing skin: Settings - Skins - <pencil> - Edit
Skin documentation: You can find a somewhat in depth documentation by @FatalBulletHit in this FAQ post: https://forum.xda-developers.com/showpost.php?p=78541319&postcount=733.
Preview:
{
"lightbox_close": "Close",
"lightbox_next": "Next",
"lightbox_previous": "Previous",
"lightbox_error": "The requested content cannot be loaded. Please try again later.",
"lightbox_start_slideshow": "Start slideshow",
"lightbox_stop_slideshow": "Stop slideshow",
"lightbox_full_screen": "Full screen",
"lightbox_thumbnails": "Thumbnails",
"lightbox_download": "Download",
"lightbox_share": "Share",
"lightbox_zoom": "Zoom",
"lightbox_new_window": "New window",
"lightbox_toggle_sidebar": "Toggle sidebar"
}
To save a new or modified skin:
- To save a skin for the first time: Tap "save" then enter the name of the skin and the author.
- To save after modifying an existing skin, tap save (name/author will not be requested again.)
To export skin (2 ways):
- Settings - Skins - <pencil> - Export - clipboard.
This exports the skin to clipboard. The clipboard contents can be pasted into a text file and saved, or pasted into a new MiXplorer installation.
or
- Settings - Skins - <pencil> - Export -
This saves the skin as an importable .mic file.
To install skin (2 ways):
- Copy skin values from a text file into buffer, or have them in buffer from previous export to clipboard.
- Settings - Skins - Add - Clipboard
or
- Navigate to and select a <skinname>.mic file than select "Import"
----------------------------------------------
Themes
- Themes yield an even wider range of potential UI changes which are made by modifying the actual resources (files and other graphic aspects) with which the UI is constructed and displayed during use. Creating themes requires some understanding about the resources themselves and how to perform some intermediate file management tasks but it is not very hard to do.
- Custom can be found and discussed a few places (and as with any other MiX discussion is welcome here as well). Note, some of these links may beduplicates of the ones listed above.
@djdarkknight96's thread:
Announced here: https://forum.xda-developers.com/showpost.php?p=76812709&postcount=25259
Direct link here: https://forum.xda-developers.com/showpost.php?p=76812645&postcount=1
@TerrorFlatRider's thread:
Announced here: https://forum.xda-developers.com/showpost.php?p=76816946&postcount=25262
Direct link here: [Themes] MiXplorer Themes by TerrorFlatRider; https://forum.xda-developers.com/showpost.php?p=76816946&postcount=25262
Themes from Vladimir:
Announced here: https://forum.xda-developers.com/showpost.php?p=78240950&postcount=26780
Direct link here: https://drive.google.com/drive/folders/1rPYLPtJGeu9iwPCTasT_f2K86uVho7pU
Theme by @mhz
https://forum.xda-developers.com/an...-theme-mhz-t4147783/post83616953#post83616953
Themes from @scohut:
Announced here: https://forum.xda-developers.com/t/...y-featured-file-manager.1523691/post-87994659
Direct link here: https://drive.google.com/drive/folders/1T-WGNypfd1wi-TXx8ekPRq_p7HDanCHs
New (as of December 2020) MiX Theme-ing thread by @TheMystic: [Tutorial] MiXplorer – Themes & Skins – How to make them? https://forum.xda-developers.com/t/tutorial-mixplorer-themes-skins-how-to-make-them.4202319/
Sample theme which could be used as a template. https://forum.xda-developers.com/showpost.php?p=76629263&postcount=25049
To install a Theme: Open MiXplorer (must be MiX, not other file manager) > tap theme mit file > tap import.
To remove/revert theme to default: Settings > More Settings > Reset > Theme.
Note: When installing or installing themes it is best to first revert to the default skin as well.
For historic purposes and just in case it is recreated here are details about the earstwhile original skins gallery:
"Skins may be uploaded or downloaded from the Skins gallery (where there are instructions about how to upload your own skin and apply skins). http://gallery.asymmetrics.nl/index...io5NTZmNzliOTMzOWY4ZDRlYmM3ZjQxNWZjYzE2ZjI3Yg." There are many nice user contributed skins in this gallery. There may be others shared in various posts in the MiXplorer threads.
----------------------------------------------
----------------------------------------------
LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
MiX Nugget - Settings Overview: https://forum.xda-developers.com/t/mixplorer-q-a-and-faq-user-manual.3308582/post-82834917[/B][/SIZE]
- vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
----------------------------------------------
Bug Reporting:
Please report bugs in the primary MiXplorer thread here: http://forum.xda-developers.com/showthread.php?t=1523691.
Bug reports should come from the newest beta version of the app. If you notice a bug in the newest release version then check the newest beta. If it also occurs in the beta then log it from there.
Bug reports should include. details about your device (Android version, ROM version, Root status, SU method, MiXplorer version) as well as a step by step description of how to reproduce the issue and a log taken while the issue was reproduced.
----------------------------------------------
MiXplorer's Built-in Logging:
Enable MiXplorer logging: Settings . More settings . Logging (enable)
MiXplorer has a native logging feature. If logging is enabled (as it is by default) then the most efficient and the recommended way to do it is the following:
- After crash or after experiencing issue,
- Open MiXplorer
- 3-dots menu
- Send log.
If you have disabled logging in the past, or you if are diagnosing more complicated issues or if you will be reviewing the logs yourself before sending. Here is a manual method that some people use:
- Enable MiXplorer logging.
- Close MiXplorer.
- Open MiXplorer.
- Reproduce the issue.
- Close MiXplorer.
- The logs should be in /storage/emulated/0/Android/data/com.mixplorer/cache/log/ (The path may vary slightly depending on ROM).
- Use alternative file manager (just for this ) to get most recent log in folder.
- If using MiXplorer to get the log manually, then make sure to get the log for the previous MiXplorer session rather than the one for the current session.
Testing and Logging Notes:
- Reproduce and log issues in a new session of MiXplorer that was started after logging has been enabled. In other words: Enable logging, then close MiXplorer, then start MiXplorer to reproduce the issue and send the log. A new log is created each time you open MiXplorer. Note: - In some cases it is recommended to test the issue in a clean installation of MiXplorer (after uninstalling MiX then reinstalling it).
- The MiXplorer log directory will not appear until MiXplorer logging has been enabled at least once since last new installation of MiXplorer. Also, if MiXplorer is uninstalled the log folder will be deleted, so if you are getting logs manually during repeated tests remember to do so before next uninstall.
- Before sharing logs it is a good practice to review them for information that you don’t want to share, and to delete that information or replace it with an obvious label, eg <thing x deleted>. To each their own about what to delete, but reviewing logs with privacy in mind before sending is prudent.
- For logging more complex issues, or certain types of FCs where native app logging does not catch the error, a full system log (logcat) may be needed. The app "MatLog" (formerly "CatLog") from Play Store https://play.google.com/store/apps/details?id=com.pluscubed.matlog&hl=en can be used to capture logcats on the device. If an issue is causing reboots then the log might have to be taken from a USB connection on a computer via ADB.
- When you share the log, also share the following:
1) Full details of the device including: Android version, ROM version and variant, Root status, SU status, busybox status.
2) A detailed description about how to reproduce the error when logging so others may try to reproduce it.
----------------------------------------------
LINKS TO FAQ SECTIONS
i. INTRODUCTION, GETTING MIXPLORER, & INSTALLATION (This post)
ii. UI, NAVIGATION, VIEW CONFIGURATION, BOOKMARKS, TABS
iii. WORKING WITH FILES & FOLDERS (Copy Move methods, Trash option)
iv. FTP, HTTP, TCP SERVERS
v. MiX NUGGETS (Freestanding Topical Posts)
vi. THEMES and SKINS
vii. BUG REPORTING, TROUBLESHOOTING, AND FAQ WIP
[Q] How to create a .zip file and sign it in MiXplorer? I've downloaded the zip viewer plugin but cannot create .zip file
Preet_ said:
[Q] How to create a .zip file and sign it in MiXplorer? I've downloaded the zip viewer plugin but cannot create .zip file
Click to expand...
Click to collapse
1. Select files you want to zip
2. Press 3 dots (menu)
3. Press Archiv
4. Paste icon will show
5. Select again Archive in paste menu
I don't remember correctly but it's like this something.
Good Luck!
Sent from my XPERIA M2 using Tapatalk
Preet_ said:
[Q] How to create a .zip file and sign it in MiXplorer? I've downloaded the zip viewer plugin but cannot create .zip file
Click to expand...
Click to collapse
You can create a zip file even without the archive add-in by following a workflow similar to file copy/move operations (and this should also work with the add-in).
- Select some items that you want to put in a zip file.
- Open the overflow menu (3 dots).
- Select "Archive" (the task will be added to the task list just as file copy/move tasks would be)
- Navigate to the location to where you want to save the zip file.
- Open the task menu then select the pending ARCHIVE task.
- Choose the archive options: File type (zip, 7z or tar), level of compression, key (optional), and the split length (optional) then select OK.
I'm not sure exactly what is the the purpose of the archive add-in but have read in the main MiXplorer thread that it handles .RAR files. Maybe some of the MiXplorer regulars can provide a more detailed description if it, which could then be added to the FAQ.
Dzepar said:
1. Select files you want to zip
2. Press 3 dots (menu)
3. Press Archiv
4. Paste icon will show
5. Select again Archive in paste menu
I don't remember correctly but it's like this something.
Good Luck!
Sent from my XPERIA M2 using Tapatalk
Click to expand...
Click to collapse
LOL I type too slow (and got distracted by a phone call while posting an answer) Thanks.
Thanks @Dzepar and @IronTechmonkey !
Thanks for the manual, MiXplorer is great:good:
FTP and paths on SD cards.
Every now and then I test all the possible paths to Internal and External SDs via FTP. With some lingering SD card access issues recently resolved, now seems like a good time to repeat the routine.
In L5.1.1/CM12.1, SuperSU 2.65 (recent Playstore update of flashed SuperSU 2.46), Selinux = permissive, MiXplorer v6.1.4.BETA_B1602294, Filezilla 3.11.0.2 FTP client connecting to MiXplorer FTP using active tab at / as top level, copying a 15MB PDF through a variety of paths:
/storage/sdcard0, and /storage/emulated/legacy, and /sdcard: File copy is successful to root of internal SD but no contents shown at these paths in FTP client. Viewing same location via /storage/emulated/0 shows the copied file and all other expected content. A bad thing about this is that copying the file again by the same method overwrites the existing one without a prompt. I verified this by copying a different file of different type and size but with same filename.
/storage/emulated/0: File copy is successful to root of internal SD..
/external_sd: File copy is successful to root of external SD.
/storage/sdcard1: File copy is successful to root of external SD.
/mnt/media_rw/sdcard1: File copy is successful to root of external SD.
/mnt/shell/emulated/0: File copy is successful to root of internal SD.
/mnt/shell/emulated/legacy: This is a weird one. File copy is successful but this path is not linked to any other location and the copied file is there alone when viewed via FTP or in MiX on device. Not a problem, just interesting, maybe a quirk of the ROM.
[Q]How to export album cover? I was only find add it.
YexuanXiao said:
[Q]How to export album cover? I was only find add it.
Click to expand...
Click to collapse
This is hard to answer with so few details about the situation. Export from what? Are you using the latest version of MiXplorer. Can you provide a screenshot?
YexuanXiao said:
[Q]How to export album cover? I was only find add it.
Click to expand...
Click to collapse
I don't think it's possible to export it. You can change/replace it but not exported. Unless I don't know how
@IronTechmonkey
I think he meant of this:
Sent from my XPERIA M2 using Tapatalk
Dzepar said:
I don't think it's possible to export it. You can change/replace it but not exported. Unless I don't know how
@IronTechmonkey
I think he meant of this:
Sent from my XPERIA M2 using Tapatalk
Click to expand...
Click to collapse
Another as yet unexplored area of MiXplorer for me. Thanks! Just for kicks I played with this for a bit. I was able to replace album art for an MP3 and restore it to the original. The "Remove" button had me thinking I could remove the original album art but it only works to remove a custom image and restore the original. Although the "Remove" button might be more descriptive if it was named "Restore" the behavior of protecting the original material seems normal, although I can remove album art from same file on PC with dBpowerapm's tag editor. Maybe there is a feature request in there somewhere but there are more important things being requested now.
As to @YexuanXiao's question, I did some searching and could only find a references to linux command line functions and some PC utilities that might be able to do this but nothing ready-made for Android.
I'm bad with numbers but I think it was added after media player was added it's very handy tho I do all my edits on pc this is great for quick edit.
Sent from my XPERIA M2 using Tapatalk
Thank you for the great work!
6htGear Rom control V2.1
By @Wuby986 & Daxgirl
Hello everyone!
So here we go again... V2.0
Big thanks:
We would like to begin from crediting people, who gave us ideas, inspiration and, most importantly, their free time, in order to make v2.0 a reality.
To our dearest friends and talented developers, @tdunham and @DaOldMan:
Guys, you OWN this. You made this happen. You pushed us and we pushed you, and together, you, us and rom control, have grown to be what we are today.
No thanks can ever be enough for long nights of applying patches, merging sources, connecting through teamviewer and working out kinks together. @Wuby986 and I are forever in your debt.
Why different thread?
1. The entire application is different. It barely qualifies as an update anymore.
2. All the preferences are different. The way they work is different. It requires new way of doing things. Radically new.
3. new support library and new basic structure.
4. To sum it up... it's too different to maintain same thread for both versions
Project characteristics:
1. Rom control is an open source project, designed to provide rom builders with a core code for compiling android application for controlling core functions of their roms and mods through Content Provider of Settings.System sqlite table
2. Rom control is designed with consideration of the fact that most rom builders do not have sufficient skills in original android development to build application with this functionality on their own
3. The emphasis is given in this version (even more than previous one) to outsource most conditions and attributes to xml, and so to minimize the need of the user (rom builder) to be subjected to java programming
4. In addition to familiar utilization of ContentResolver to pass data between RomControl and system, the project offers additional properties, such as file based preference, URI selection preference, Direct intent to shortcut app preference, preference listing image thumbnails for previews, script running preference, automated template for "About Us" section, automated dialog for changelog, backup and restore finctionality and more.
5. The project is designed to be compiled in Android Studio using the latest sdk tools and gradle tools.
6. The project essentially is designed to be a system application with privileged access, and therefore needs to be installed in /system/priv-app to be granted some of its permissions
7. The project requires root access for some of its functionality. Mainly running shell scripts with su and killing some app processes.
License and sharing policy:
1. This project is distributed under GNU General Public License as open source code. The copy of said license can be obtained and reviewed here
2. As such, this project is protected from claiming exclusivity by anyone.
3. Any developer wishing to use this code, with accordance to the license, must provide full source code for each updated version. That means, for any new version of the rom including updated RomControl application, a link to full source code of the latest version must be provided.
4. By modifying and using this code, you automatically accept the License conditions and must be compliant with GPL, as stated below:
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Click to expand...
Click to collapse
5. You're under no obligation to thank us, credit us or tag us in your official postings while distributing your copy.
6. You ARE, however, prohibited from removing our copyright information from our source code.
7. You are obligated to keep the code open under GPL. Failure to provide sources for updated copies of your work will result in complaint first to XDA officials for license infringement and further to GPL legal department.
8. Using the source code on any other forum outside of xda is of course allowed with accordance to the license and sharing policy, provided the sources are kept open and obtainable by anyone.
9. Using apktool to compile a copy of this code after making changes in the decompiled form of someone else's application is strictly prohibited, as the developer will not be able to provide full open source of their version. Any illegal use of any copy of this project can be and should be legally stopped by the owner of the code copy.
10. This voids rule number 12 of xda promising a developer exclusivity over their product. This product is yours, but the code belongs to the public. You are NOT TO HOLD COPY OF ROM CONTROL EXCLUSIVE.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Click to expand...
Click to collapse
Open source libraries included in this project:
1. RootTools by Stericson
2. Sergey Margaritov's ColorPickerPreference modified to adopt to our needs
3. CircleImageView by hdodenhof
Project requirements:
1. Installed and updated android sdk, including but not limited to:
Android SDK Build-Tools 24
Android SDK Platform-Tools 24
Android support repository 33
Google repository, rev 29
Latest android support library
2. Android studio version AT LEAST the latest stable version (currently 2.1.2), you can use the canary channel as well, currently on 2.2.0 preview 5.
3. Updated gradle tools
4. Working knowledge of importing project into Android Studio and troubleshooting gradle sync. If you don't know how to, Google it.
5. EXTENSIVE knowledge in android modding:
This project is for rom developers and modders. It helps coordinate between your users and your mods. If you don't build roms or don't have mods, this project means nothing to you.
What support you can expect to get:
1. Code explanation regarding major functionality
2. Adding new preferences and navigation items
What support you CANNOT expect:
1. Setting up android studio
2. Debugging gradle issues and compiling
3. Changing colors, strings, adding themes, design, changing setup... - Android documentation is vast and Stackoverflow is even vaster.
4. Smali modding
5. Private messaging support - DO NOT EVEN TRY
6. Asking for compiled apk file.
This is NOT an application thread. This is NOT an application. This is a SOURCE CODE for MAKING application.
The answer to a question "Can someone give me a compiled version" is "And what are you going to do with it?"
Project main Git repository:
Here
Thread list of contents:
Starting the project
Adding navigation drawer items
Running android app: where, how, builds, gradle tasks and you-name-it
Preferences - Part 1: Introduction
Preferences - Part 2: Types of preferences
Themes, About Us activity and Changelog dialog
Backup and Restore
XDA:DevDB Information
6thGear RomControl v2.0, Tool/Utility for all devices (see above for details)
Contributors
daxgirl, wuby986, tdunham, DaOldMan
Version Information
Status: Testing
Current Stable Version: 2.1
Stable Release Date: 2016-08-26
Created 2016-07-06
Last Updated 2016-08-26
Latest Update details:
Post number 195
Step 1 - Importing the project:
1. Perform full installation of the latest stable version of Android Studio in your environment. You can find info about stable and canary releases here
2. You can have more than one version of android studio installed on single platform. For more information please read further on the same page in section Using Multiple Android Studio Versions. I personally do recommend the latest canary build, which is currently AndroidStudio 2.2.0 preview 5. But you can always go with the stable release. Or beta channel.
3. Make sure your sdk is updated, including sdk for platform 24 (nougat). The compile sdk for this project is 24.
4. Make sure your support repositories are configured and updated.
5. Click on our github repository link on the OP first post and make sure you're connected with your github account. If you don't have one - create it! Why? because you will need to share your sources for this project. And because you all use as mantra that you can mod android apps because it's open source. So BE OPEN SOURCE. Have your name on github.
6. Once you're logged in into github, fork our repository. In the right upper corner of our main git repository you have those buttons:
Click "fork" to make a copy of this repository in your own repositories. Now you have your own repository.
7. On YOUR repository find this green button on the top right above the code, which says "Clone and Download". DO NOT DOWNLOAD ZIP. Instead, click the little "clipboard" icon to copy the .git uri and return to studio.
8. In studio: File > New >Project from Version Control > Git
9. Paste the git uri and choose destination. Click ok. Android studio will import the project from git and open it for you.
10. At this point if you're asked to update gradle build tools or anything else, do it. Wait for gradle to sync with project files. If you get errors, resolve them as referenced. If you cannot, google is your friend.
We WILL provide some support for initial importing of the project and setting it up for a very limited period of time. Gradle can be a tricky business. Please be sure to provide us with specific error from gradle log and a line in the gradle script on which the error is made.
11. We WILL know if your errors are because you didn't update sdk and build tools. And we will kick your butts for posting without following instructions. Remember, our time is valuable and given to you for free. Our instructions are clear and we made a huge effort to write them. If you can't be bothered with following them, beware.
12. Once the gradle is done syncing without errors, just in case, click Build > Rebuild Project. Once that is done without errors and it says BUILD SUCCESSFUL, you can start building your project following the instructions on the next post.
Adding items to the Navigation Drawer:
1. Switch to project view.
It will be easier for you to navigate through project files. For that:
On the left panel on top, below the android studio menu, find this:
This is what your project will look right after you import it. This is module view. By default it is categorized and to work with it you need some understanding of this view.
Click the 2 arrow icon which is circled in blue and select "project"
Your structure will now change.
Navigate into the project by the following path: Project name > app > src > main
Now you will see directories, like: java, res, assets... and so on.
This is your working directory. You will be making your code changes here.
2. Find a file called nav_drawer_arrays.xml. It is located in res/values folder. Double click on it to open.
You will see the following 3 arrays inside. The first one is a reference array (simple typed array) and the other 2 are strings arrays.
Those are WORKING ARRAYS. When you run the app as it is now, you will see all the items created in the navigation drawer based on this info.
Please read the comments we wrote in the xml file for you:
Code:
<resources>
[COLOR="Green"][B][I]<!--The following array is for icons you want to use for your items
You can create new icons bu right clicking the drawable folder and choosing
New vector drawable
You have a great selection of items in xml vector format.
Those are supported starting lollipop.
YOU SHOULD NOT USE PNG. not even material one. Vectors will work best with any device density.
Once you have created the vector, reference it as regular drawable in the array below.
MAKE SURE THE ITEMS IN ALL 3 ARRAYS CORRESPOND IN ORDER AND ALL 3 ARRAYS ARE SAME LENGTH-->[/I][/B][/COLOR]
<array name="nav_menu_prefs_drawables">
<item>@drawable/ic_system_ui</item>
<item>@drawable/ic_phone</item>
<item>@drawable/ic_framework</item>
<item>@drawable/ic_notification_panel</item>
</array>
[COLOR="green"][B][I]<!--This array is for your items titles.
Use @string reference, so later on your app can be translated with ease
KEEP THE ORDER BETWEEN ALL YOUR ARRAYS-->[/I][/B][/COLOR]
<string-array name="nav_menu_prefs_titles">
<item>@string/systemui_prefs</item>
<item>@string/phone_prefs</item>
<item>@string/framework_prefs</item>
<item>@string/notification_panel_prefs</item>
</string-array>
[COLOR="green"][B][I] <!--This array is the most valuable one
Here you put the file names of the preference files you create in your xml directory
THEY MUST BE PRECISE AND CASE SENSITIVE!!! DO NOT ADD .xml SUFFIX-->[/I][/B][/COLOR]
<string-array name="nav_menu_xml_file_names" translatable="false">
<item>ui_prefs</item>
<item>phone_prefs</item>
<item>framework_prefs</item>
<item>notification_panel_prefs</item>
</string-array>
</resources>
3. Let's say you have 10 preference files in directory called xml. That means you will want to have 10 items referring to your preference files in the navigation drawer. That means you will need to have 10 items in EACH array. Create 10 empty preference files. DO NOT COPY THE ONES FROM RC v1.0. Just right click the xml folder, choose "New" and choose "New XML resource file". Give it a name and click ok. Leave them empty for now. create all the icons you need for them in the navigation drawer.
4. Populate the arrays with titles, icons and xml names. You're done. You now have a working items in the navigation drawer. You do not need any changes in java files. the items are being generated on run time and their onClicks redirected accordingly. If you run the app right now you should have 10 empty preference files.
We strongly encourage you to keep the ui_prefs.xml file and references to it in your project while you're working on it. It contains most valuable information about the kinds of preferences we have included and their various usages. You can remove it from arrays before making the release version. You can have it as last item in your arrays and use it as test dummy to see how things should work properly
Run!
Installing and running your builds in Android Studio:
First of all - data or system app?
The simple answer is SYSTEM. And not just system - we need some high level permissions, so definitely /system/priv-app. Why?
So for that we dig deeper into android permission system.
1. Writing settings into settings storage database:
This permission was revoked from data apps on Marshmallow. Meaning, THEORETICALLY, that only system apps can write into Settings.System. So how come we can write when the app is installed as data app? Oh, this is where THEORETICALLY part comes in. Permission to write system settings is declaired in framework in such a way, that it allows data apps to write there if they target sdk lower than 23 in their build. That permission level is called "pre23". That is why in our gradle we have a somewhat peculiar sdk division for building. Let's look at the image:
As you can see, target sdk is set to 22. This is not by mistake. This is by design so if you want to test the basic functionality of the app by installing debug version in data, it will not crash every time you flip a switch.
This is the definition of pre23, we target sdk 22 so the pre MM permissions can be achieved by running the app in data.
Although all of you will be including this app in your roms in system priv-app, you will be working with it quite alot as you build it. We want you to be able to run it from data if you wish so. if we target sdk 23 and up it will never run from data, unless installed also in system.
You are free to change this to 23 or 24. But NEVER run it while installed only in data then. It will crash like a drunken monkey.
Also, changing it to 23 or 24 for TARGET sdk is meaningless. It's not better because it's a higher number. For target sdk it makes no difference.
2. Running reboot
We run reboot functions in a proper android shutdown sequence. Any of you that are familiar enough with linux kernel based platforms KNOW the system should not be shut down by killing it's process.
Therefore all reboot functionality in our app is native android reboot. For THAT we absolutely need the app to have an initial copy in priv-app. If the app is only installed in data, clicking on any reboot option, either from reboot menu or from reboot dialogs, will result in FC in your face. the following permissions cannot be obtained by data apps NEVER EVER.
Code:
<uses-permission android:name="android.permission.REBOOT"
tools:ignore="ProtectedPermissions"/>
<uses-permission android:name="android.permission.DEVICE_POWER"
tools:ignore="ProtectedPermissions"/>
<uses-permission android:name="android.permission.RECOVERY"/>
3. But we have root permissions? Isn't it enough?
So here is the thing you should remember:
Android doesn't give a damn about root permissions. When we run command under su we talk to the linux kernel through shell. We do not run it on android level. Android is NOT linux. There is NO android permission which is compiant with su.When we are talking about android application permissions, we are talking about PackageManager, which is android framework system service, that grants the permissions to perform certain action. Package manager does not know su. It is not part of linux platform. It is android. Android is not designed to have root access. Not on any level. it does not recognize unix commands by default.
So when we execute your scripts, android doesn't do it. Our application code doesn't do it. We just pass it to the kernel as runtime command. Remember that, when you come complaining that your scripts don't run. We can't help it. If the kernel refuses to execute them, something is WRONG in the script syntax or structure.
4. So data or system? The answer is - when you build and test run your app - BOTH
Can you run apps from android studio while one of the copies is installed in system? Absolutely. As any system app, app is allowed to have an update.
The most important thing is for that update to have same signature and same package as the app in system. Once the app is installed in priv-app it has privileged permissions. You can after that, as oyu build, install updates in data, so you don't have to push every single test build into system and reboot, and all privileged permissions will work.
Gradle, baby!
Gradle is a build tool. You can read on history of gradle online. It was not developed with any relation with android. Google decided to adopt gradle as their primary build tool for their primary development environment for android and hence, android gradle plugin was born.
Build tool is a way to "put things together in orderly fashion". In essence, android application is a bunch of files in folders. Making it into a running product is a matter of some complexity. Connecting java to resources, signing, packaging, updating manifest, setting primary configs and build related configs, compiling java, compiling dependencies, including multiple modules, being able to have several builds and flavors in one project - this is what gradle does for us.
If you wish to learn more about gradle for android, please watch this amazing video https://www.youtube.com/watch?v=jJ9j7MvGPkU.
Gradle, in a manner of speaking, is a bunch of tasks. Tasks are executed in specific order. Files are being copied, deleted, compiled and packaged as result of single button click.
Android gradle plugin comes with specific predifined tasks. We can also write our own tasks, which we usually do, for our own usage. We will talk about OUR specific tasks later on in the advanced section.
For now we will talk about basic android gradle tasks, such as assembleRelease, assembleDebug, installRelease, installDebug and so on.
1. Clicking RUN button
If you have a look on the top panel of android studio you have this green "play" button next to a selection box which, usually, says "app". Like this:
This is what will appear on the run menu when you first open the project and it's done syncing with gradle. If the "app" selection box has a red "X" on it, means gradle is syncing now or has failed to sync and you need to find out WHY and fix it. Once there is no red "x" current configuration is ready to run.
When you click the green run button, it will run whatever task is in the selection box. When it says "app" in the selection box and you click run, it will do the following:
1. Compile debug build
2. Install it on your connected device
3. Run it
So what is "app"? App is the main of the module we want to run. It is the only module in our project. So by running "app", we run the RomControl application on a device in DEBUG mode.
Why is it good to run in debug mode? For 2 reasons:
1. Run "app" configuration supports instant run. You can read more on instant run here. This will push the code changes into your running app on device and apply immediately. It's very handy if you add a preference or 2 and want to test how it looks or works. If instant run is impossible for your current build tools, android studio will tell you and it will tell you why. It usually means that you need to upgrade android gradle plugin. This can be done with ease.
2. Running app module in debug mode will give you full stack trace if there is an error. It will be easier for you to copy the log here for us to have a look at and debug. Or debug yourselves.
The downside of running debug mode?
1. It's somewhat slow. Meaning the app on the device is a little slow in debug mode (although now it's not as slow as it used to be)
2. Debug mode by definition runs from data. So none of the reboot options will work. So if you want to test actual changes that require reboot from our app, you need to have a system priv-app version installed. You can have a debug version installed in priv-app and then you can use instant run, like we spoke before.
2. So how do we make a release version?
1. Generating signing key
For that we need a signing key. We already made a full prepared platform for you to run release build in our app gradle build file. All you need to do is create a signature and make some little edits. So, let's roll.
To create a signature please follow these instructions
Please remember or write down the following:
1. Path where you create the signature
2. Key password
3. Store password
4. Key aliasYou do not need to generate the release build just yet. Just finish creating your own keystore and remember where you put it.
Now go to the parent folder where your rom control project sits. For example if you put it in AndroidStudioProjects folder, in the same folder create a folder called "keys" (no caps, just "keys"). Copy your keystore there. Or originally create it there.
Now go back to android studio. to the left project panel (provided it is in project view, like we asked you to make it) and scroll down... You will see at the very bottom some singleton files, like gradlew, gradlew.bat, gradle.properties and so on. One of the files there is called key.properties. Double click on it to open.
Inside you will see 4 strings. Like this:
Out in your actual key information. The one you used to create your key. you need to make changes to all 4 fields.
for example:
As you can see we used relative path to the keystore. Which is why it's supposed to be in the parent folder of your folder containing your project in direcroty called "keys".
2. Telling gradle to use our signing key for release builds
On the left project panel look inside the "app" module folder. On the bottom of it, after the AndroidManifest.xml file, you will see a builg.gradle file. Double click to open it.
This is a gradle file for building our app module. You will see there are alot of configurations related to android build there. It will look something like this:
You need to un-comment the sections pointed to with red arrows. To comment or un-comment the section in android studio, select the section and click "ctrl + /"
Now you should be ready to build the release version. Let's test that:
1. On the right upper corner of the studio window you will see little vertical "gradle" tab. Like this
Click on it. A side window till open with gradle tasks. Like this:
2. Open app > tasks > build
3. Find a task called assembleRelease and double click on it.
4. Wait for it to finish. You will see tons of things running in the gradle console window on the bottom. Provided you didn't mess up any of the previous steps, it will work fine.
5. Once it's done, check that you did now have errors and that build was successfull.
6. If all is good, open in file manager your project folder > app > build > outputs > apk. There you should see your freshly compiled release version. Release version is called simply RomControl.apk. it is already zipaligned and signed. You can go ahead and use it in your rom, push it into priv-app and test. So on.
3. So every time I need to run assembleRelease and push the apk into priv-app and reboot? NO!!!
1. Once you run your first assembleRelease, take that apk and push it into system priv-app. Reboot your device.
2. Now look again into the app > tasks in the gradle window on the right. You also have there "install" tasks. Open it and find "installRelease". Connect your device with app installed already in priv-app and double click on installRelease. This will install the release as UPDATE in the DATA apps. This is so you don't need to push the app to device as you're building and testing. You can make code changes, install release as data and run it FULLY. Becasue you have the original sitting in the system, it will have all the premissions for the reboots. So you can build and test from data.
3. Please remember that as you build and test only the data version of your app is updated. So once you are done testing and the build is final, run assembleRelease and take the final apk from the outpute/apk folder to include in your rom.
4. Do I need to go to the gradle menu on the right all the time to run installRelease? NO!!!
After you run a task from the gradle menu have a look at the run button on the top panel. Surprise! It doesn't have "app" selected anymore. it has the latest task you ran!!! Look:
Now if you click the "run" button it will run the selected task. If you want to select another task from the tasks you used in the past, Just select from the selection box menu and click run.
So which build to run and when?
1. If you're building and testing continuously, we recommend keeping the app as debug in data only and NOT TO USE the reboot options.
For adding preferences and building your ui you don't need to use reboot options. Just click LATER on reboot dialogs if you include reboot options.
So you can use instant run, switch to "app" configuration and keep running in debug mode from data as you build.2. When you go further into preference testing, we recommend uninstaling the debug version. creating signed release version and push into priv-app. From this point on run installRelease task to instal release update in data as you build and correct and test scripts and reboot options.
3. When ready to go final release with your rom, use task assembleRelease to build your final version and include it in your rom zip
4. Commit latest changes to your github repository
Uploading sources to git
1. Provided you followed our instructions and forked the project source code and then cloned it to studio, it is now connected to your forked git project.
2. Any new file you add will ask if you want to add it to git. And will turn it's color to green if added. Any file that is not added will have brown color.
3. To add brown colored file to github, right click it, choose git > add
4. You should have the following available on the top panel:
The green arrow is for commiting and pushing changes to github. Once you push it the following window will open:
5. Check what files you would like to commit. For example, never commit key.properties file which contains your key password.
6. Write description of your commit and choose from the blue button selector box commit and push.
7. Make a habit of committing your work daily or at least on a new feature basis. It easier to follow for you and also serves as backup.
We would be happy to talk more about gradle and various tasks, but this post had a specific purpose. To teach you how to manipulate build types and use it to you advantage. Please ask us specific questions about gradle tasks related to your build.
Preferences - Part 1: Introduction
1. Major change in implementation:
1. For this release we made a major change in how preferences are handled. They are not handled anymore. They handle themselves.
2. For that to happen we needed to subclass ALL native android preferences except PreferenceScreen and PreferenceCategory.
3. What does it mean to subclass? That means we created java classses which extend (resemble) native android preferences and we wrote our own implementation of how they should behave, how they should load their values and write their values.
4. That being said - there is no more standard android preferences in this project. No more SwitchPreference, no more CheckboxPreference, no ListPreference... None of those.
5. Two reasons for that:
1. We didn't want you to get lost in special conditions anymore. We wanted you to be able to set if the preference should restart systemui from xml file when you declare preference. For that we needed to add custom xml attributes. For that we needed a preference class to be able to acknowledge that. So we needed a custom preference class.
2. We wanted the preference to manage itself in by reading and writing from and to database. Instead of fragment running endless iterations and conditions. When our new preferences are born (attached to the screen), they get their value from the database directly. No one needs to set values to them. When they are changed, they know to write into database directly. From their own class. Not containing fragment doing that for them.
2. Types of preferences
1. Two state preferences:
MySwitchPreference
MyCheckboxPreference
FilePreference
2. Dialog preferences:
MyListPreference
MyEditTextPreference
IntentDialogPreference
ThumbnailListPreference
ColorPickerPreference
3. Native preferences(PreferenceGroup subclasses):
PreferenceScreen
PreferenceCategory
4. Slider Preference:
MySeekBarPreference
5. Special preferences:
OpenAppPreference
UriSelectionPreference
RunScriptPreference
ImageHeaderPreference
3. Setting defaults:
It is ABSOLUTELY VITALLY IMPORTANT that you set android:defaultValue to all the preferences that change and read values. That means:
MySwitchPreference
MyCheckboxPreference
FilePreference
MyListPreference
MyEditTextPreference
ThumbnailListPreference
ColorPickerPreference
MySeekBarPreference
4. What happens if we use regular android preferences? Like SwitchPreference or ListPreference?
Nothing! Absolutely nothing will happen nor to this project, nor to your database and, MOST IMPORTANTLY, nor to your mods.
It will act like normal preference. It will not write to database. Your mods will not be affected and WILL NOT WORK.
5. Custom attributes for value changing preferences and RunScriptPreference
1. app: packageNameToKill
This attribute is of type string and you will need to provide which app you want to restart when this preference changes value.2. app:isSilent
This is a boolean type attribute, which is by default set to true. That means that if you don't set this attribute and you DO set the package name to kill, it will restart the app you want without warning as soon as the value has been changed. If it is set to "false", upon value change a dialog will appear with app icon and test informing user that for this action to take effect an app restart is required. They can then choose to kill app now or cancel the dialog and kill it later.3. app:rebootRequired
This is also a boolean type of preference which by default is set to false. If you set it to "true", upon preference value change a dialog will appear, informing the user that reboot is required for this action to take effect. good example for that is changing the default app intent to open on home button double click. That needs framework reload.
If rebootRequired is set to true and you ALSO set package name to kill, reboot takes preference. Package to kill will be ignored.
Preferences - Part 2: Types of Preferences
1. Two state preferences (meaning - can be true or false)
MySwitchPreference & MyCheckboxPreference
Code:
[COLOR="Teal"][B] <!--Following category shows variety of two state preferences-->[/B][/COLOR]
<PreferenceCategory
android:title="Two stated preferences test category">
[COLOR="DarkGreen"][B] <!--Normal Switch preference-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MySwitchPreference
android:defaultValue="true"
android:key="normal_test_switch"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Normal test switch"/>
<!--Switch preference which will throw a dialog that app reboot is required-->
<com.wubydax.romcontrol.v2.prefs.MySwitchPreference
android:defaultValue="true"
android:key="kill_app_with_dialog_test_switch"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Kill app with dialog switch"
app:isSilent="false"
app:packageNameToKill="com.android.systemui"/>
[COLOR="darkgreen"][B] <!--Switch preference which will in ADDITION to actual work, also silently restart app with given package-->
<!--Note, that isSilent attribute is by default TRUE. So you don't need to specify it if you want silent app restart-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MySwitchPreference
android:defaultValue="true"
android:key="kill_app_silently_test_switch"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Kill app silently test switch"
app:packageNameToKill="com.android.contacts"/>
[COLOR="darkgreen"][B] <!--Switch preference which will throw a dialog that following it's action device reboot is required-->
<!--Please note, even if you specify the need to kill app, once the rebootDevice attribute is TRUE, kill app attributes are ignored-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MySwitchPreference
android:defaultValue="true"
android:key="reboot_required_test_switch"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Switch reminding of need to reboot"
app:rebootDevice="true"/>
[COLOR="darkgreen"][B]<!--We can use kill app on checkboxes as well. Same goes for rebootDevice-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MyCheckBoxPreference
android:defaultValue="true"
android:key="test_checkbox_with_kill_app"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Kill app checkbox"
app:isSilent="false"
app:packageNameToKill="com.android.systemui"/>
</PreferenceCategory>
FilePreference
Code:
<PreferenceCategory
android:title="File preferences">
[COLOR="darkgreen"][B]<!--File preference is a very special kind of preference, which works like switch but has different output.
Normal switch preference, like any two state preference, write boolean true/false into preferences.
In our app it also writes 1/0 into database.
File preference doesn't write into database. If it is switched on, it creates a file in our app directory in data.
That name of that file is what you set as key.
This is widely used by [user=1042140]@tdunham[/user] for global boolean needs in systemui.
Please refer to his guide about setting global boolean to see appropriate smali application for this preference.
This is most useful for mods in smali files where you do not have context access to get content resolver.
Because File class is native java class and checking for it's existence does not require android context.
File preferences can have attribute to kill app or reboot device.-->[/B][/COLOR]
[COLOR="darkgreen"][B] <!--This is a simple file preference. Note that once it's switched on, a file with the name identical to key is created in
/data/data/com.wubydax.romcontro.v2l/files
When it's switched off the file is deleted.-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.FilePreference
android:key="new_file"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="New file preference"/>
[COLOR="darkgreen"][B] <!--This file preferences upon change will prompt to kill app-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.FilePreference
android:key="another_file"
android:summaryOff="Disabled"
android:summaryOn="Enabled"
android:title="Kill app file preference"
app:isSilent="false"
app:packageNameToKill="com.android.systemui"/>
</PreferenceCategory>
2. Dialog preferences
ColorPickerPreferece
Custom attributes:
alphaSlider, hexValue - both booleans, TRUE by default
Code:
[COLOR="Teal"]<!--The following category demonstrates various ways of using ColorPickerPreference-->[/COLOR]
<PreferenceCategory
android:title="Color pickers test category">
[COLOR="DarkGreen"][B]<!--Normal color picker preference-->
<!--Please note, the [COLOR="Red"][U]hexValue and the alpha are there by default now[/U][/COLOR]. If you want to cancel them, you need to specify false-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ColorPickerPreference
android:defaultValue="#ffccdd"
android:key="test_color_preference"
android:title="Normal test color picker"/>
[COLOR="DarkGreen"][B]<!--Color picker preference without the alpha slider and without the hex value
You can set false to both or one of them-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ColorPickerPreference
alphaSlider="false"
hexValue="false"
android:defaultValue="#ffffff"
android:key="no_alpha_color_key"
android:title="Color picker with no alpha or hex"/>
[COLOR="darkgreen"][B]<!--Color picker preference with kill app option
Note, [U]you can also use rebootDevice attribute[/U], like with two stated preferences-->[/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ColorPickerPreference
android:key="app_kill_color_key"
android:title="Color picker with app kill"
app:isSilent="false"
app:packageNameToKill="com.android.systemui"/>
</PreferenceCategory>
MyListPreference
Custom attributes:
app:dependentValue - will enable you to set dependencies upon choosing selected value. If a dependent value is selected by user, the dependent preference will become disabled.
Code:
[COLOR="DarkGreen"][I]<!--Example of simple list preference with radio button items
You absolutely HAVE to set dafaultValue and it has to be one of your entryValues string arrays
You can use any of the following with kill app attributes or rebootDevice attribute
Note, that you can now use dependency on list preference.
Custom attribute app:dependentValue will allow you to decide which list item, if selected,
will set dependent preferences disabled.-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MyListPreference
android:defaultValue="20"
android:entries="@array/test_list_entries"
android:entryValues="@array/test_list_values"
android:key="test_list_key"
app:dependentValue="1"
android:title="Choose items from the list preference"/>
ThumbnailListPreference
Custom attributes:
app:dependentValue - will enable you to set dependencies upon choosing selected value. If a dependent value is selected by user, the dependent preference will become disabled.
app:drawableArray - references array which provides resources for the thumbnail images for each list item
app:entryList - references array of strings to provide names for actual list items
app:entryValuesList - references array of strings for the entry values to be written to preferences and database for selected list item
Code:
[COLOR="darkgreen"][I] <!--Thumbnail list preference is a special kind of preference which allows you to show preview of the selected image
This can be useful f.e. for setting custom bg to toggles in systemui
Needless to say you need to put the same images you put in systemui in Rom Control in drawables
And you need to create 3 kinds of arrays in arrays.xml file. 2 string arrays for entryList and entryValuesList and one simple array
for drawable references. You can see the arrays for the following preferences inside arrays.xml
You have to set default and the default has to be one of entryValuesList strings-->
<!--Example of simple Thumbnail preference with no additional attributes-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ThumbnailListPreference
android:defaultValue="1"
android:key="test_thumbnail_key"
android:title="Simple thumbnail preference"
app:drawableArray="@array/thumbnail_drawables"
app:entryList="@array/thumbnail_items"
app:entryValuesList="@array/thumbnail_values"
app:dependentValue="2"/>
[COLOR="darkgreen"][I]<!--Example of Thumbnail preference which calls to kill app upon selected item-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ThumbnailListPreference
android:defaultValue="2"
android:key="test_thumbnail_kill_app"
android:title="Kill app thumbnail preference"
android:dependency="test_thumbnail_key"
app:drawableArray="@array/thumbnail_drawables"
app:entryList="@array/thumbnail_items"
app:entryValuesList="@array/thumbnail_values"
app:isSilent="false"
app:packageNameToKill="com.android.systemui"/>
IntentDialogPreference
Custom attributes:
app:intentSeparator - to allow you to set the char which will separate the package name from activity name in the intent component name
app:showSearch - boolean attribute which determines whether search field will be available in the dialog window. By default it's TRUE. If you want no search, set to FALSE
Code:
[COLOR="DarkGreen"][I]<!--The following preference is a special preference that's called IntentDialogPreference
This preference allows you to choose an app from the list. it also conveniently includes search field
This preference writes into database what's called component name for specific system needs.
When we want to call an app in android, we need to provide some information as to which app we want to launch
and which activity inside that app we want to lunch.
Launching app by combination of those is called explicit intent. Explicit intent needs 2 things to run an app:
1. Package name
2. Activity or service name
This preference is most useful for launching an specific app based on info you can fetch from database
For example on double click on home key
Intent dialog preference puts the info for explicit intent in a string. First package name, then separator, then activity name
You can use any separator you want. The default separator is "##"
But as you can see in following example we set the separator to be forward slash "/"
The separator depends on how you build the mod in smali for your needs.
Any kill app or reboot device attributes are applicable here as well-->
[/I][/COLOR]
[COLOR="darkgreen"][I]<!--This specific IntentDialogPreference has defaultValue set to Settings app.
You DO NOT need to set default. Only if you want to. But it is in most cases not necessary and even not that good.
This is just an example. When you run this, you will see that the preference has an icon of the chosen app on the right
and a name of the app set as summary. When you choose a new app, those things change-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.IntentDialogPreference
android:defaultValue="com.android.settings/com.android.settings.Settings"
android:key="test_intent_with default"
android:title="Select Test App with default"
app:intentSeparator="/"/>
[COLOR="darkgreen"][I]<!--This IntentDialogPreference comes with no default and no separator. So default separator will be applied "##"
and it also has no search showing-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.IntentDialogPreference
android:key="test_intent_without default"
android:title="Select app, no default, no search, ## separator"
app:showSearch="false"/>
[COLOR="darkgreen"][I]<!--This preference will prompt to reboot device upon selection
This is useful if f.e. you use it to set default app to open when home button is double clicked
Reboot is advised but not necessary immediately. So user will be shown a dialog to let them know they need to reboot
And they can reboot immediately or later-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.IntentDialogPreference
android:key="test_intent_without_default"
android:title="Select app and reboot device"
app:intentSeparator="/"
app:rebootDevice="true"
app:showSearch="true"/>
MyEditTextPreference
Code:
[COLOR="DarkGreen"][I][B] <!--Edit text preference is a dialog preference that allows you to enter custom text-->[/B][/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.MyEditTextPreference
android:defaultValue="test"
android:key="test_edit_text_key"
android:title="Input custom text"/>
3. Special Preferences
OpenAppPreference
Custom attributes:
app:componentName - string type attribute to provide package name and desired activity name to open installed app. Please pay attention to instructions in code.
Code:
[COLOR="darkgreen"][B][I]<!--The following category shows usage of special preference we use to open an app based on component info
All you need to provide for this preference is package name and activity name separated by forward slash "/" like shown below
We will split the component info into components and check if the app is installed
if it's installed, we will show the app icon as preference icon and app name as title
If the app is not installed the preference is automatically removed from the list.
You can set your own summary to explain about the app.
If you wish to show a custom icon for that app shortcut or have custom title,
if you wish to use custom icon or custom title, like you would do normally with preference,
You are free to use android:title and android:icon attributes.
Our class will then use the items you chose instead of the application title and icon.
This WILL NOT affect the intent for opening application. It's a cosmetic measure for your convenience.-->[/I][/B][/COLOR]
<PreferenceCategory
android:title="Shortcut to apps preferences">
[COLOR="darkgreen"][B][I] <!--Example of simple app shortcuts. If those apps are not installed, the preferences will not show-->
[/I][/B][/COLOR] <com.wubydax.romcontrol.v2.prefs.OpenAppPreference
android:summary="Application to browse your files, including root files"
app:componentName="com.speedsoftware.rootexplorer/com.speedsoftware.rootexplorer.RootExplorer"/>
<com.wubydax.romcontrol.v2.prefs.OpenAppPreference
android:summary="Control samsung's toolbox, turn it on or off, choose available apps and rearrange them"
app:componentName="com.wubydax.toolboxsettings/com.wubydax.toolboxsettings.ToolboxSettings"/>
[COLOR="darkgreen"][B][I] <!--Example of OpenAppPreference with custom title and icon-->
[/I][/B][/COLOR] <com.wubydax.romcontrol.v2.prefs.OpenAppPreference
android:summary="Choose what app or shortcut to open when TW launcher is being swiped to the magazine page"
android:title="Shortcut to GearTWSwipe"
android:icon="@mipmap/ic_launcher"
app:componentName="com.wubydax.geartwswipe/com.wubydax.geartwswipe.ResetDialogActivity"/>
[COLOR="darkgreen"][B][I] <!--Open app preference with only cuctom title and the icon which is loaded from the app-->
[/I][/B][/COLOR] <com.wubydax.romcontrol.v2.prefs.OpenAppPreference
app:componentName="eu.chainfire.supersu/eu.chainfire.supersu.MainActivity-Material"
android:title="Chainfire's SuperSu App"
android:summary="Manage root permissions for apps and services"/>
</PreferenceCategory>
UriSelectionPreference
Code:
<PreferenceCategory
android:title="Select image preferences">
[COLOR="darkgreen"][B][I]<!--Select image preferences allow the user to select any image from the gallery.
The uri for that image will be written into the database
Android can fetch images based on their uri (universal resource identifier).
A type of uri that you all know is called URL, which is a web address.
Uri for database is the "address" of an item inside the database.
In android we have Media database, which hosts info about media items. In our case we are interested in images.
Upon clicking this preference a Gallery will launch, upon selecting image, it's uri will be written into database.
In your mods you can fetch the string, convert it to Uri and set that image as background to anything you want.
We use this method for setting custom image in our mod for background to notification panel-->[/I][/B][/COLOR]
<!--Those are examples of simple uri selection preference. The icon for them will be the selected image preview
You need to set title and key. That's it.-->
<com.wubydax.romcontrol.v2.prefs.UriSelectionPreference
android:key="test_image_selection_key_2"
android:title="Select Image 2"/>
</PreferenceCategory>
RunScriptPreference
Custom attributes:
app:scriptFileName - string type attribute to provide script name to run, including the .sh extension.
app:showConfirmDialog - a boolean type preference, dtetermining whether a warning dialog will be shown before executing the script. we have had this request for previous version, since users sometimes hit script preference by mistake and it executes immidiately. By default this boolean is TRUE. So for any script a warning dialog will show. Youc an set it to FALSE to execute without warning.
app:rebootOptions - enum type attribute:
Sometimes you will perform actions in script which will require a device reboot to take effect
For this purpose we created this attribute, which can take 3 values:
1. None - this is default. You do not need to specify "none". if you don't specify rebootOptions it will always be "none"
This means reboot is not required upon running script
2. Optional - this means that the execution of this script is ok without immediate reboot,
but for the action to take effect, reboot is required. if you set rebootOption to "optional",
upon successful script execution a user will be presented with a dialog.
A dialog has 2 buttons: reboot now or reboot later.
Use this option ONLY if reboot is required for action to take effect and reboot is not VITAL. Meaning no app will FC without reboot.
3. Imminent- sometimes you will want to run scripts which replace key system components, such as entire apk
or even jar files. When a script like that is executed, you want immediate reboot. Because other wise the app in question
can throw FC. Most of you from what we have seen, use reboot option for scripts like these at the end of the script.
You NO LONGER HAVE TO. We will handle the reboot for you ONLY if the script is executed successfully and "imminent" option was chosen.
It is nice to WARN the user that their phone will reboot after running the script.
That is why if you choose app:rebootOptions="imminent" a dialog will be shown to the user once they click on preference.
This dialog will warn them that upon script execution their device will reboot
If you use this option, once the script is done we will execute the reboot. Make sure you have your app in priv-app before testing this. It will need reboot permissions. Please read the gradle explanation 2 posts above, regarding those permissions.
DO NOT use "reboot" or "kill zygote" commands at the end your scripts. Do yourselves and your users a favour and stop using those all together.
Code:
[COLOR="darkgreen"][I][B]<!--Running scripts in rom modding is no silly business.
We need shell scripts for purposes that can vary from writing a line into a file on sd,
through replacing sound files and host files,
to as far as replacing entire apk and jar files.
Because shell scripts can vary in their complexity, we created a special preference that runs shell scripts.
The major component in this preference is the scriptName attribute. The script name should be given in full,
as string, including extension (.sh).
The code for the preference knows where your scripts are found. It will locate the script if it's found there
and execute it.
if script execution fails, a number is being shown. That means the exit code of a script is not 0.
That means something is wrong in the script.
If the script is executed properly, a toast will be shown saying "Executed successfully"-->[/B][/I][/COLOR]
<PreferenceCategory
android:title="Run script preferences">
[COLOR="darkgreen"][B][I]<!--This is the basic script preference. It will jujst run a script.-->[/I][/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.RunScriptPreference
android:title="Execute script with prompt"
app:scriptFileName="simple_test.sh"
android:summary="This action will throw warning dialog before executing script"/>
[COLOR="darkgreen"][I][B]<!--Because of the radical nature of running shall scripts with su,
We included a dialog which is shown when a user clicks on script preference
By default confirm dialog will be shown before executing eny script. If you wish to run a script without the warning dialog,
You need to specify the custom attribute that a dialog should not be shown.
We strongly encourage you to keep the dialog. It's better for your users to be sure they clicked on the right option-->[/B][/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.RunScriptPreference
android:title="Execute without prompt"
app:scriptFileName="simple_test.sh"
app:showConfirmDialog="false"
android:summary="This action will execute script without warning"/>
[COLOR="darkgreen"][I][B]<!--Script preference with optional reboot-->[/B][/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.RunScriptPreference
android:title="Script with optional reboot"
app:rebootOptions="optional"
app:scriptFileName="simple_test.sh"
android:summary="This action will write into a file on sd card and show dialog that reminds the user to reboot their phone at this time or later for the action to take effect"/>
[COLOR="darkgreen"][I]<!--Script preference with imminent reboot-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.RunScriptPreference
android:title="Script with imminent reboot"
android:summary="This action will run script which has reboot command at the end and warn user that reboot of device will follow the script execution immediately"
app:rebootOptions="imminent"
app:scriptFileName="simple_test.sh"/>
[COLOR="DarkGreen"][B][I] <!--We were asked by some developers to make a kill app option available for script preference
Therefore, you can also use the kill package attributes now, silent or with dialog,
for your script preferences.
The following RunScriptPreference will prompt killing contacts app f.e
P.s. you can set icons to your run script preferences like any other preference-->[/I][/B][/COLOR]
<com.wubydax.romcontrol.v2.prefs.RunScriptPreference
android:title="Execute and kill app + icon"
android:icon="@mipmap/ic_launcher"
android:summary="Upon finishing, this script preference will prompt a user to kill app, since we set the isSilent attribute to false"
app:packageNameToKill="com.android.contacts"
app:isSilent="false"
app:scriptFileName="simple_test.sh"/>
</PreferenceCategory>
ImageHeaderPreference
Custom attributes:
app:imageSource - reference type of attribute to set the image to show as header preference. The default size for image is width match_parent and height 200dp.
This is just one of those little things we made for fun, but it ended up being @tdunham 's favourite toy
Code:
[COLOR="DarkGreen"][I]<!--This is one of those little bonus thingies what we made for our beta-testers
and you all get to inherit it. It's a little preference class called ImageHeaderPreference
It allows you to choose and image as header for your preference screen.
Just to bring a little color and life into all those switches and checkboxes...-->[/I][/COLOR]
<com.wubydax.romcontrol.v2.prefs.ImageHeaderPreference
app:imageSource="@drawable/android"/>
Themes, About Us activity and changelog dialog
1. Themes:
1. There 2 built in themes: light and dark. In the navigation drawer, much like in previous version, you have a section under More options which is called "Set Theme".
2. Upon clicking it a dialog will pop up to allow theme selection.
3. The default theme is the light one. If you wish your default theme to be the dark one, please navigate to res/values/styles and find the following line (at the very bottom):
Code:
<integer name="default_theme">0</integer>
(yes, we put integer in styles (because we CAN), we're weird like that... LOL. It's for your convenience.
4. To make the default theme the dark one, change 0 to 1.
2. About Us activity - how to populate it:
1. Navigate to values/about_us_resources.xml
2. When you open it you have 3 sets of 3 arrays each. This idea is very similar to how you populated the navigation drawer items. Let's have a look:
Code:
<resources>
[COLOR="Teal"][B]<!--Contact info arrays-->[/B][/COLOR]
[COLOR="DarkGreen"][B][I] <!--In this array you will put the icons for contact information,
for example xda icon for your xda thread, site icon for your site, facebook icon and so on-->[/I][/B][/COLOR]
<array name="about_contact_us_drawables">
<item>@drawable/icon_2</item>
<item>@drawable/icon_1</item>
<item>@drawable/icon_3</item>
</array>
[COLOR="darkgreen"][B][I]<!--In this array you will put the titles for your contact info items. Keep the order consistent between all 3 arrays-->[/I][/B][/COLOR]
<string-array name="about_contact_us_text">
<item>Facebook</item>
<item>Our Site</item>
<item>XDA</item>
</string-array>
[COLOR="darkgreen"][B][I]<!--In this array you will put the titles for the URL strings that will open once a user clicked on the item-->[/I][/B][/COLOR]
<string-array name="about_contact_us_links" translatable="false">
<item>https://www.facebook.com/</item>
<item>https://www.google.com/</item>
<item>http://forum.xda-developers.com/</item>
</string-array>
[COLOR="teal"][B]<!--Team info arrays-->[/B][/COLOR]
<array name="about_team_drawables">
<item>@drawable/icon_5</item>
<item>@drawable/icon_6</item>
<item>@drawable/icon_1</item>
</array>
<string-array name="about_team_names">
<item>Master Yoda - wise and talented lead developer</item>
<item>Luke Skywalker - one handed theme master</item>
<item>Darth Vader - dark theme master</item>
</string-array>
<string-array name="about_team_links" translatable="false">
<item>https://www.facebook.com/</item>
<item>https://www.google.com/</item>
<item>http://forum.xda-developers.com/</item>
</string-array>
[COLOR="teal"][B] <!--Credits and thanks info arrays-->[/B][/COLOR]
<array name="about_credits_drawables">
<item>@drawable/icon_1</item>
<item>@drawable/icon_3</item>
<item>@drawable/icon_4</item>
<item>@drawable/icon_2</item>
<item>@drawable/icon_6</item>
<item>@drawable/icon_5</item>
</array>
<string-array name="about_credits_names">
<item>Star Trek - for being ultimately better than Star Wars</item>
<item>Jean-Luc Picard - for making us crave hot earl-grey tea even in the middle of the summer</item>
<item>Data - for running on the best rom. Google, we still are waiting for THAT android version</item>
<item>Janeway - for being a normal person and drinking black coffee</item>
<item>Q - for reminding us that you can live forever and still look great</item>
<item>Worf - for teaching us to love Klingons. It was NOT easy</item>
</string-array>
<string-array name="about_credits_links" translatable="false">
<item>https://www.facebook.com/</item>
<item>https://www.google.com/</item>
<item>http://forum.xda-developers.com/</item>
<item>https://www.facebook.com/</item>
<item>https://www.google.com/</item>
<item>http://forum.xda-developers.com/</item>
</string-array>
</resources>
3. As you can see from the code above it's very simple. Find images you want to use, You don't need to make them round. They will be made round on runtime.
4. Replace the demo information in our arrays with your own, including images reference, titles and links. Make sure the lenghts of 3 arrays in each category are equal.
5. You can make as many or as little items as you want. As long as the length of drawable array equals to length of titles array and equals to length of links array in single category.
6. All the magic is done in java for you. Just populate arrays and RUNNNN
3. Changelog Dialog - how to populate it:
1. Navigate to /res/values/changelog_resources.xml
2. Inside you will find 1 string and 1 string array. Let's have a look:
Code:
<resources>
[COLOR="Teal"][B]<!--Do not forget to include this in any locale specific folders for translation-->[/B][/COLOR]
[COLOR="Green"][B][I]<!--In the following array put your changelog items
Take as many lines as you need.
Add as many items as you want or delete some if those are too many
This order is how they will appear in the dialog
Make any order you want from top to bottom-->[/I][/B][/COLOR]
<string-array name="changelog_items">
<item>Some changelog thing lkjh l lkjh slkjh lkjh s,mnb lkjhs lkjh poiuy slkjh</item>
<item>Another changelog thing ;lkj d;lkj ;lkjs ;lkj ;lkj s;lkj ;lkj s;lkj ;lkj ;lks ;lkj ;lkj</item>
<item>Some more changelog things</item>
<item>Some even more changelog thing</item>
<item>And another changelog thing ;lsj; lkjs ;lkj ; lkj;lsjk ;sklj s;lkj s;lk js;lkj s;lkj</item>
<item>How many changelog things</item>
<item>What a long changelog!!!</item>
<item>Is it twenty already?</item>
<item>Are we there yet?</item>
<item>Live long and prosper</item>
<item>So say we all</item>
<item>Patience you must have</item>
<item>Great scot!!!</item>
<item>No disassemble…</item>
<item>Almost there</item>
<item>Done with changelog</item>
</string-array>
[COLOR="green"][B][I] <!--This will be the dialog title.
Put your own rom version and name.
Have fun-->[/I][/B][/COLOR]
<string name="rom_version_for_changelog">build v1.0 6thgearrom</string>
</resources>
3. Fill and up with your own items. Enjoy!
Backup and Restore functionality
Backup and restore is done on a background thread using a service. Once the service gets intent with certain action it performs the required activity and shuts down.
The service can be called with wither backup action or restore action. In each case it will act differently.
1. How does that work - BACKUP:
When a request for backup is passed to the service, it does several things:
1. Checks if on your sdcard there exists a folder called RomControl and checks if the folder contains subfolder backups. If they don't exist, they are being created.
2. In our data f folder in data/data/com.wubydax... we have a shared_prefs folder. Inside it we have preference xml files for all of your preferences.
3. We iterate through those files and read them line by line, and once they are read, we take the keys and read the actual database value for that key
4. Then we write those values with their corresponding keys into a new backup file
5. Each backup file has a new name. You can see how it's formed here:
Code:
String currentDate = new SimpleDateFormat(getString(R.string.backup_file_prefix_date_format), Locale.ENGLISH).format(Calendar.getInstance().getTime());
String fileName = currentDate + "_" + Build.DISPLAY;
String backupFileName = fileName + getString(R.string.backup_file_suffix);
File newBackupFile = new File(Constants.BACKUP_FOLDER_PATH + File.separator + backupFileName);
As you can see we use 3 components for name:
a. Current date and time up to munites
b. The display id from the build.prop
c. suffix RCBackup
That is so the users can differentiate between different backups from different roms or versions
6. It also backs up the file preferences (see the preference explanation post for that)
7. The service finishes and throws a toast that it's done and the file can be found in the backup directory
2. How does that work - RESTORE:
1. During restoring action, the main activity closes. It also says so in the warning dialog which appears right before restore is activated.
2. We made it so to make sure no onPreferenceChangeListener is triggered for any of your preferences. We also want a clean restart of the activity once the restore is done, so all the items can be loaded from the database, which has been updated by the restore process.
3. During restore we read the selected backup file, break it into pieces and write the values to database. When the activity is reloaded, preferences read from databases and update their own values.
4. For file preferences, during restore process we delete the files saved previously and only create the ones contained in backup file.
reserved 8
reserved 9
reserved 11
reserved 12
This blows away the original version folks.
Cant wait for it to go live. And couldn't resist being the first poster as well.
tdunham said:
This blows away the original version folks.
Cant wait for it to go live. And couldn't resist being the first poster as well.
Click to expand...
Click to collapse
You are simply the best ???
Sent from my SM-G920F using Tapatalk
Wow. This is amazing. Thank you for your time and sharing it. It's just another treasure after v1.0.
Sent from my SM-G935F using Tapatalk
Waiting
Wooooow , loooong time waiting for this , now time for reading & starting ready for it xD , as usual thanks for ur awesome work , ???
thereassaad said:
Wooooow , loooong time waiting for this , now time for reading & starting ready for it xD , as usual thanks for ur awesome work , ???
Click to expand...
Click to collapse
Happy to see you here! Don't read yet. Only posts 1, 2, 3, 4 and 6 are finalized.
Sent from my SM-G920F using Tapatalk
Wow, I am loving how this version is going to handle killing apps. And about custom preferences I am a bit confused but I guess I should wait till it's out and see how it would work. Setting default_theme it's just mind blowing! Guys before the source is out I think it would be a good idea to try reading and understanding what is outlined in OP I didn't use to sign my rc but it's explained clearly how to do it in studio. :good:
WOW!
As I have said before, you and Wuby are the most precious thing to us, the ROM devs
What an incredible update!
Sure, I have a lot of work to do on rom control v2, but I have you on my side -that's a good thing hehe.
Amazing work! I am sure my users enjoy it as well.
Keep it up, but make some time for me too
Sent from my SM-G900F boosted by PhoeniX ROM