Skip to content

CLAUDE.md

Latest commit

 

History

History
56 lines (36 loc) · 2.11 KB

CLAUDE.md

File metadata and controls

56 lines (36 loc) · 2.11 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build

This project uses CMake with vcpkg for dependency management, builds only on Windows and requires Visual Studio 2017+.

Do not attempt to build the code or run tests, as the environment is not set up for it.

Development Guidelines

This project uses C++23 and follows KISS (Keep It Simple, Stupid) and DRY (Don't Repeat Yourself) principles.

Avoid magic numbers.

Architecture Overview

This project implements Observer plugin modules for FAR Manager that handle exotic archive formats. The codebase follows a plugin architecture where each module implements the Observer API to support different archive formats.

Core Components

  • API Layer (src/api.h, src/dll.cpp): Implements the Observer plugin API with standard functions like OpenStorage, CloseStorage, GetItem, ExtractItem
  • Archive Wrapper (src/archive.h, src/archive.cpp): Provides a unified interface that wraps format-specific extractors
  • Extractor Interface (src/modules/extractor.h): Defines the abstract interface that all format extractors must implement

Module Structure

Each supported format has its own module under src/modules/:

  • renpy/: RenPy visual novel archives (.rpa files) with pickle support
  • zanzarah/: Zanzarah game archives (.pak files)
  • rpgmaker/: RPG Maker archives (in development)

Each module contains:

  • Format-specific implementation (e.g., renpy.cpp)
  • Module definition file (.def) for DLL exports
  • Configuration file (observer_user.ini)

Data Flow

  1. FAR Manager loads the module DLL via LoadSubModule()
  2. OpenStorage() creates an archive wrapper with format-specific extractor
  3. PrepareFiles() scans and indexes archive contents
  4. GetItem() provides file metadata for FAR's file browser
  5. ExtractItem() handles actual file extraction with progress callbacks

Testing Framework

Located in src/tests/ with a custom framework (framework/observer.h) that simulates the Observer API for testing archive operations without requiring FAR Manager.