📄 docs: Add readmes

This commit is contained in:
Keith Solomon
2026-07-08 07:56:16 -05:00
parent eb03d54b3d
commit ae96a9bab4
2 changed files with 81 additions and 0 deletions
+36
View File
@@ -0,0 +1,36 @@
# Userscripts
Collection of personal browser userscripts.
## Table of Contents
- [Torn Training Tracker](Torn%20Training%20Tracker/README.md)
## Script Index
| Script | Folder | File | Script README | Description |
| --- | --- | --- | --- | --- |
| Torn Training Tracker | [Torn Training Tracker](Torn%20Training%20Tracker/) | [torn-training-tracker.js](Torn%20Training%20Tracker/torn-training-tracker.js) | [README](Torn%20Training%20Tracker/README.md) | Floating tracker panel for Torn gym training progress, including target tracking and ETA estimates. |
## Scripts
### Torn Training Tracker
- Folder: [Torn Training Tracker](Torn%20Training%20Tracker/)
- Script: [torn-training-tracker.js](Torn%20Training%20Tracker/torn-training-tracker.js)
- Script README: [Torn Training Tracker README](Torn%20Training%20Tracker/README.md)
Floating tracker panel for Torn gym training progress, including target tracking and ETA estimates.
## New Script Template
When you add a new userscript, update both sections below:
1. `Table of Contents` (add a link to the new script README).
2. `Script Index` (add one table row).
Copy this row template into `Script Index` and replace placeholders:
```md
| <Script Name> | [<Folder Name>](<Folder%20Name>/) | [<script-file.js>](<Folder%20Name>/<script-file.js>) | [README](<Folder%20Name>/README.md) | <Short one-line description> |
```
+45
View File
@@ -0,0 +1,45 @@
# Torn Training Tracker
Userscript for Torn gym training pages that adds a floating progress panel for your active attribute.
## Features
- Detects current training attribute on Torn gym page.
- Stores target values per attribute.
- Tracks training gains over time.
- Shows estimated trains remaining, days remaining, and ETA.
- Keeps local history and preferences in browser storage.
## Requirements
- A userscript manager such as Tampermonkey or Violentmonkey.
- Access to Torn gym pages matching:
- `https://www.torn.com/gym.php*`
## Installation
1. Open your userscript manager.
2. Create a new script.
3. Paste the contents of `torn-training-tracker.js`.
4. Save and enable the script.
## Usage
1. Open Torn gym at `https://www.torn.com/gym.php`.
2. Train normally.
3. Use the floating tracker panel to set your target for the current attribute.
4. Review projected trains, per-day pace, and ETA.
## Data Storage
This script stores data in `localStorage` with the following keys:
- `tat.targets`
- `tat.history`
- `tat.prefs`
Data remains local to your browser profile unless you export/sync browser storage externally.
## Version
Current userscript version in metadata: `0.1.0`.