﻿=====================================================================
  LATTICE  v1.1
  Live Stats for PlanetSide 2
=====================================================================

Unofficial fan tool. Not affiliated with or endorsed by Daybreak Game
Company. PlanetSide 2 and the faction emblems are trademarks of Daybreak
Game Company.

Deutsche Version: LIESMICH.txt


CONTENTS
--------
  1. What is LATTICE?
  2. Requirements
  3. Getting a Service ID (important!)
  4. Installation and first start
  5. Using the dashboard
  5a. Customising the layout
  6. Sounds
  7. Crosshair overlay
  8. Autostart with PlanetSide 2
  9. Portrait monitor / second screen
 10. Where is my data stored?
 11. Troubleshooting
 12. New in version 1.1
 13. License


1. WHAT IS LATTICE?
-------------------
A dashboard that counts your kills, deaths and much more live while you
play PlanetSide 2. It runs entirely in your browser, nothing to install.

  - Live stats: kills, deaths, K/D, headshot rate, killstreak, kills per
    minute, revives, vehicles destroyed, XP
  - Killfeed with enemy names, weapons and vehicles
  - Breakdown by faction, class, weapon, opponent (incl. nemesis) and
    vehicle
  - Kills per life chart
  - History: every session is saved, with a daily overview and charts
    for 7, 30, 90 days or all time
  - Sounds for multi kills, killstreaks, revenge etc. (your own files)
  - Crosshair editor with an overlay for Windows
  - Your own layout: move, resize and hide panels – saved separately
    for portrait and landscape
  - Starts automatically with PlanetSide 2 if you want
  - German and English


2. REQUIREMENTS
---------------
  - Windows 10 or 11 (for crosshair and autostart; the dashboard itself
    runs in any current browser)
  - A current browser: Chrome, Edge or Firefox
  - A PlanetSide 2 character
  - Your own free Service ID from Daybreak (see section 3)


3. GETTING A SERVICE ID (IMPORTANT!)
------------------------------------
The dashboard reads game data from Daybreak's official Census API. For
that you need a Service ID. It is free.

  Sign up:  https://census.daybreakgames.com/#devSignup
  (if the link does not jump there directly, open
   https://census.daybreakgames.com/ and choose "Sign up for a Service ID")

  - You can pick any name for the ID. Lowercase letters and numbers
    only, no spaces, e.g. "ps2trackermax".
  - You enter your e-mail address and receive the ID by mail.
  - Activation can take a few hours up to several days.
  - Until then the dashboard works with "s:example". It is heavily
    rate-limited though, so enemy and weapon names load slowly.

  Everyone please use their own ID! Do not share your ID and do not
  show it in screenshots or streams. If an ID is abused, Daybreak may
  throttle or block it.


4. INSTALLATION AND FIRST START
-------------------------------
  1. Before extracting: right-click the ZIP file > Properties > tick
     "Unblock" at the bottom > OK. Otherwise Windows will later block
     the crosshair and autostart scripts.
  2. Extract the ZIP, e.g. to  Desktop\LATTICE
     (not to "C:\Program Files", which is not writable).
  3. Double-click "lattice.html". The dashboard opens in your
     browser.
  4. Enter your character name and Service ID. The dashboard adds the
     "s:" prefix itself. Leave the event stream on "Daybreak official".
  5. Click "Connect".

  The top right then shows "LIVE · DAYBREAK" in green. The timer starts
  as soon as your character is online in game.

  To try it without playing, click "View demo".


5. USING THE DASHBOARD
----------------------
  "Session" tab     Live stats of your current play session.
  "History" tab     All saved sessions with a daily overview.
  "Crosshair" tab   Design your crosshair (see section 7).
  "Sounds" tab      Assign and preview sounds, volume (section 6).

  - A session starts automatically when you log in to the game and is
    saved to the history automatically when you log out.
  - "End session" saves immediately and starts a new session.
  - "Discard" resets the session without saving.
  - "Settings" > enter another character or a new Service ID.
  - DE | EN switches the language, "♪ Sound" mutes or unmutes all
    sounds.
  - A short intro plays at startup. A click starts it with sound, a key
    or another click skips it.


5a. CUSTOMISING THE LAYOUT
--------------------------
  In the "Session" tab click "Layout" at the top right. Then:

  - Drag panels and tiles to another position with the mouse, or move
    them earlier or later with ◀ ▶.
  - ↔− / ↔+  makes a panel narrower or wider (12-column grid),
    ↕− / ↕+  shorter or taller. The size is shown next to it, e.g. "6×10".
  - ✕ hides a panel or tile. Hidden items are listed in the bar at the
    top and can be brought back with "+".
  - "Preset": "Standard" or "Compact" (numbers, kills per life and
    killfeed only – good for small screens or OBS).
  - "Reset" restores the standard layout.
  - "Done" leaves edit mode.

  The layout is saved separately for portrait and landscape. If you
  rotate your monitor or switch windows, you automatically get the
  matching arrangement.


6. SOUNDS
---------
The package contains no sound files. You can put your own sounds in .ogg
format into the "sounds" folder. The file names the dashboard expects
are listed in  sounds\README.txt.

  - Triggers include: first blood, double to ludicrous kill (kills
    within 5 seconds), killstreaks (5, 10, 15, 20, 25, every 10 from 30
    on), headshot streaks, revenge, domination, knife, pistol, shotgun
    and grenade kills, roadkills, aircraft shot down, revive streaks,
    death streaks, teamkills and session start and end.
  - In the "Sounds" tab you can switch each event on or off, assign a
    different sound and preview it with ▶.
  - Browsers only play audio after you have clicked on the page once.
    If "Click to enable sounds" appears at the bottom, just click
    anywhere on the page.
  - Weapon sounds (knife, pistol etc.) work from the second kill with a
    new weapon, because the weapon type has to be loaded first.


7. CROSSHAIR OVERLAY
--------------------
  1. Design your crosshair in the "Crosshair" tab.
  2. Click "Save for overlay" and save the file "crosshair.png" into the
     LATTICE folder. From then on the browser saves there
     automatically.
  3. Double-click "crosshair-overlay.bat". The crosshair appears in the
     centre of your main screen.

  - Ctrl + Alt + C  shows and hides it.
  - To close it: run the .bat again, or right-click the icon at the
    bottom right of the taskbar > "Beenden" (Exit).
  - Changes in the editor show up as soon as you save.
  - PlanetSide 2 must run in "Borderless window" mode. No overlay can
    be drawn over exclusive fullscreen.
  - The overlay is just a transparent window on top of the game. It
    does not read anything from the game and does not interfere with
    it. There is no official approval from Daybreak; use at your own
    risk.
  - The overlay's tray menu and messages are in German.


8. AUTOSTART WITH PLANETSIDE 2
------------------------------
  Double-click "Autostart einrichten.bat" (= set up autostart). From
  then on the dashboard and the crosshair open automatically as soon as
  PlanetSide 2 is running. When you quit the game, the crosshair closes
  again. The autostart also starts by itself after every Windows
  restart.

  - Dashboard only, no crosshair: open "ps2-autostart.ps1" in a text
    editor, set  $StartCrosshair = $false  at the top and run
    "Autostart einrichten.bat" again.
  - To remove it: double-click "Autostart entfernen.bat"
    (= remove autostart).


9. PORTRAIT MONITOR / SECOND SCREEN
-----------------------------------
The dashboard adapts. On a portrait monitor (e.g. 1080 x 1920)
everything fits on the screen without scrolling.
Tip: press F11 in the browser for fullscreen.

For OBS: "lattice.html?overlay=1" as a browser source shows a
compact view with a transparent background.


10. WHERE IS MY DATA STORED?
----------------------------
Everything stays on your PC, in your browser's storage. The only online
connections are to Daybreak (game data), to Nanite Systems if you choose
the alternative stream, and to Google Fonts (typefaces).

  Note: if you clear your browser's site data, your history is gone
  too. Back it up now and then with "Export" in the "History" tab.
  "Import" brings it back, also on another PC.


11. TROUBLESHOOTING
-------------------
  "Connection lost" in red
    > Check your Service ID (typo?). Try the other event stream under
      Settings. If your ID is not active yet, use "s:example" for now.

  "Character not found"
    > Check the spelling. The name must be written exactly as in game.

  Crosshair or autostart does not start / Windows warns
    > See installation, step 1 ("Unblock"). Alternatively: right-click
      the .ps1 file > Properties > "Unblock".

  Crosshair not visible in game
    > Set PlanetSide 2 to "Borderless window".

  No sounds
    > Are there .ogg files in the "sounds" folder? Is "♪ Sound on"
      active? Click on the page once. Then press F5.

  Timer shows --:--:--
    > That is correct while your character is offline.


12. NEW IN VERSION 1.1
----------------------
  - New name: "PS2 Tracker" becomes LATTICE, with a new logo and an
    animated intro
  - Layout editor (see 5a)
  - The dashboard file is now called lattice.html

  Updating from 1.0: copy the new files over the old ones and run
  "Autostart einrichten.bat" once if you use the autostart. History and
  settings are kept in Chrome and Edge. In Firefox, export your history
  first and import it again afterwards.


13. LICENSE
-----------
MIT License, see LICENSE.txt. The faction emblems in the "emblems"
folder are trademarks of Daybreak Game Company and are not covered by
the MIT License.
