docs: rewrite README to reflect current plugin features
Full rewrite covering: - VitalSharingTracker + DxHud overlay (cross-machine vital sharing replacing UB's localhost-only VTankFellowHeals) - CombatStatsTracker (~50 Mag-Tools regex patterns, per-element breakdown, session/lifetime split) - LiveInventoryTracker (OnCreate/OnChange/OnRelease → inventory_delta) - Full event stream catalog (telemetry, vitals, character_stats, combat_stats, share_*, nearby_objects, dungeon_map, quest, rare, etc.) - DECAL STA threading rules (WinForms.Timer not Timers.Timer) - Hot reload path - Per-character YAML config structure - In-game /mm commands (including new radar + vitalsharing toggles) - Complete project structure - Cross-repo contract guidance Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Erik
parent
0b1abf69f9
commit
2213abf475
1 changed files with 270 additions and 164 deletions
434
README.md
434
README.md
|
|
@ -1,220 +1,326 @@
|
||||||
# MosswartMassacre - Advanced DECAL Plugin for Asheron's Call
|
# MosswartMassacre — DECAL Plugin for Asheron's Call
|
||||||
|
|
||||||
> **Status**: Production Ready | VVS Direct Integration | Navigation Visualization Complete
|
> **Status**: Production · In-game companion plugin for the [Mosswart Overlord](https://github.com/SawatoMosswartsEnjoyersClub/MosswartOverlord) backend
|
||||||
|
|
||||||
A comprehensive DECAL plugin for Asheron's Call that tracks monster kills, rare item discoveries, and provides advanced navigation route visualization with 3D rendering.
|
A comprehensive DECAL plugin for Asheron's Call that streams live telemetry, vitals, inventory, combat, chat, and rare discoveries to a backend server via WebSocket. Pairs with the Mosswart Overlord web dashboard for real-time multi-account tracking, analytics, and cross-machine utilities.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📋 Table of Contents
|
||||||
|
- [Features](#-features)
|
||||||
|
- [Architecture](#️-architecture)
|
||||||
|
- [Installation](#-installation)
|
||||||
|
- [Configuration](#-configuration)
|
||||||
|
- [In-Game Commands](#-in-game-commands)
|
||||||
|
- [Event Streams](#-event-streams)
|
||||||
|
- [Cross-Machine Vital Sharing](#-cross-machine-vital-sharing)
|
||||||
|
- [Building](#️-building)
|
||||||
|
- [Technical Details](#-technical-details)
|
||||||
|
- [Project Structure](#-project-structure)
|
||||||
|
- [Contributing](#-contributing)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## 🚀 Features
|
## 🚀 Features
|
||||||
|
|
||||||
### Core Functionality
|
### Core Tracking
|
||||||
- **Kill Tracking**: Real-time monster kill counting with rate calculations (kills/5min, kills/hour)
|
- **Telemetry**: Position, kills, kills/hour, online time, VTank state, memory/CPU stats — streamed every 2 seconds
|
||||||
- **Rare Item Discovery**: Automatic rare detection and counter with optional meta state control
|
- **Vitals**: Health / Stamina / Mana / Vitae percentages, updated continuously
|
||||||
- **Statistics Dashboard**: Detailed session statistics with best hourly performance tracking
|
- **Character Stats**: Full attributes, skills, allegiance, augmentations — sent every 10 minutes
|
||||||
- **Multi-System Integration**: WebSocket streaming, HTTP command server, and telemetry support
|
- **Chat**: All chat lines forwarded with color preservation (supports server-side filtering by channel)
|
||||||
|
- **Rare Discoveries**: Automatic detection + classification (common vs great rares)
|
||||||
|
- **Quest Timers**: Progress tracking with countdown/ready state
|
||||||
|
|
||||||
### 🗺️ Navigation Visualization
|
### Inventory
|
||||||
**Advanced VTank route visualization with 3D rendering capabilities**
|
- **Full Inventory Dump**: Complete snapshot on login via `full_inventory`
|
||||||
- **3D Route Display**: Renders VTank .nav files as red lines in the game world
|
- **Live Deltas**: `inventory_delta` events for add/update/remove on `OnCreate`, `OnChange`, `OnRelease`
|
||||||
- **Route Comparison**: Side-by-side visualization with UtilityBelt's active navigation
|
- **ID Requests**: Auto-requests appraisal for items needing spell/combat data
|
||||||
- **Full Format Support**: All VTank nav types (Circular, Linear, Target, Once) and waypoint types
|
- **Rich Metadata**: Spells, materials, tinkers, workmanship, mana charge, imbues, spellcraft
|
||||||
- **Auto-Discovery**: Automatically detects VTank installation and scans for .nav files
|
|
||||||
- **Performance Optimized**: Smart rendering limits and memory management
|
|
||||||
|
|
||||||
### 🎛️ User Interface
|
### Combat Stats (Mag-Tools Style)
|
||||||
**Modern tabbed interface using direct VirindiViewService integration**
|
- **CombatStatsTracker**: Parses ~50 chat regex patterns matching Mag-Tools combat output
|
||||||
- **Main Tab**: Live kill stats, rare counts, elapsed time, and status indicators
|
- **Per-element Breakdown**: Damage offense/defense split by slashing/piercing/bludgeoning/fire/cold/acid/lightning
|
||||||
- **Settings Tab**: Plugin configuration with real-time updates
|
- **Monster Records**: Per-monster damage given/received/kill count
|
||||||
- **Statistics Tab**: Enhanced analytics and session management
|
- **Aetheria Surge Tracking**: Counts surge triggers
|
||||||
- **Navigation Tab**: Route selection, visualization controls, and status display
|
- **Session Deltas**: Sends session snapshot every 10s; backend accumulates lifetime
|
||||||
|
|
||||||
|
### Cross-Machine Vital Sharing (VTankFellowHeals Replacement)
|
||||||
|
- Broadcasts own vitals + debuff state via WebSocket at 150ms intervals
|
||||||
|
- Receives peer vitals and feeds them into `UBHelper.vTank.Instance`, making fellow members visible to VTank's heal logic across different machines (vs UB's localhost-only default)
|
||||||
|
- **DxHud Overlay**: In-game UB-style vital bars with direction arrows, Ctrl+drag repositioning
|
||||||
|
|
||||||
|
### Nearby Objects / Radar
|
||||||
|
- On-demand broadcast of nearby monsters, players, NPCs, containers
|
||||||
|
- Dungeon tile data for the browser's radar overlay
|
||||||
|
- Range + entity-type filters configurable from backend command
|
||||||
|
|
||||||
|
### Navigation Visualization
|
||||||
|
- Parses VTank `.nav` files (Circular, Linear, Target, Once; Point/Portal/Recall/Pause/ChatCommand/OpenVendor/UseNPC/Checkpoint/Jump waypoints)
|
||||||
|
- Renders routes as red lines in the 3D game world
|
||||||
|
- Side-by-side comparison with UtilityBelt's active navigation
|
||||||
|
- Performance-capped at 500 rendered segments
|
||||||
|
|
||||||
|
### Remote Command Execution
|
||||||
|
- Backend can send `{player_name, command}` envelopes via the `/ws/live` route → plugin executes in-game
|
||||||
|
- Supports `/radar`, `/mm` subcommands, chat sends, and any `/` command that VTank/game accepts
|
||||||
|
|
||||||
|
### Death & Idle Detection (backend-assisted)
|
||||||
|
- Plugin reports vitals; backend detects vitae 0→>0 transitions (death) and continuous idle state (5-min grace period) and posts to Discord
|
||||||
|
|
||||||
|
### Rare Meta Auto-State
|
||||||
|
- Optional: toggles VTank meta state on rare detection (e.g., to auto-loot or pause)
|
||||||
|
|
||||||
|
## 🏗️ Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────┐
|
||||||
|
│ Asheron's Call client │
|
||||||
|
│ ┌────────────────────────────────────────────┐ │
|
||||||
|
│ │ DECAL │ │
|
||||||
|
│ │ ┌──────────────────────────────────────┐ │ │
|
||||||
|
│ │ │ MosswartMassacre.dll │ │ │
|
||||||
|
│ │ │ │ │ │
|
||||||
|
│ │ │ • PluginCore — lifecycle + wiring │ │ │
|
||||||
|
│ │ │ • WebSocket client │ │ │
|
||||||
|
│ │ │ • KillTracker / CombatStatsTracker │ │ │
|
||||||
|
│ │ │ • LiveInventoryTracker │ │ │
|
||||||
|
│ │ │ • VitalSharingTracker │ │ │
|
||||||
|
│ │ │ • VitalSharingOverlayView (DxHud) │ │ │
|
||||||
|
│ │ │ • NavVisualization │ │ │
|
||||||
|
│ │ │ • VVSTabbedMainView (UI) │ │ │
|
||||||
|
│ │ └──────────────────┬───────────────────┘ │ │
|
||||||
|
│ └─────────────────────│────────────────────── │
|
||||||
|
└─────────────────────────│─────────────────────┘
|
||||||
|
│ wss://
|
||||||
|
▼
|
||||||
|
overlord.snakedesert.se/ws/position
|
||||||
|
(Mosswart Overlord backend)
|
||||||
|
```
|
||||||
|
|
||||||
|
DECAL COM objects are **apartment-threaded (STA)** — the plugin carefully uses `System.Windows.Forms.Timer` (never `System.Timers.Timer`) for any periodic work touching the game API, and hooks `EchoFilter.ServerDispatch` early enough to catch pre-login events.
|
||||||
|
|
||||||
## 📥 Installation
|
## 📥 Installation
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Windows with .NET Framework 4.8
|
- Windows with .NET Framework 4.8
|
||||||
- Asheron's Call with DECAL Adapter installed
|
- Asheron's Call client with DECAL Adapter installed
|
||||||
- VirindiViewService (included in lib/ folder)
|
- VirindiViewService (included in `lib/`)
|
||||||
|
|
||||||
### Quick Setup
|
### Quick Setup
|
||||||
1. Download the latest release from the releases page
|
1. Build (or grab the release DLL): see [Building](#️-building)
|
||||||
2. Extract to your DECAL plugins directory
|
2. Copy `MosswartMassacre.dll` to `C:\Games\Decal Plugins\MosswartMassacre\`
|
||||||
3. Restart DECAL and enable the plugin
|
3. Restart DECAL and enable the plugin under *Plugins → MosswartMassacre*
|
||||||
4. Configure settings through the in-game UI
|
4. Configure settings through the tabbed in-game UI
|
||||||
|
|
||||||
### Building from Source
|
### Building from Source
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Clone the repository
|
# From repo root
|
||||||
git clone [repository-url]
|
dotnet build mossy.sln -c Release -v minimal
|
||||||
cd MosswartMassacre
|
|
||||||
|
|
||||||
# Restore packages and build
|
|
||||||
nuget restore packages.config
|
|
||||||
msbuild MosswartMassacre.csproj /p:Configuration=Release /p:Platform=AnyCPU
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🎮 Usage
|
Output DLL: `MosswartMassacre\MosswartMassacre\bin\Release\MosswartMassacre.dll`
|
||||||
|
|
||||||
### Basic Commands
|
## ⚙️ Configuration
|
||||||
Access all features through the `/mm` command interface:
|
|
||||||
|
|
||||||
```
|
Settings are stored per-character in YAML at `<PluginDir>\<CharacterName>.yaml`:
|
||||||
/mm help - Show available commands
|
|
||||||
/mm report - Display current kill statistics
|
|
||||||
/mm loc - Show current map coordinates
|
|
||||||
/mm reset - Reset kill counters and timers
|
|
||||||
/mm meta - Toggle automatic rare meta state
|
|
||||||
/mm http <on/off> - Control HTTP command server (port 8085)
|
|
||||||
/mm telemetry <on/off> - Control telemetry streaming
|
|
||||||
```
|
|
||||||
|
|
||||||
### Navigation Visualization
|
|
||||||
1. **Enable**: Check "Enable Navigation Visualization" in Navigation tab
|
|
||||||
2. **Configure**: Set VTank profiles path in Settings (auto-detected)
|
|
||||||
3. **Select Route**: Choose from dropdown and click "Load Route"
|
|
||||||
4. **View**: Red route lines appear in 3D game world
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
Settings are stored per-character in YAML format at `<PluginDir>/<CharacterName>.yaml`:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
rare_meta_enabled: true
|
# Core
|
||||||
remote_commands_enabled: false
|
|
||||||
http_server_enabled: false
|
|
||||||
websocket_enabled: true
|
websocket_enabled: true
|
||||||
telemetry_enabled: false
|
telemetry_enabled: true
|
||||||
char_tag: "default"
|
char_tag: "default"
|
||||||
|
rare_meta_enabled: true
|
||||||
|
remote_commands_enabled: true
|
||||||
|
http_server_enabled: false
|
||||||
|
|
||||||
|
# Vital Sharing
|
||||||
|
vital_sharing_enabled: true
|
||||||
|
vital_sharing_overlay_x: 100
|
||||||
|
vital_sharing_overlay_y: 200
|
||||||
|
|
||||||
|
# Navigation
|
||||||
vtank_profiles_path: "C:\\Games\\VirindiPlugins\\VirindiTank\\"
|
vtank_profiles_path: "C:\\Games\\VirindiPlugins\\VirindiTank\\"
|
||||||
|
|
||||||
|
# UI
|
||||||
main_window_x: 100
|
main_window_x: 100
|
||||||
main_window_y: 100
|
main_window_y: 100
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🏗️ Architecture
|
### Backend endpoint
|
||||||
|
|
||||||
### Core Components
|
The WebSocket URL is set in `WebSocket.cs`. Shared-secret auth is sent as a query string parameter.
|
||||||
- **PluginCore.cs**: Main entry point and event coordination
|
|
||||||
- **PluginSettings.cs**: YAML-based per-character configuration
|
|
||||||
- **Views/VVSTabbedMainView.cs**: Main tabbed UI with direct VVS integration
|
|
||||||
- **Views/VVSBaseView.cs**: Base class for VVS-based views
|
|
||||||
|
|
||||||
### Navigation System
|
## 🎮 In-Game Commands
|
||||||
- **NavRoute.cs**: VTank .nav file parser and 3D renderer
|
|
||||||
- **NavVisualization.cs**: Route management and file discovery
|
|
||||||
- **Registry Integration**: Automatic VTank directory detection
|
|
||||||
|
|
||||||
### Communication Systems
|
Access plugin commands via `/mm`:
|
||||||
- **WebSocket.cs**: Real-time data streaming to external services
|
|
||||||
- **HttpCommandServer.cs**: Local HTTP API for remote control
|
|
||||||
- **Telemetry.cs**: Periodic statistics reporting
|
|
||||||
|
|
||||||
### Game Integration
|
```
|
||||||
- **VtankControl.cs**: vTank automation interface
|
/mm help — show all commands
|
||||||
- **MossyInventory.cs**: Inventory monitoring and rare detection
|
/mm report — current kill stats
|
||||||
- **Utils.cs**: Game coordinate systems and utility functions
|
/mm loc — current map coordinates
|
||||||
|
/mm reset — reset counters/timers
|
||||||
|
/mm meta — toggle auto rare meta state
|
||||||
|
/mm start_radar — start broadcasting nearby objects
|
||||||
|
/mm stop_radar — stop radar broadcasts
|
||||||
|
/mm http <on|off> — toggle local HTTP command server (port 8085)
|
||||||
|
/mm telemetry <on|off> — toggle telemetry streaming
|
||||||
|
/mm vitalsharing <on|off> — toggle cross-machine vital sharing
|
||||||
|
/mm combat <show|reset> — combat stats session control
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📡 Event Streams
|
||||||
|
|
||||||
|
All events are JSON frames over a single `/ws/position` WebSocket connection. Type discriminator is the `type` field.
|
||||||
|
|
||||||
|
| Event | Frequency | Purpose |
|
||||||
|
|---|---|---|
|
||||||
|
| `telemetry` | 2s | Position, kill count, session metrics |
|
||||||
|
| `vitals` | 150ms (on change) | HP / Stam / Mana / Vitae |
|
||||||
|
| `character_stats` | 10 min | Full attributes/skills |
|
||||||
|
| `full_inventory` | login | Complete inventory snapshot |
|
||||||
|
| `inventory_delta` | on item add/change/remove | Incremental per-item update |
|
||||||
|
| `equipment_cantrip_state` | on equip change | Current equipped spell effects |
|
||||||
|
| `combat_stats` | 10s | Mag-Tools-style combat deltas |
|
||||||
|
| `chat` | on line | Any chat message |
|
||||||
|
| `rare` | on discovery | Rare item find |
|
||||||
|
| `spawn` | on spawn observation | Monster appeared nearby |
|
||||||
|
| `portal` | on discovery | Portal with coordinates |
|
||||||
|
| `quest` | on update | Quest timer/progress |
|
||||||
|
| `nearby_objects` | on radar command | Entities within range |
|
||||||
|
| `share_vitals` / `share_debuffs` / `share_cast` | continuous | Cross-machine vital sharing |
|
||||||
|
| `dungeon_map` | on dungeon entry | Floor tile data |
|
||||||
|
|
||||||
|
See backend `EVENT_FORMATS.json` for exact schemas.
|
||||||
|
|
||||||
|
## 🩺 Cross-Machine Vital Sharing
|
||||||
|
|
||||||
|
Default UtilityBelt `VTankFellowHeals` only works across characters on the **same machine** (IPC-based). This plugin replaces it with a WebSocket relay through the backend, enabling multi-box setups across multiple machines.
|
||||||
|
|
||||||
|
### How it works
|
||||||
|
|
||||||
|
1. Each plugin instance publishes its own `vitals` / cast state via WebSocket at 150ms intervals
|
||||||
|
2. The backend relays `share_*` envelopes to every subscribed plugin
|
||||||
|
3. `VitalSharingTracker` feeds peer data into `UBHelper.vTank.Instance` — VTank then behaves as if the peers are on the same machine
|
||||||
|
4. Hooks packet `0xF7B1` and `0x004A` for cast-attempt detection, plus chat regex for cast success
|
||||||
|
|
||||||
|
### DxHud Overlay
|
||||||
|
|
||||||
|
A draggable in-game overlay shows each peer's vital bars with a direction arrow pointing toward that player. Ctrl+drag to reposition; click the × to hide.
|
||||||
|
|
||||||
|
## 🛠️ Building
|
||||||
|
|
||||||
|
### Standard build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
dotnet build mossy.sln -c Release -v minimal
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deploy (local test)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp MosswartMassacre\MosswartMassacre\bin\Release\MosswartMassacre.dll \
|
||||||
|
"C:\Games\Decal Plugins\MosswartMassacre\MosswartMassacre.dll"
|
||||||
|
```
|
||||||
|
|
||||||
|
Some repo workflows keep the release DLL checked in. If the path is gitignored, use `git add -f` when publishing a release.
|
||||||
|
|
||||||
|
### Hot Reload
|
||||||
|
|
||||||
|
PluginCore supports an `InitializeForHotReload` path that re-wires trackers without a full DECAL restart. Useful during development — modify, rebuild, replace DLL, invoke hot-reload.
|
||||||
|
|
||||||
## 🔧 Technical Details
|
## 🔧 Technical Details
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
- **DECAL Framework**: Core plugin system (Decal.Adapter, Decal.Interop.Core, Decal.Interop.D3DService)
|
|
||||||
- **VirindiViewService**: UI framework for game overlays
|
|
||||||
- **Newtonsoft.Json**: JSON serialization for APIs
|
|
||||||
- **YamlDotNet**: Configuration file management
|
|
||||||
|
|
||||||
### Build Configuration
|
### Build Configuration
|
||||||
- **Target**: .NET Framework 4.8, x86 platform
|
- **Target**: .NET Framework 4.8
|
||||||
- **Architecture**: Direct VVS integration (no wrapper abstraction)
|
- **Platform**: AnyCPU / x86 (depending on DECAL host)
|
||||||
- **Features**: Unsafe blocks enabled for P/Invoke operations
|
- **Architecture**: Direct VirindiViewService integration (no wrapper abstraction)
|
||||||
|
- **Unsafe blocks**: Enabled for P/Invoke
|
||||||
|
|
||||||
### Navigation File Format Support
|
### Threading Rules
|
||||||
**Complete VTank .nav format compatibility:**
|
- **Never** touch DECAL COM objects from background threads — they're STA
|
||||||
- **Nav Types**: Circular (1), Linear (0/2), Target (3), Once (4)
|
- Use `System.Windows.Forms.Timer` (UI-thread marshaled), not `System.Timers.Timer`
|
||||||
- **Waypoint Types**: Point, Portal, Recall, Pause, ChatCommand, OpenVendor, Portal2, UseNPC, Checkpoint, Jump
|
- WebSocket send methods (`SendXxxAsync`) marshal to a background send queue safely
|
||||||
- **Performance**: Optimized for routes up to 10,000 waypoints with 500-segment rendering limit
|
|
||||||
|
|
||||||
## 🔌 API Integration
|
### Key Files
|
||||||
|
| File | Responsibility |
|
||||||
|
|---|---|
|
||||||
|
| `PluginCore.cs` | Lifecycle, tracker wiring, hot-reload entrypoint |
|
||||||
|
| `PluginSettings.cs` | YAML per-character config |
|
||||||
|
| `WebSocket.cs` | Single WS connection, reconnect, send helpers |
|
||||||
|
| `ChatEventRouter.cs` | Dispatches chat to KillTracker + CombatStatsTracker + others |
|
||||||
|
| `KillTracker.cs` | Parses kill messages, tracks session kills |
|
||||||
|
| `CombatStatsTracker.cs` | Parses ~50 regex patterns (Mag-Tools style) |
|
||||||
|
| `LiveInventoryTracker.cs` | OnCreate/OnChange/OnRelease → inventory_delta |
|
||||||
|
| `VitalSharingTracker.cs` | Cross-machine vital/debuff relay |
|
||||||
|
| `VitalSharingOverlayView.cs` | DxHud peer-vitals overlay |
|
||||||
|
| `MossyInventory.cs` | Rare detection + classification |
|
||||||
|
| `NavRoute.cs` / `NavVisualization.cs` | VTank .nav parser + renderer |
|
||||||
|
| `VtankControl.cs` | VTank automation interface |
|
||||||
|
| `Views/VVSTabbedMainView.cs` | Main tabbed UI |
|
||||||
|
|
||||||
### HTTP Command Server
|
### Dependencies
|
||||||
```bash
|
- **DECAL Framework** — Decal.Adapter, Decal.Interop.Core, Decal.Interop.D3DService
|
||||||
# Enable server
|
- **VirindiViewService** — UI framework for game overlays
|
||||||
curl -X POST http://localhost:8085/ -d "target=PlayerName&command=report"
|
- **Newtonsoft.Json** — JSON serialization
|
||||||
|
- **YamlDotNet** — Config file management
|
||||||
|
- **Mag.Shared** — shared Mag-Tools utilities
|
||||||
|
- **UBHelper / UtilityBelt interop** — for VTank state injection
|
||||||
|
|
||||||
# Available endpoints
|
## 📁 Project Structure
|
||||||
POST / - Execute command for target player
|
|
||||||
```
|
|
||||||
|
|
||||||
### WebSocket Streaming
|
|
||||||
Real-time data streaming to `wss://overlord.snakedesert.se/websocket/` including:
|
|
||||||
- Monster spawn/despawn events
|
|
||||||
- Chat messages and rare discoveries
|
|
||||||
- Player position and statistics
|
|
||||||
- Session-based authentication with SharedSecret
|
|
||||||
|
|
||||||
### Telemetry Data
|
|
||||||
Periodic JSON snapshots posted to configurable endpoints:
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"timestamp": "2024-12-19T10:30:00Z",
|
|
||||||
"character": "PlayerName",
|
|
||||||
"position": {"x": 59.2, "y": -28.7, "z": 0.05},
|
|
||||||
"stats": {"kills": 150, "rares": 3, "session_time": "02:15:30"}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🛠️ Development
|
|
||||||
|
|
||||||
### Project Structure
|
|
||||||
```
|
```
|
||||||
MosswartMassacre/
|
MosswartMassacre/
|
||||||
├── Views/ # VVS-based UI components
|
├── MosswartMassacre/
|
||||||
│ ├── VVSBaseView.cs # Base view foundation
|
│ ├── PluginCore.cs
|
||||||
│ └── VVSTabbedMainView.cs # Main tabbed interface
|
│ ├── PluginSettings.cs
|
||||||
├── ViewXML/ # UI layout definitions
|
│ ├── WebSocket.cs
|
||||||
│ └── mainViewTabbed.xml # Current layout
|
│ ├── ChatEventRouter.cs
|
||||||
├── NavRoute.cs # Navigation file parser
|
│ ├── KillTracker.cs
|
||||||
├── NavVisualization.cs # Route visualization manager
|
│ ├── CombatStatsTracker.cs
|
||||||
├── PluginCore.cs # Main plugin logic
|
│ ├── CombatInfo.cs
|
||||||
├── PluginSettings.cs # Configuration management
|
│ ├── LiveInventoryTracker.cs
|
||||||
└── lib/ # External dependencies
|
│ ├── VitalSharingTracker.cs
|
||||||
|
│ ├── MossyInventory.cs
|
||||||
|
│ ├── NavRoute.cs
|
||||||
|
│ ├── NavVisualization.cs
|
||||||
|
│ ├── VtankControl.cs
|
||||||
|
│ ├── HttpCommandServer.cs
|
||||||
|
│ ├── Telemetry.cs
|
||||||
|
│ ├── Utils.cs
|
||||||
|
│ ├── Views/
|
||||||
|
│ │ ├── VVSBaseView.cs
|
||||||
|
│ │ ├── VVSTabbedMainView.cs
|
||||||
|
│ │ └── VitalSharingOverlayView.cs
|
||||||
|
│ ├── ViewXML/
|
||||||
|
│ │ └── mainViewTabbed.xml
|
||||||
|
│ └── lib/ # DECAL / VVS / UB interop DLLs
|
||||||
|
├── Shared/
|
||||||
|
│ ├── MyWorldObject.cs
|
||||||
|
│ └── MyWorldObjectCreator.cs
|
||||||
|
├── mossy.sln
|
||||||
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
### Development Environment
|
## 🤝 Contributing
|
||||||
- **IDE**: Visual Studio 2017+ or VS Code with C# extension
|
|
||||||
- **Tools**: MSBuild, NuGet Package Manager
|
|
||||||
- **Testing**: In-game with Asheron's Call client and DECAL
|
|
||||||
|
|
||||||
### Contributing
|
1. Fork & branch (`feature/...` or `fix/...`)
|
||||||
1. Fork the repository
|
2. Respect the DECAL STA threading rules
|
||||||
2. Create feature branch (`git checkout -b feature/amazing-feature`)
|
3. When changing event payload schema, **update both plugin and backend** in the same change — the systems are tightly coupled. See `MosswartOverlord/EVENT_FORMATS.json` for the authoritative contract.
|
||||||
3. Commit changes (`git commit -m 'Add amazing feature'`)
|
4. Prefer additive payload changes (new optional fields) over renames/removes
|
||||||
4. Push to branch (`git push origin feature/amazing-feature`)
|
5. Test end-to-end: plugin → backend WebSocket → browser dashboard
|
||||||
5. Open a Pull Request
|
|
||||||
|
|
||||||
## 📚 Related Documentation
|
For cross-repo workflow guidance, see `CLAUDE.md` in both repos.
|
||||||
|
|
||||||
- **CLAUDE.md**: Claude AI development guidance and build commands
|
## 📚 Related
|
||||||
- **Development History**: Successful VVS migration completed, wrapper system removed
|
|
||||||
- **Architecture Evolution**: Migrated from wrapper-based to direct VVS integration
|
- [MosswartOverlord](https://github.com/SawatoMosswartsEnjoyersClub/MosswartOverlord) — the backend + frontend this plugin feeds
|
||||||
|
- `CLAUDE.md` — developer guidance (AI assistant context)
|
||||||
|
|
||||||
## 📄 License
|
## 📄 License
|
||||||
|
|
||||||
This project is licensed under the MIT License - see the LICENSE file for details.
|
MIT — see `LICENSE`.
|
||||||
|
|
||||||
## 🎯 Roadmap
|
|
||||||
|
|
||||||
### Completed ✅
|
|
||||||
- [x] VVS Direct Integration Migration
|
|
||||||
- [x] Navigation Visualization System
|
|
||||||
- [x] Tabbed UI Interface
|
|
||||||
- [x] WebSocket Streaming
|
|
||||||
- [x] HTTP Command API
|
|
||||||
- [x] Telemetry System
|
|
||||||
- [x] Architecture Cleanup (Phase 3)
|
|
||||||
|
|
||||||
### Future Enhancements
|
|
||||||
- [ ] Multiple route visualization
|
|
||||||
- [ ] Route analysis and optimization tools
|
|
||||||
- [ ] Enhanced UI controls and themes
|
|
||||||
- [ ] Plugin integration marketplace
|
|
||||||
- [ ] Advanced statistics and reporting
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
*Built with ❤️ for the Asheron's Call community*
|
*Built for the Asheron's Call community.*
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue