====== Custom Icons ======

----

Locus Map enables using custom icons for **Points**, points folders, and also **Tracks/routes** folders (custom icons are **not supported in Livetracking**).

Once you create or download an icon pack you may simply select folder icons in **Folder add/edit dialog** or in **Edit dialog** for points (simply tap on point and choose edit from sub-menu)

==== Basics ====

  * **directory**: usually //Android/data/menion.android.locus/files/Locus/icons/ // (check in the "About App" section of the main menu)
  * **pack**: zipped (*.zip)
<WRAP center round tip>
On Android 11 and newer OS versions, it is almost impossible to access the /Android/data/ sector. Therefore, **[[manual:user_guide:settings:backup_fsys#set_the_main_directory|move the main app directory to /Android/media/]]** sector which is fully accessible with common file browsers.
</WRAP>

==== Making your own icon pack ====

  * create or download custom icons in **.PNG** format
  * the size of icons is upon you but we recommend the size **96x96px**. You can also set the size by adding the **_sX.X** parameter to the icon filename - the range is 0.5 to 10.0 times the default size. //Example: icon_sX.X.png//
  * default align of all icons is **center bottom line**. If you want the icons to be aligned **center-center**, add **_hscc** (hot spot - center-center) to the end of the icon name. //Example: icon_hscc.png//
  * both parameters can be combined. Size first, align second. //Example: icon_sX.X_hscc.png//
  * pack the icons to a ZIP file and copy it into the **Locus/icons** directory. **DO NOT compress a folder with icons** - the icons must be in the root of the ZIP file.
  * some icons are already available in the Locus Store. Do you want to place some of your own there? [[locus.map@asamm.com|Get in touch]] with us!
==== Icon groups ====
If you need to have your custom icons sorted into groups here's the solution:
  * edit and add the following XML file into the .ZIP pack with the icons. It defines commonly used "info" that Locus Map uses in many places for various files. Next to this main <item> tag with meta-information, there's a new container <content> that contains meta-information related to the content of the file itself. There are also a few comments so it should be clear:\\ 
<code xml info.xml>
<?xml version="1.0" encoding="utf-8"?>
<items version="1">

	<!-- container with item meta information -->
	<item>
		<version>1</version>
		<name>
			<def>Default pack name</def>
		</name>
		<creator>Creator</creator>
		<publisher>Name of publisher</publisher>
		<description>
			<def>Custom icons for Locus Map app</def>
			<cs>Vlastní ikony pro Locus Map aplikaci</cs>
		</description>
		<date>2017-06-01</date>
	</item>

	<!-- container with meta information about item content -->
	<content>
		<!-- sort options, 'content' for original sort as packed in zip, otherwise sorted by name -->
		<sort>content</sort>

		<!-- single category of items -->
		<category id="pins">
		
			<!-- name of category (optional, ID is used if not defined) -->
			<name>
				<def>Pins</def>
				<cs>Špendlíky</cs>
			</name>
			
			<!-- items within a category -->
			<item file="blue-pushpin.png">
			
				<!-- name of item (optional) -->
				<name>
					<def>blue</def>
					<cs>modrá</cs>
				</name>
			</item>
			<item file="green-pushpin.png">
				<name>
					<def>green</def>
					<cs>zelená</cs>
				</name>
			</item>
		</category>
		
		<!-- another category -->
		<category id="letters_red">
			<item file="1.png" />
			<item file="2.png" />
			<item file="3.png" />
			<item file="A.png" />
			<item file="B.png" />
		</category>

		<!-- another category -->
		<category id="letters_blue">
			<item file="1_blue.png" />
			<item file="2_blue.png" />
			<item file="3_blue.png" />
			<item file="A_blue.png" />
			<item file="B_blue.png" />
		</category>
	</content>

</items>
</code>
Important is tag <category> that defines your **group** of items.
====== Map & Navigation cursors ======

----

One of the possible custom modifications in Locus Map is the option to set your own cursors (images) on the map. Here is a short explanation of how to do it:

All possibilities are divided into two packs – Basic cursors and Navigation cursors

==== Basics ====

  * all subfolders in the ZIP file are optional. They may be used if you want to create some publicly available icons (we’ll gladly put them in the Locus Store, possibly also as paid content). In this case, Locus Map selects automatically the best folder.
  * if you want to use the pack just for your personal purposes, best is to put the icons at the root of the .zip file

===== Basic cursors =====

  * directory: //Locus/icons/cursors///
  * pack: zipped (*.zip)
  * where to select: Locus settings > Controlling > Map screen > Screen cursors

**content: (example name ‘myIcons.zip’)** - name the files according to this sample:

    myIcons.zip
      nodpi/ (optional)
        ic_location_gps.png
        ic_location_network.png
        ic_location_cross.png
        ic_location_move.png
        ic_location_view.png
        ic_rotate_arrow.png
      xhdpi/ (optional)
        ic_loc …
      hdpi/ (optional)
        ic_loc …
      mdpi/ (optional)
        ic_loc …
      ldpi/ (optional)
        ic_loc …
      ic_location_gps.png
      ic_loc…

===== Navigation cursors =====

  * directory: //Locus/icons/navigation///
  * pack: zipped (*.zip)
  * where to select: Locus settings > Navigation > Advanced settings > Navigation cursors

**content: (example name ‘myIcons.zip’)** - name the files according to this sample:


    myIcons.zip
        nodpi/ (optional)
            ic_navig_foot.png
            ic_navig_cycle.png
            ic_navig_car.png
        xhdpi/ (optional)
            ic_nav …
        hdpi/ (optional)
            ic_nav …
        mdpi/ (optional)
            ic_nav …
        ldpi/ (optional)
            ic_nav …
        ic_navig_foot.png
        ic_nav …

====== Geocaching icons ======

----

Locus Map offers also the ability to create custom icons for geocaches. The current implementation isn't as straightforward as adding custom icons described above, anyway, we suggest reading that too.

__The whole procedure requires a few steps__:

  * creating an icon pack
  * uploading it into **Locus/icons** directory
  * configuring Locus Map to use these icons

===== How to =====

==== Creating an icon pack ====

Images of caches are usually created from one icon (in case of //disabled// and other statuses it's more than one). Anyway, this new system offers to create icons with various parameters.

Firstly, prepare the images you want to use. At the bottom of this page, there is a list of possible image names. I'll not explain all images, as all are self-explaining by their names.

You don't have to use all the images. Locus Map will first try to load images from your pack and in case an icon is missing, the default will be used.

Compress all icons to a .zip file (icons will be stored directly in zip, not in any sub-directory) and place them into the **Locus/icons** directory.

==== Configure Locus ====

In order to use these icons as a substitution for default Locus Map icons you have to specify this file in Locus [[manual:advanced:customization:config|Configuration file]]. So edit this file and specify the zipped file into the parameter **geocaching_icon_pack**. That's all you need to do.

===== List of possible icons =====

<code txt>
// basic icons
type_benchmark.png
type_cache_in_trash_out.png
type_community_celebration.png
type_earth.png
type_event.png
type_gc_hq.png
type_gc_hq_block_party.png
type_gc_hq_celebration.png
type_giga_event.png
type_gps_adventure.png (for "maze" type of geocache)
type_groundspeak.png
type_lab.png
type_letterbox.png
type_locationless.png
type_mega_event.png
type_multi.png
type_mystery.png
type_project_ape.png
type_tradi.png
type_virtual.png
type_waymark.png
type_webcam.png
type_wherigo.png

// difficulty icons
diff_10.png
diff_15.png
diff_20.png
diff_25.png
diff_30.png
diff_35.png
diff_40.png
diff_45.png
diff_50.png

// terrain icons
terr_10.png
terr_15.png
terr_20.png
terr_25.png
terr_30.png
terr_35.png
terr_40.png
terr_45.png
terr_50.png

// size icons
size_huge.png
size_large.png
size_micro.png
size_not_choosen.png
size_other.png
size_regular.png
size_small.png

// some special icons
special_computed.png
special_disabled.png
special_found.png
special_not_found.png
special_own.png

// icons for waypoints
wpt_final.png
wpt_parking.png
wpt_question.png
wpt_referencepoint.png
wpt_stage.png
wpt_trialhead.png
</code>