diff --git a/docs/signs.rst b/docs/signs.rst index 2bbb092..6490230 100644 --- a/docs/signs.rst +++ b/docs/signs.rst @@ -147,10 +147,12 @@ Here is a more complex example where not every marker of a certain id has a cert 'y':85, 'z':-234, 'name':'Bar'}], - 'markers': [dict(name="Towns", filterFunction=townFilter, icon="town.png")], + 'markers': [dict(name="Towns", filterFunction=townFilter, icon="icons/marker_town.png")], ### Note: The 'icon' parameter allows you to specify a custom icon, as per ### standard markers. This icon must exist in the same folder as your ### custom webassets or in the same folder as the generated index.html + ### in this case, we use the marker_town.png icon which comes with + ### the Overviewer by default, located in a subdirectory of web_assets. } @@ -239,7 +241,7 @@ Marker Icons Overviewer ships by default ======================================== Overviewer comes with multiple small icons that you can use for your markers. -You can find them in the ``overviewer_core/data/web_assets/`` directory. +You can find them in the ``overviewer_core/data/web_assets/icons`` directory. If you want to make your own in the same style, you can use the provided ``marker_base_plain.svg`` and ``marker_base_plain_red.svg`` as template, with diff --git a/overviewer_core/data/web_assets/marker_anvil.png b/overviewer_core/data/web_assets/icons/marker_anvil.png similarity index 100% rename from overviewer_core/data/web_assets/marker_anvil.png rename to overviewer_core/data/web_assets/icons/marker_anvil.png diff --git a/overviewer_core/data/web_assets/marker_anvil_red.png b/overviewer_core/data/web_assets/icons/marker_anvil_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_anvil_red.png rename to overviewer_core/data/web_assets/icons/marker_anvil_red.png diff --git a/overviewer_core/data/web_assets/marker_base_plain.svg b/overviewer_core/data/web_assets/icons/marker_base_plain.svg similarity index 100% rename from overviewer_core/data/web_assets/marker_base_plain.svg rename to overviewer_core/data/web_assets/icons/marker_base_plain.svg diff --git a/overviewer_core/data/web_assets/marker_base_plain_red.svg b/overviewer_core/data/web_assets/icons/marker_base_plain_red.svg similarity index 100% rename from overviewer_core/data/web_assets/marker_base_plain_red.svg rename to overviewer_core/data/web_assets/icons/marker_base_plain_red.svg diff --git a/overviewer_core/data/web_assets/marker_factory.png b/overviewer_core/data/web_assets/icons/marker_factory.png similarity index 100% rename from overviewer_core/data/web_assets/marker_factory.png rename to overviewer_core/data/web_assets/icons/marker_factory.png diff --git a/overviewer_core/data/web_assets/marker_factory_red.png b/overviewer_core/data/web_assets/icons/marker_factory_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_factory_red.png rename to overviewer_core/data/web_assets/icons/marker_factory_red.png diff --git a/overviewer_core/data/web_assets/marker_hoe.png b/overviewer_core/data/web_assets/icons/marker_hoe.png similarity index 100% rename from overviewer_core/data/web_assets/marker_hoe.png rename to overviewer_core/data/web_assets/icons/marker_hoe.png diff --git a/overviewer_core/data/web_assets/marker_hoe_red.png b/overviewer_core/data/web_assets/icons/marker_hoe_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_hoe_red.png rename to overviewer_core/data/web_assets/icons/marker_hoe_red.png diff --git a/overviewer_core/data/web_assets/marker_mine.png b/overviewer_core/data/web_assets/icons/marker_mine.png similarity index 100% rename from overviewer_core/data/web_assets/marker_mine.png rename to overviewer_core/data/web_assets/icons/marker_mine.png diff --git a/overviewer_core/data/web_assets/marker_mine_red.png b/overviewer_core/data/web_assets/icons/marker_mine_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_mine_red.png rename to overviewer_core/data/web_assets/icons/marker_mine_red.png diff --git a/overviewer_core/data/web_assets/marker_ship.png b/overviewer_core/data/web_assets/icons/marker_ship.png similarity index 100% rename from overviewer_core/data/web_assets/marker_ship.png rename to overviewer_core/data/web_assets/icons/marker_ship.png diff --git a/overviewer_core/data/web_assets/marker_ship_red.png b/overviewer_core/data/web_assets/icons/marker_ship_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_ship_red.png rename to overviewer_core/data/web_assets/icons/marker_ship_red.png diff --git a/overviewer_core/data/web_assets/marker_tower.png b/overviewer_core/data/web_assets/icons/marker_tower.png similarity index 100% rename from overviewer_core/data/web_assets/marker_tower.png rename to overviewer_core/data/web_assets/icons/marker_tower.png diff --git a/overviewer_core/data/web_assets/marker_tower_red.png b/overviewer_core/data/web_assets/icons/marker_tower_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_tower_red.png rename to overviewer_core/data/web_assets/icons/marker_tower_red.png diff --git a/overviewer_core/data/web_assets/marker_town.png b/overviewer_core/data/web_assets/icons/marker_town.png similarity index 100% rename from overviewer_core/data/web_assets/marker_town.png rename to overviewer_core/data/web_assets/icons/marker_town.png diff --git a/overviewer_core/data/web_assets/marker_town_red.png b/overviewer_core/data/web_assets/icons/marker_town_red.png similarity index 100% rename from overviewer_core/data/web_assets/marker_town_red.png rename to overviewer_core/data/web_assets/icons/marker_town_red.png