SamisFishTracker/README.bbcode at main · samleegray/SamisFishTracker · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
[size=6][b]SamisFishTracker[/b][/size]

An Elder Scrolls Online addon that tracks your fish inventory with optional Perfect Roe estimation and fillet stats.

[size=5][b]Features[/b][/size]

[list]
[*][b]Fish Counter[/b] - Tracks the number of fish you catch during your session
[*][b]Inventory Display[/b] - Shows fish count in your bag and bank
[*][b]Perfect Roe Estimation[/b] - Calculates expected Perfect Roe using a configurable fillet rate (optional)
[*][b]Fillet Stats[/b] - Tracks fillets since last roe and observed roe rate
[*][b]Average Fish Per Hour[/b] - Shows live fish/hour for your current session
[*][b]Auto-Hide Mode[/b] - Optionally show the tracker only when looking at fishing holes
[*][b]Movable Window[/b] - Drag to reposition; position is saved between sessions
[*][b]Settings Panel[/b] - Configure visibility mode, roe tracking, roe rate, Average Fish Per Hour toggle, and actions in Settings > Addons > Sami's Fish Tracker
[*][b]Account-Wide Saved Variables[/b] - Your settings persist across characters
[/list]

[size=5][b]Settings[/b][/size]

[size=4][b]Display[/b][/size]
[list]
[*][b]Visibility Mode[/b] - Always Show, Always Hide, or Auto (Fishing Nodes)
[*][b]Show Average Fish Per Hour[/b] - Toggle the Avg/hr line on or off (default: on)
[/list]

[size=4][b]Roe Estimation[/b][/size]
[list]
[*][b]Enable Roe Tracking[/b] - Toggle roe estimation and fillet stats UI (default: on)
[*][b]Roe Rate Slider[/b] - Adjustable from 0.0001 to 0.1 (default: 0.008)
[/list]

[size=4][b]Average Fish Per Hour[/b][/size]
[list]
[*][b]Auto Update Avg/hr[/b] - Automatically refresh the value over time (default: on)
[*][b]Avg/hr Update Frequency[/b] - Refresh interval from 1-60 seconds (default: 1 second)
[*][b]Use Rolling Window for Avg/hr[/b] - Toggle between rolling-window (stable) and session-lifetime (volatile) calculation (default: on)
[*][b]Rolling Window Duration[/b] - Time window for rolling average, 0.5-60 minutes (default: 5 minutes)
[/list]

[size=4][b]Actions[/b][/size]
[list]
[*][b]Reset Session Fish Count[/b] - Resets fish count and clears Avg/hr history
[*][b]Reset Roe/Fillet Tracking[/b] - Resets fillet and roe tracking counters
[*][b]Use Last Roe % as Roe Rate[/b] - Sets Roe Rate to the last observed roe percentage
[/list]

[size=5][b]Commands[/b][/size]

[table]
[tr][th]Command[/th][th]Description[/th][/tr]
[tr][td]/sft[/td][td]Toggle window visibility[/td][/tr]
[tr][td]/sft show[/td][td]Always show window[/td][/tr]
[tr][td]/sft hide[/td][td]Always hide window[/td][/tr]
[tr][td]/sft auto[/td][td]Show only when targeting a fishing hole[/td][/tr]
[tr][td]/sft reset[/td][td]Reset fish count to 0 and restart session Avg/hr timing[/td][/tr]
[/table]

[size=5][b]Dependencies[/b][/size]

[list]
[*][b]LibAddonMenu-2.0[/b] - Required for settings menu
[/list]

[size=5][b]Optional Dependencies[/b][/size]

[list]
[*][b]LibSlashCommander[/b] - Provides enhanced slash command support with auto-complete
[/list]

[size=5][b]License[/b][/size]

MIT License