Updated README.md
This commit is contained in:
parent
6c646719dd
commit
fbb6f61705
1 changed files with 40 additions and 1 deletions
39
README.md
39
README.md
|
|
@ -37,6 +37,16 @@ This project provides:
|
|||
- Filter by character, equipment type, material, stats, and more
|
||||
- Sort by any column with live results
|
||||
- Track item properties including spells, armor level, damage ratings
|
||||
- **Suitbuilder**:
|
||||
- Equipment optimization across multiple character inventories
|
||||
- Constraint-based search for optimal armor combinations
|
||||
- Support for primary and secondary armor sets
|
||||
- Real-time streaming results during long-running searches
|
||||
- **Portal Tracking**:
|
||||
- Automatic discovery and tracking of in-game portals
|
||||
- 1-hour retention for discovered portals
|
||||
- Coordinate-based uniqueness (rounded to 0.1 precision)
|
||||
- Real-time portal updates on the map interface
|
||||
- **Discord Rare Monitor Bot**: Monitors rare discoveries and posts filtered notifications to Discord channels
|
||||
- **Sample Data Generator**: `generate_data.py` sends telemetry snapshots over WebSocket for testing.
|
||||
|
||||
|
|
@ -82,6 +92,27 @@ Python packages (if using local virtualenv):
|
|||
|
||||
## Usage
|
||||
|
||||
### Using Docker (Recommended)
|
||||
|
||||
1. Build and start all services:
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
2. Rebuild container after code changes:
|
||||
```bash
|
||||
docker compose build --no-cache dereth-tracker
|
||||
docker compose up -d dereth-tracker
|
||||
```
|
||||
|
||||
3. View logs:
|
||||
```bash
|
||||
docker logs mosswartoverlord-dereth-tracker-1
|
||||
docker logs dereth-db
|
||||
```
|
||||
|
||||
### Without Docker
|
||||
|
||||
Start the server using Uvicorn:
|
||||
|
||||
```bash
|
||||
|
|
@ -310,6 +341,14 @@ aggregate character statistics, and a separate inventory database for equipment
|
|||
- `timestamp` (timestamptz)
|
||||
- `ew`, `ns`, `z` (float)
|
||||
|
||||
- **portals**:
|
||||
- `id` (PK, serial)
|
||||
- `portal_name` (text)
|
||||
- `ns`, `ew`, `z` (float coordinates)
|
||||
- `discovered_at` (timestamptz, indexed)
|
||||
- `discovered_by` (text)
|
||||
- Unique constraint: `ROUND(ns::numeric, 1), ROUND(ew::numeric, 1)`
|
||||
|
||||
### Inventory Database Tables:
|
||||
|
||||
- **items**:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue