# neversinkdev/neversink-filter-for-poe2 architecture

> Architecture diagram of the GitHub repository neversinkdev/neversink-filter-for-poe2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/neversinkdev/neversink-filter-for-poe2
- Repository: https://github.com/neversinkdev/neversink-filter-for-poe2

## Overview

##### Main Components to Highlight
- Filter Engine/Script Files: At the core are the .filter files (e.g., “NeverSink’s filter 2 – 0-SOFT.filter” up to “UBER-PLUS-STRICT”) which define the various strictness levels.
- Asset/Resource Directories: There are two main style directories – “CUSTOMSOUNDS” and “DARKMODE”. Each holds assets (custom sounds or style-specific filter files) that provide alternative aesthetics and behavior.
- Additional Files & Deprecated Archives: The “ADDITIONAL-FILES” directory (with Deprecated files) and other support documents (CHANGELOG, LICENSE) show versioning/maintenance but are less central to the runtime behavior.
- CI/CD & Release Automation: The .github directory, along with configuration files like “autorelease.yml” and “release-drafter.yml”, indicate automated release management to ensure updated filters are published each league.
- Companion Website Integration: Though not part of the core repository code, the README calls attention to the FilterBlade website (filterblade.xyz) which allows users to modify, preview, and customize the filters. This external service is an accessory but important for how end users interact with the overall solution.

##### Relationships & Data/Dependency Flow
- The “Filter Scripts” are the primary deliverable that will be deployed into the Path of Exile 2 game client.

##### Architectural Patterns and Design Principles
- Separation of Concerns: Different directories and files are clearly separated by their functions (assets versus filter scripts versus release configurations).
- Modularity: With 7 distinct strictness levels and distinct style options (Custom vs. Dark Mode), the design encapsulates each variant in its own subdirectory or file module.
- Automation: The presence of GitHub workflows indicates a modern, automated release and update cycle, which should be highlighted.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Repository Group
    subgraph "Repository"
        FE["Filter Engine – Strictness Levels"]:::core
        AF["Supplemental Files (CHANGELOG, LICENSE, ADDITIONAL‑FILES)"]:::supp
    end

    %% Asset Directories
    CSA["Custom Sounds Assets"]:::asset
    DMA["Dark Mode Assets"]:::asset

    %% CI/CD Pipeline
    CICD["CI/CD & Release Automation"]:::pipeline

    %% Release & Deployment
    RL["Releases/Distribution"]:::release
    Local["User's Local Game Directory"]:::local

    %% External Companion Website
    FB["FilterBlade.xyz"]:::external

    %% Connections
    CSA -->|"feeds"| FE
    DMA -->|"feeds"| FE
    FE -->|"triggers"| CICD
    AF -->|"supports"| FE
    CICD -->|"deploys"| RL
    RL -->|"installs"| Local
    FB <-->|"customizes"| Local

    %% Styles
    classDef core fill:#FFD700,stroke:#333,stroke-width:2px;
    classDef supp fill:#D3D3D3,stroke:#333,stroke-width:2px;
    classDef asset fill:#ADD8E6,stroke:#333,stroke-width:2px;
    classDef pipeline fill:#90EE90,stroke:#333,stroke-width:2px;
    classDef release fill:#FFB6C1,stroke:#333,stroke-width:2px;
    classDef external fill:#FFA07A,stroke:#333,stroke-width:2px;
    classDef local fill:#E0FFFF,stroke:#333,stroke-width:2px;

    %% Click Events
    click FE "https://github.com/neversinkdev/neversink-filter-for-poe2/blob/main/NeverSink's filter 2 - 0-SOFT.filter"
    click CSA "https://github.com/neversinkdev/neversink-filter-for-poe2/tree/main/CUSTOMSOUNDS"
    click DMA "https://github.com/neversinkdev/neversink-filter-for-poe2/tree/main/DARKMODE"
    click AF "https://github.com/neversinkdev/neversink-filter-for-poe2/tree/main/ADDITIONAL-FILES"
    click CICD "https://github.com/neversinkdev/neversink-filter-for-poe2/blob/main/.github"
    click FB "https://github.com/neversinkdev/neversink-filter-for-poe2/blob/main/README.md"
```
