MacTorn/wiki/Features.md
Paweł Orzech 715f0877ff
docs: Add comprehensive GitHub wiki documentation
Create wiki/ directory with 11 markdown pages covering:
- Home, Installation, Getting Started guides
- Features documentation for all tabs
- API Setup with permissions and security
- Configuration options and settings
- Troubleshooting and FAQ
- Development guide with architecture overview
- Changelog with version history
- Sidebar navigation
2026-01-20 13:24:55 +00:00

253 lines
5.2 KiB
Markdown

# Features
MacTorn offers a comprehensive set of features for monitoring your Torn status. This page details all available features organized by tab.
## Status Tab
The Status tab is your main dashboard showing vital information at a glance.
### Progress Bars
Real-time display of your four main stats with color-coded progress:
| Bar | Color | Description |
|-----|-------|-------------|
| **Energy** | Orange/Yellow | Your energy level and regeneration |
| **Nerve** | Red | Your nerve level |
| **Happy** | Pink | Your happiness level |
| **Life** | Blue | Your current health |
Each bar shows:
- Current value / Maximum value
- Visual progress indicator
- Fill color changes as bar approaches full
### Cooldown Timers
Live countdown timers for:
- **Drug Cooldown** - Time until you can use drugs again
- **Medical Cooldown** - Time until medical items are available
- **Booster Cooldown** - Time until boosters can be used
Timers count down in real-time and notify you when ready.
### Status Badges
Visual indicators for special states:
- **Hospital** - Red badge when hospitalized
- **Jail** - Gray badge when in jail
- **Messages** - Badge showing unread message count
### Chain Timer
When your faction has an active chain:
- Displays current chain count
- Shows timeout timer
- Warns when chain is about to expire
### Events Feed
Recent events scroll showing:
- Incoming attacks
- Messages received
- Money transfers
- Other significant events
### Quick Links
8 customizable quick-access buttons:
- Gym, Items, Properties
- Missions, Crimes, Jail
- Hospital, Casino
## Travel Tab
Comprehensive travel management with live tracking.
### Travel Status
Three possible states displayed:
**In Torn City**
- Home icon with "Ready to travel" message
- Access to destination picker
**Flying**
- Live countdown timer updating every second
- Destination with country flag
- Progress bar showing flight completion
- Menu bar displays: ✈️🇬🇧 5:32 (airplane + flag + time)
**Abroad**
- Globe icon showing current location
- "Return to Torn" button for quick return
### Destination Picker
Quick travel buttons for all 11 Torn destinations:
| Destination | Flag | Flight Time |
|-------------|------|-------------|
| Mexico | 🇲🇽 | ~26 min |
| Cayman Islands | 🇰🇾 | ~35 min |
| Canada | 🇨🇦 | ~41 min |
| Hawaii | 🇺🇸 | ~2h 14m |
| United Kingdom | 🇬🇧 | ~2h 31m |
| Argentina | 🇦🇷 | ~2h 45m |
| Switzerland | 🇨🇭 | ~2h 50m |
| Japan | 🇯🇵 | ~3h 30m |
| China | 🇨🇳 | ~3h 52m |
| UAE | 🇦🇪 | ~4h 22m |
| South Africa | 🇿🇦 | ~4h 45m |
Click any destination to open Torn's travel agency with that destination selected.
### Pre-Arrival Alerts
Configurable notifications before landing:
- **2 minutes** before arrival
- **1 minute** before arrival
- **30 seconds** before arrival
- **10 seconds** before arrival
Enable/disable each interval independently.
## Money Tab
Financial overview and quick actions.
### Balance Display
- **Cash on Hand** - Your pocket money
- **Vault** - Bank vault balance
- **Points** - Current points
- **Tokens** - Job tokens
### Quick Actions
- **Send Money** - Opens money transfer page
- **Bazaar** - Opens your bazaar
- **Bank** - Opens Torn bank
## Attacks Tab
Combat statistics and history.
### Battle Stats
Your four battle statistics:
- **Strength**
- **Defense**
- **Speed**
- **Dexterity**
### Recent Attacks
List of recent attack results showing:
- Target name
- Win/Loss outcome
- Timestamp
### Quick Actions
- **Attack** - Opens attack page
- **Hospital** - Opens hospital list
- **Bounties** - Opens bounty list
## Faction Tab
Faction information and utilities.
### Faction Info
- Faction name and ID
- Your position/rank
- Member count
### Chain Status
When chain is active:
- Current chain count
- Time to timeout
- Visual warning when expiring
### War Status
If faction is at war:
- War opponent
- War score
- Territory control
### Armory Quick-Use
Buttons for common armory items (if available).
## Watchlist Tab
Track item market prices in real-time using Torn API v2.
### Price Tracking
For each watched item shows:
- Item name with market link
- **Lowest price** on Item Market
- **Quantity** at lowest price (e.g., "$4.2M x12")
- Price change indicator (if price increased)
### Adding Items
Click the **+** button to add items from a preset list:
- Xanax
- FHC (Feathery Hotel Coupon)
- Donator Pack
- Drug Pack
- Energy Drink
- First Aid Kit
### Market Links
Quick access to:
- Item Market
- Points Market
## Settings Tab
Configure MacTorn to your preferences.
### API Key Management
- Secure input field for API key
- "Save & Connect" to apply key
- Link to generate new key on Torn
### Refresh Interval
Choose polling frequency:
- 15 seconds
- 30 seconds (default)
- 60 seconds
- 2 minutes
### Appearance
- **System** - Follow macOS appearance
- **Light** - Always light mode
- **Dark** - Always dark mode
### Accessibility
- **Reduce Transparency** - Use solid backgrounds for better readability
### Launch at Login
Toggle to start MacTorn automatically when you log into your Mac.
### Update Notifications
When a new version is available:
- Version number displayed
- "Download Update" button links to GitHub releases
---
**Next:** [[Configuration]] - Detailed configuration options