Map Collectible Markers - Phantom Blade Zero
Version 1.6.1 (made for Steam build 26266538)

WHAT IT DOES
Shows the collectibles you have NOT picked up yet as icons on the region map:
  - Black Stone fragments
  - Amber fragments
  - Memory Flowers (blue)
  - Major Chests (one icon per chest)
  - Keys
  - Challenges (Long Pillars, Human-Faced Banyans, Scarecrows)
  - NEW in 1.1.0: Bells you have not rung yet (gold bell icon; the
    game itself only shows rung bells), Weapons (orange), Shadow Weapons
    (red), Accessories (green) and Medicines (purple), with the icons of
    the game's "Collection details" panel. Hover one to see the bell's or
    item's name. An item that sits inside a Major Chest is shown by the
    chest icon only. An unrung bell is only a marker: ring it in the
    world to teleport to it like any other bell.
  - NEW in 1.1.0: hovering a weapon, accessory, medicine, Black Stone,
    Amber or key icon also says how you get it: "Defeat a boss to get
    it", "Defeat the enemies here", "Given by an NPC (quest)", "Behind a
    door or mechanism", "From a story event", "In a chest" or "Inside a
    breakable object" (from the game's own map data; since 1.2.3 it
    names the boss or NPC when the map data says who it is, and items
    from a Memory Flower say so).
  - NEW in 1.3.0: upgrade materials (cyan icon): breakable jars, crates
    and chests that drop weapon, accessory or medicine upgrade materials.
    Hover one to see which materials and how many. Once you break or
    open it, its icon goes away. Positions were read out of the game's
    level files: about 600 spots in 12 regions, most but not all of the
    material drops in the game. A few in 血色森林 (Blood Forest) only
    exist while the forest is snowed in; they show only then.
  - NEW in 1.4.0: letters and loose pages (the Reading tab) lying in
    the world (paper icon). Hover one to see its title. Once you pick
    it up, its icon goes away. About 130 letters in 9 regions, read
    out of the level files like the materials; letters a quest or an
    NPC hands over have no spot and are not shown. A letter already in
    your Reading tab (for example one an NPC gave you) is not shown.
    Letters and materials that the story has removed from the level
    are not shown in the region you are in.
Collected items disappear from the map. Items under unexplored fog are shown too.
Hover an icon to see its name. The items are the ones the game counts in
its own "Collection details" panel (R on the map);
upgrade materials and letters are extra and not counted there.

HIDE / SHOW THE ICONS (new in 1.2.0)
Press H on the map to hide this mod's icons, and H again to show them.
Your choice stays for every map until you close the game. Hidden icons
cannot be hovered or selected. Quest, bell and other game icons are not
touched. On a gamepad: d-pad down. It does not work on the map opened
at a bell.

FILTER BY KIND (new in 1.4.0)
On the map, press F or click the "Marker filter" button at the bottom
left (標記篩選 / 标记筛选 in Chinese) to open a panel with one row per
kind of icon: Black Stone, Amber, Memory Flowers, Major Chests, Keys,
Challenges, Bells, Weapons, Shadow Weapons, Accessories, Medicines,
upgrade materials and letters. Click a row to hide or show that kind;
"Show all" turns every kind back on. F or the button closes the panel.
The last row, "Icon size" (圖示大小 / 图标大小), makes the icons smaller:
click it to switch between 100%, 80% and 60%.
Unlike H, these choices are kept after you close the game, in
  %LOCALAPPDATA%\ProjectPBZ\Saved\PBZMapMarkers\New_CSV.csv
(delete that file to reset it). H still hides all icons at once. The
rows work with the mouse or the d-pad. Not on the world map (Tab).

TRACK AN ITEM (new in 1.5.0)
On the map, point at an icon and press V: the icon gets bigger, and in
the world a marker shows where that item is, with its name and distance.
When the item is off screen, the marker sits at the edge of the screen
with an arrow pointing to it. Press V on the tracked icon again to stop.
Tracking ends by itself once you pick the item up.
The filter panel (F) has a new last row, "Track the nearest item"
(自動追蹤最近的物品 / 自动追踪最近的物品). When it is on and nothing is
tracked with V, the marker points to the nearest item you have not
picked up yet in the area you are in (kinds switched off in the panel
are skipped). This setting is kept after closing the game; after
starting the game, open the map once before the marker appears.
The marker is hidden in menus, cut-scenes and boss fights. On a gamepad,
put the cursor on the icon and press L3. An item tracked with V is
forgotten when you close the game.

KEYS AND GAMEPAD (new in 1.6.0)
Every key of this mod works on the map and has a gamepad button too:
  hide / show the icons   H   d-pad down
  filter panel            F   View / touchpad
  track an item           V   L3 (press the left stick)
  nearest-item tracking   N   d-pad up (switches "Track the nearest
                              item" on / off; a note on the map
                              shows the new state)
While the filter panel is open, d-pad up / down (or the arrow keys)
chooses a row and d-pad left / right (or the arrow keys) switches it,
so the panel works without a mouse.
To change a key, open the panel and use one of the four "Key:" rows
near the bottom: click it (or choose it with the d-pad and press
right), then press the new key. A keyboard key changes the keyboard
key, a gamepad button the gamepad button; Esc or B cancels. Buttons
the map or the menu already uses (A, B, X, Y, R3, the shoulder
buttons and triggers) and the keys Tab, Q, E, R, T, M, B, Esc, Space,
Enter and the arrow keys cannot be chosen. "Reset keys" brings back
the keys above. Your keys are kept after closing the game (in the same
New_CSV.csv file).
The gamepad buttons have not been tried on a real gamepad yet; please
report it if one does not respond.

The game already contains most of this feature; it was switched off. This
mod switches it back on, adds the bell / weapon / accessory / medicine
icons the game never drew, makes the icons readable when zoomed, and
fills in missing labels.
Not covered: books, and letters or pages that a quest or an NPC gives
you (they have no spot in the world).
Meigu Lake (梅谷湖): the game also draws the items of the Illusionist's Ruins
(幻術師遺跡) on this map, at the same spots as the lake area above them. The
ruins are a separate area, so at those spots on the surface there is
nothing. Since 1.3.2 hovering one of these icons says "Inside the
Illusionist's Ruins (a separate area, not on the surface)".

INSTALL
Easiest: extract the zip into the game's main folder, the one that holds
the "Engine" and "ProjectPBZ" folders (Steam > right-click the game >
Manage > Browse local files). Do NOT extract it next to PBZ.exe: that exe
sits in a different folder and the game will not see the mod there.

The three files must end up in
  <game folder>\ProjectPBZ\Content\Paks\~mods\
    PBZMapMarkers_P.pak
    PBZMapMarkers_P.utoc
    PBZMapMarkers_P.ucas
(create the ~mods folder if it does not exist). All three files are needed.
No UE4SS or other tools needed.

Updating from an older version: just overwrite the three files.

UNINSTALL
Delete the three PBZMapMarkers_P files.

COMPATIBILITY
- Works together with mods that replace the map script (UI/Widget/Map.js),
  such as Free Teleport: since 1.0.1 this mod no longer replaces that file,
  it adds its icons from a small UI script instead
  (UI/Widget/DebugLoadServerGame.js since 1.5.0, a developer-only screen
  other mods have no reason to change). Only a mod that replaces that same
  small script would conflict.
- Works together with Bigger Perfect Parry Effects (PBZParryFX) and
  Speaker Highlight. Each of them replaced the script this mod used before
  (up to 1.4.0 and 1.4.1 - 1.4.2), so no icons showed; fixed in 1.4.1 and
  1.5.0.
- Works together with Map Tracker Plus (fixed in 1.3.1: with it installed,
  1.2.0 - 1.3.0 showed no icons at all). Both mods then draw their own
  icons. H and Tab work through that mod's key handling.
- Safe to add or remove at any time; it changes nothing in your save.
- After a game update the icons may stop showing if the game changed its
  map script. The map itself keeps working.

CHANGES
1.6.1 - Fixed: a letter you already have could stay on the map when
        an NPC gave it to you (悲泣溪谷 / Weeping Valley). Letters and
        materials in a part of the level that the story has switched
        off are no longer shown in the region you are in.
1.6.0 - Gamepad: d-pad down hides / shows the icons, View / touchpad
        opens the filter panel, L3 tracks the icon under the cursor,
        d-pad up (keyboard: N) switches "Track the nearest item",
        and the d-pad (or the arrow keys) moves through the panel.
        New "Key:" rows in the panel to change the keys and buttons.
1.5.0 - Track an item: V on a map icon shows a marker with its name
        and distance in the world (V again stops). New "Track the
        nearest item" row in the filter panel (F).
        Fixed: with Speaker Highlight installed, the map showed no
        icons and F did nothing. This mod now uses a different game
        script, so both work together.
1.4.2 - New "Icon size" row in the filter panel (F): 100%, 80% or
        60%, kept after closing the game.
1.4.1 - Fixed: with Bigger Perfect Parry Effects (PBZParryFX)
        installed, the map showed no icons and F did nothing. This mod
        now uses a different game script, so both work together.
1.4.0 - New paper icons for letters and pages lying in the world,
        labelled with their title. They go away once picked up.
        New filter panel (F or the "Marker filter" button on the map):
        hide or show each kind of icon; the choice is kept after
        closing the game.
1.3.3 - 13 material spots in 血色森林 that only exist while the forest
        is snowed in (story) are shown only then. Before, they showed
        all the time and there was nothing at the spot.
1.3.2 - Icons of the Illusionist's Ruins on the Meigu Lake map say that
        they are inside the ruins (at that spot on the surface there is
        nothing).
1.3.1 - Fixed: with Map Tracker Plus installed, no icons showed at all
        (since 1.2.0). Both mods now work together.
1.3.0 - New cyan icons for breakables and chests that drop upgrade
        materials (weapon, accessory and medicine materials), labelled
        with the materials and amounts. Fixed: an item icon could show
        another item's picture and colour (mostly in the Fog versions,
        next to fog).
1.2.3 - Hovering an item now names the boss or NPC that gives it (about
        70 items), or says it comes from a Memory Flower.
1.2.2 - Tab on the map switches to the world map again (since 1.2.0 it
        only worked after clicking the "switch map" text).
1.2.0 - H on the map hides / shows this mod's icons (until the game is
        closed).
1.1.0 - New icons for bells you have not rung yet and for weapons, shadow
        weapons, accessories and medicines you have not picked up yet,
        labelled with the bell's / item's name. Hovering an item icon
        also says how the item is obtained (boss, enemy group, NPC,
        chest, ...).
1.0.1 - Works alongside Free Teleport and other mods that replace Map.js.
        Memory Flowers are blue. Fixed install instructions (extract into the
        folder with Engine and ProjectPBZ, not the one with PBZ.exe).
1.0.0 - First release.
