How unknownnpasta/treasuryframe works
Project type and purpose
• This is a specialized desktop‐client application built on the Overwolf platform for the game Warframe.
• It uses modern web technologies (React + Redux + TypeScript + Vite) to provide an in-game overlay that tracks resources, parts, and fissures, and notifies the user.
File structure
Top-level directories:
• public – static assets and manifest.json for production
• mockup – design prototypes and sample data
• scripts – build helpers for Overwolf manifest and packaging
• src – actual application code, subdivided into:
– app – application shell, root component, global Redux store & shared constants
– components – generic, reusable UI components (e.g. Loading, ItemView)
– features – domain-specific features (rewardScreen, settings) with their hooks and components
– lib – platform integrations & utilities (Overwolf wrappers, IO, OCR, authentication)
– locales – i18n JSON files for multiple languages
– screens – three Overwolf “contexts”: background (headless processing), desktop overlay, in-game overlay, plus notification context
– types – global TypeScript definitions
• configuration – tsconfig.*, vite.config.ts, eslint.config.js, .env
README for additional insights
• Confirms tech stack: React, Redux, TypeScript
• Describes core features: resource/part/fissure tracking, in-game overlay
• Build process: npm run build → build folder with compiled app
• Run process: npm run start for development
a. Main components
1. Overwolf Launcher & Runtime
2. App Shell (src/app)
3. UI Screens
• Background Screen (analytics, log tailing, notifications)
• Desktop Screen (desktop overlay UI)
• In-game Screen (in-game overlay UI)
4. Redux Store & Root Reducer (shared state)
5. Services / Libraries (src/lib)
– Overwolf API wrappers
– Log tailing & OCR hooks
– Data fetching (GSFetch)
6. Localization Module (src/locales)
8. External systems
– Warframe game process & logs
– Overwolf platform APIs
– File system (for storage, traineddata)
b. Relationships and interactions
– Overwolf Launcher starts the app, injects the correct HTML/JS based on context (background, desktop, in-game).
– App Shell (index.tsx) initializes Redux store and React Router (or context dispatcher).
– Each Screen component subscribes to the Redux store, dispatches actions on user events or incoming data.
– Redux actions trigger service functions in src/lib (e.g., OCR, log tailing, Overwolf API calls).
– Services communicate with Overwolf APIs and Warframe logs, then dispatch results back into Redux.
– UI components render updated state; notifications are sent via background screen.
– Localization layer wraps text components using JSON dictionaries.
c. Architectural patterns & design principles
– Layered architecture: Presentation (React UI) → State (Redux) → Services (lib) → Platform (Overwolf/Game)
– Feature-based modules: isolated feature directories for rewardScreen and settings
– Separation of concerns: generic components vs. feature components vs. platform integration
– Single source of truth: centralized Redux store with typed actions & reducers
d. Key technologies & frameworks
– React + React-Redux + Redux Toolkit
– TypeScript
– Vite (build & dev server)
– Overwolf JavaScript API
– OCR hook (Tesseract or similar using eng.traineddata)
– Internationalization via JSON locales
– Custom build scripts (scripts/create-production-overwolf-build.js)