docs: add PROJECT_INDEX.md and update PROJECT_RESUME
- Create comprehensive PROJECT_INDEX.md with full directory structure - Document current (documentation) vs target (implementation) structure - Map all core modules and technology stack - Update PROJECT_RESUME with Sprint 0 completion status - Mark agent identity synchronization complete - Reference AGENTS.md Never-Break Rules Establishes canonical project reference for Lead Engineer workflow.
This commit is contained in:
LemonNexus
parent
63c5c8f624
commit
a630e25898
|
|
@ -0,0 +1,194 @@
|
|||
# Lemontropia-Suite Project Index
|
||||
|
||||
## Project Metadata
|
||||
- **Name:** Lemontropia Suite
|
||||
- **Repository:** https://git.lemonlink.eu/impulsivefps/Lemontropia-Suite
|
||||
- **Local Path:** `/home/impulsivefps/.openclaw/workspace/projects/Lemontropia-Suite`
|
||||
- **Branch:** main
|
||||
- **Status:** 🟢 Active Development
|
||||
- **Lead Engineer:** LemonNexus
|
||||
- **Last Updated:** 2026-02-08 16:37 UTC
|
||||
|
||||
---
|
||||
|
||||
## Directory Structure
|
||||
|
||||
### Current Structure (Documentation Phase)
|
||||
```
|
||||
Lemontropia-Suite/
|
||||
├── 📁 data/ # SQLite database storage
|
||||
│ └── 📁 backups/ # Rotating database backups
|
||||
├── 📁 logs/ # Application logs
|
||||
├── 📁 maps/ # Mining map overlays
|
||||
├── 📁 screenshots/ # Auto-capture on 50+ PED loot
|
||||
├── 📁 test-data/ # Mock data for development
|
||||
│
|
||||
├── 📄 .env # Environment configuration (gitignored)
|
||||
├── 📄 .env.example # Configuration template
|
||||
├── 📄 .gitignore # Git exclusions
|
||||
│
|
||||
├── 📄 AGENTS.md # Agent operating manual (THIS IS LAW)
|
||||
├── 📄 AI_KNOWLEDGE_BASE.md # MCP server configuration
|
||||
├── 📄 GAME_MECHANICS.md # Entropia Universe domain knowledge
|
||||
├── 📄 INSPIRATION.md # Design inspiration & references
|
||||
├── 📄 MODULE_REQUIREMENTS.md # Module specifications
|
||||
├── 📄 OBSIDIAN_WORKFLOW.md # Documentation protocol
|
||||
├── 📄 PROJECT_RESUME.md # Development state tracking
|
||||
├── 📄 README.md # Project overview
|
||||
├── 📄 RESOURCES.md # External resources & APIs
|
||||
├── 📄 TECHNICAL_SPECS.md # Implementation details
|
||||
├── 📄 TESTING_AND_DEBUGGING.md # QA procedures
|
||||
├── 📄 VERIFICATION_CHECKLIST.md # Release checklist
|
||||
├── 📄 environment-test.md # Environment validation
|
||||
└── 📄 run_tests.bat # Windows test runner
|
||||
```
|
||||
|
||||
### Target Structure (Implementation Phase)
|
||||
Per AGENTS.md architecture:
|
||||
```
|
||||
Lemontropia-Suite/
|
||||
├── 📁 /core # Engine logic
|
||||
│ ├── __init__.py
|
||||
│ ├── log_watcher.py # Observer Pattern implementation
|
||||
│ ├── project_manager.py # Data Principle enforcement
|
||||
│ ├── auth_manager.py # License verification
|
||||
│ └── database.py # SQLite abstraction
|
||||
│
|
||||
├── 📁 /modules # Feature modules
|
||||
│ ├── 📁 hunter/ # Combat analytics
|
||||
│ ├── 📁 miner/ # Mining tracker
|
||||
│ ├── 📁 crafter/ # Crafting tool
|
||||
│ └── 📁 inventory/ # Inventory manager
|
||||
│
|
||||
├── 📁 /ui # PyQt6 interface
|
||||
│ ├── 📁 components/ # Shared UI widgets
|
||||
│ ├── 📁 hud/ # Overlay system
|
||||
│ └── 📁 themes/ # Dark mode & styling
|
||||
│
|
||||
├── 📁 /data # Runtime data
|
||||
│ ├── 📁 projects/ # Session archives
|
||||
│ └── lemontropia.db # SQLite database
|
||||
│
|
||||
├── 📁 /assets # Static resources
|
||||
│ └── 📁 icons/ # UI icons & images
|
||||
│
|
||||
├── 📁 /tests # pytest suite
|
||||
│ ├── test_log_watcher.py
|
||||
│ ├── test_project_manager.py
|
||||
│ └── conftest.py
|
||||
│
|
||||
├── 📄 main.py # Application entry point
|
||||
├── 📄 requirements.txt # Python dependencies
|
||||
└── 📄 setup.py # Package installer
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Core Modules
|
||||
|
||||
| Module | Status | Purpose | Key Features |
|
||||
|--------|--------|---------|--------------|
|
||||
| **Core Engine** | ⏳ Planned | Log polling, database, auth | Observer Pattern, asyncIO, SQLite |
|
||||
| **Hunter Tracker** | ⏳ Planned | Combat analytics | Damage parsing, ROI calculation, global detection |
|
||||
| **Mining Tracker** | ⏳ Planned | Resource mapping | Geospatial claims, probe efficiency, depth tracking |
|
||||
| **Crafting Tool** | ⏳ Planned | Manufacturing simulation | Blueprint DB, cost/benefit, market prices |
|
||||
| **Inventory Manager** | ⏳ Planned | Asset valuation | Markup tracking, market integration |
|
||||
| **HUD Overlay** | ⏳ Planned | Transparent overlay | Always-on-top, click-through, editable |
|
||||
|
||||
---
|
||||
|
||||
## Technology Stack
|
||||
|
||||
| Layer | Technology | Version | Purpose |
|
||||
|-------|------------|---------|---------|
|
||||
| Language | Python | 3.11+ | Core implementation |
|
||||
| GUI Framework | PyQt6 | Latest | Windows native UI |
|
||||
| Database | SQLite | 3.39+ | Project storage |
|
||||
| OCR Engine | PaddleOCR / Tesseract | Configurable | UI element capture |
|
||||
| Async Framework | asyncio | Built-in | Non-blocking operations |
|
||||
| Testing | pytest | 7.x+ | Quality assurance |
|
||||
| Packaging | setuptools | Latest | Distribution |
|
||||
|
||||
---
|
||||
|
||||
## Documentation Map
|
||||
|
||||
| Document | Purpose | Key Content |
|
||||
|----------|---------|-------------|
|
||||
| `AGENTS.md` | Agent operating manual | **Never-Break Rules**, coding standards, Git workflow |
|
||||
| `TECHNICAL_SPECS.md` | Implementation guide | Data Capture Engine, HUD specs, automation logic |
|
||||
| `GAME_MECHANICS.md` | Domain knowledge | Entropia Universe economy, loot system, calculations |
|
||||
| `AI_KNOWLEDGE_BASE.md` | AI context | MCP server config, project patterns |
|
||||
| `OBSIDIAN_WORKFLOW.md` | Documentation protocol | Note structure, auto-update rules |
|
||||
| `PROJECT_RESUME.md` | State tracking | Current status, next actions |
|
||||
|
||||
---
|
||||
|
||||
## Environment Configuration
|
||||
|
||||
| Variable | Location | Status |
|
||||
|----------|----------|--------|
|
||||
| `OBSIDIAN_API_URL` | `.env` | ✅ Configured (192.168.5.30:27123) |
|
||||
| `OBSIDIAN_API_KEY` | `.env` | ✅ Configured |
|
||||
| `LICENSE_EMAIL` | `.env` | ⏳ Pending (dev mode) |
|
||||
| `LICENSE_INVOICE_ID` | `.env` | ⏳ Pending (dev mode) |
|
||||
| `EU_CHAT_LOG_PATH` | `.env` | ✅ Using mock data path |
|
||||
|
||||
---
|
||||
|
||||
## Git Repository
|
||||
|
||||
- **Remote:** `git@git.lemonlink.eu:impulsivefps/Lemontropia-Suite.git`
|
||||
- **Protocol:** SSH (port 2222 via `~/.ssh/config`)
|
||||
- **Default Branch:** main
|
||||
- **Commit Convention:** `type(scope): description`
|
||||
- **Latest Commit:** `63c5c8f` - feat: add Obsidian REST API endpoint configuration
|
||||
|
||||
---
|
||||
|
||||
## Integration Status
|
||||
|
||||
| System | Status | Endpoint |
|
||||
|--------|--------|----------|
|
||||
| **Gitea** | 🟢 Connected | git.lemonlink.eu:2222 |
|
||||
| **Obsidian** | 🟢 Operational | 192.168.5.30:27123 |
|
||||
| **Code-server** | 🟢 Running | 192.168.5.216:8443 |
|
||||
| **OpenClaw API** | 🟢 Active | localhost:18789/v1 |
|
||||
|
||||
---
|
||||
|
||||
## Current Sprint
|
||||
|
||||
**Sprint 0:** Infrastructure & Setup ✅ COMPLETE
|
||||
- [x] Repository initialized
|
||||
- [x] Environment configuration
|
||||
- [x] Documentation structure
|
||||
- [x] Obsidian integration
|
||||
- [x] Agent identity sync
|
||||
|
||||
**Sprint 1:** Core Data Capture Engine ⏳ NEXT
|
||||
- [ ] Create `/core` directory structure
|
||||
- [ ] Implement `LogWatcher` (Observer Pattern)
|
||||
- [ ] Implement `ProjectManager` (Data Principle)
|
||||
- [ ] SQLite schema initialization
|
||||
- [ ] Mock data pipeline
|
||||
- [ ] Unit tests for core components
|
||||
|
||||
---
|
||||
|
||||
## Never-Break Rules Reference
|
||||
|
||||
See `AGENTS.md` Section 2 and `SOUL.md` Lemontropia Core Directives.
|
||||
|
||||
**Quick Reference:**
|
||||
1. **Data Principle** — Every session is a Project
|
||||
2. **Log Polling First** — OCR is fallback only
|
||||
3. **60+ FPS Guarantee** — Game performance is sacred
|
||||
4. **Decimal Precision** — No rounding errors on PED/PEC
|
||||
5. **Test Before Commit** — `pytest tests/` is mandatory
|
||||
6. **Atomic Commits** — Conventional commit format
|
||||
7. **Obsidian Sync** — Document every architectural decision
|
||||
|
||||
---
|
||||
|
||||
*Project Index maintained by LemonNexus. Last sync: 2026-02-08 16:37 UTC*
|
||||
|
|
@ -4,8 +4,9 @@
|
|||
- **Repository:** https://git.lemonlink.eu/impulsivefps/Lemontropia-Suite
|
||||
- **Local Path:** `/home/impulsivefps/.openclaw/workspace/projects/Lemontropia-Suite`
|
||||
- **Clone Date:** 2026-02-08 16:20 UTC
|
||||
- **Last Commit:** 2f29640 - docs: add AI knowledge base with project configuration and MCP server details
|
||||
- **Status:** Active
|
||||
- **Last Commit:** 63c5c8f - feat: add Obsidian REST API endpoint configuration
|
||||
- **Lead Engineer:** LemonNexus (identity synchronized)
|
||||
- **Status:** 🟢 Active - Sprint 0 Complete
|
||||
|
||||
## Project Overview
|
||||
**Entropia-Tools Suite Replication** - Professional analytics platform for Entropia Universe MMORPG.
|
||||
|
|
@ -31,23 +32,30 @@
|
|||
- **License Auth:** Email + Invoice ID verification
|
||||
|
||||
## Development Status
|
||||
### Sprint 0: Infrastructure ✅ COMPLETE
|
||||
- [x] Repository initialized
|
||||
- [x] Documentation structure created
|
||||
- [ ] Core data capture engine
|
||||
- [ ] HUD overlay system
|
||||
- [ ] Hunter Tracker module
|
||||
- [ ] Mining Tracker module
|
||||
- [ ] Crafting Tool module
|
||||
- [ ] Inventory Manager module
|
||||
- [ ] License/auth system
|
||||
- [ ] Auto-updater
|
||||
- [x] Environment configuration (.env, .env.example)
|
||||
- [x] Obsidian integration (192.168.5.30:27123)
|
||||
- [x] Agent identity synchronized (AGENTS.md → SOUL.md)
|
||||
- [x] PROJECT_INDEX.md created
|
||||
- [x] Git workflow established
|
||||
|
||||
### Sprint 1: Core Data Capture Engine ⏳ NEXT
|
||||
- [ ] Create `/core` directory structure
|
||||
- [ ] Implement `LogWatcher` (Observer Pattern)
|
||||
- [ ] Implement `ProjectManager` (Data Principle)
|
||||
- [ ] SQLite schema initialization
|
||||
- [ ] Mock data pipeline
|
||||
- [ ] Unit tests for core components
|
||||
|
||||
## Key Files
|
||||
- `README.md` - Project overview
|
||||
- `PROJECT_INDEX.md` - **Complete project structure and architecture**
|
||||
- `TECHNICAL_SPECS.md` - Implementation details
|
||||
- `GAME_MECHANICS.md` - Entropia Universe domain knowledge
|
||||
- `AI_KNOWLEDGE_BASE.md` - MCP server configuration
|
||||
- `AGENTS.md` - Development agent guidelines
|
||||
- `AGENTS.md` - **Development agent guidelines (NEVER-BREAK RULES)**
|
||||
|
||||
## Environment Setup
|
||||
- [x] `.env.example` — Template with all configuration options documented
|
||||
|
|
@ -55,4 +63,6 @@
|
|||
- [x] Directory structure: `data/`, `screenshots/`, `logs/`, `test-data/`, `maps/`
|
||||
|
||||
## Next Actions
|
||||
TBD by Lead Architect
|
||||
**Current Sprint:** Core Data Capture Engine
|
||||
**Assigned:** LemonNexus (Lead Engineer)
|
||||
**Awaiting:** Lead Architect approval to proceed
|
||||
|
|
|
|||
Loading…
Reference in New Issue