Skip to content

norakrajla/grin-or-grimace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 

Repository files navigation

🧠 Mindful Feedback Loop

Download

🌟 A Cognitive Companion for Intentional Living

Mindful Feedback Loop is an ambient intelligence application designed to gently nudge you toward your desired emotional and cognitive states. Unlike reactive systems, this tool establishes a continuous, subtle dialogue between your digital environment and your conscious goals. By leveraging multimodal input (camera, microphone, and optional biometric sensors), it provides real-time, personalized feedback that helps cultivate mindfulness, focus, or any user-defined mental posture.

Imagine a digital garden that responds to your internal weatherβ€”this application is the gardener, tending to your cognitive landscape with gentle, algorithmic care.


πŸ“‹ Table of Contents


✨ Core Philosophy

In a world of constant digital interruption, Mindful Feedback Loop flips the script. Instead of demanding attention, it serves as a peripheral consciousness, a soft mirror reflecting your state back to you. It operates on the principle of "ambient guidance"β€”using subtle cues (visual, auditory, haptic) to encourage self-awareness without breaking flow. It's not about control; it's about cultivating a harmonious relationship with your technology and, by extension, yourself.

πŸš€ Key Features

  • Adaptive Feedback Engine: The system learns from your responses, refining its nudges to become more effective over time. It's a partnership, not a prescription.
  • Multimodal Perception: Utilizes camera input for facial expression analysis, microphone for ambient sound and vocal tone, and supports external APIs for heart rate or galvanic skin response data.
  • Fully Customizable Profiles: Define target states (e.g., "Present", "Creative Flow", "Energetic") with your own parameters for feedback type, intensity, and triggers.
  • Responsive, Minimalist UI: A non-intrusive interface that lives on the edge of your perception. Customizable widgets and themes ensure it complements your workflow.
  • Privacy-First Design: All processing is performed locally on your device by default. Optional cloud features for advanced analysis are explicitly opt-in and transparent.
  • Cross-Platform Synchronization: Your mindful profiles and progress sync seamlessly across your devices, creating a consistent cognitive environment.
  • Challenge Modes: Engage in structured sessions like "Focus Sprints" or "Composure Intervals" that gently train specific mental muscles.
  • Comprehensive Data Insights: View elegant charts and logs of your cognitive trends over time, offering insights into your patterns.
  • 24/7 Automated Support System: An integrated help system and community-powered knowledge base are always available.

πŸ–₯️ Compatibility

OS Status Notes Emoji
Windows 10/11 βœ… Fully Supported Requires Webcam & Mic πŸͺŸ
macOS 12+ βœ… Fully Supported Native Apple Silicon Optimized ο£Ώ
Linux (Ubuntu/Debian) βœ… Fully Supported Package available in community repos 🐧
Android 10+ ⚠️ Beta Core feedback features only πŸ€–
iOS 15+ πŸ”„ Planned Development in progress πŸ“±

πŸ“¦ Installation & Quick Start

  1. Acquire the Application: Obtain the installer for your operating system. Download

  2. Initial Setup: Run the installer. Upon first launch, the Guided Calibration wizard will help you set up your sensors and create a baseline profile.

  3. Select a Starting Profile: Choose from curated profiles like "Beginner's Mindfulness" or "Deep Work Anchor" to experience the system immediately.

  4. Experience the Loop: Allow the application to run in the background. Notice the subtle feedbackβ€”a gentle color shift on your screen border, a soft chime, or a calming vibration patternβ€”as it responds to your state.

βš™οΈ Configuration Deep Dive

Configuration is managed via human-readable YAML files. The core file is profiles/user_settings.yaml. Here, you define the feedback modalities, sensitivity, and your personal goals.

πŸ”§ Example Profile: The "Calm Focus"

This profile aims to reduce facial tension and encourage steady breathing for sustained concentration.

profile: "calm_focus"
target_state:
  description: "Reduced facial tension, even breathing pattern."
  metrics:
    - name: "jaw_clench"
      target_max: 0.3
    - name: "breath_regularity"
      target_min: 0.7

feedback_modalities:
  visual:
    enabled: true
    type: "peripheral_gradient"
    color_calm: "#4ade80"
    color_alert: "#fbbf24"
    intensity: 0.6

  auditory:
    enabled: true
    type: "ambient_pad"
    base_sound: "soft_waves"
    volume: 0.2
    interrupt_sound: "gentle_bell"

  haptic:
    enabled: false

triggers:
  - metric: "jaw_clench"
    operator: ">"
    value: 0.5
    action: "increase_feedback"
    cooldown_seconds: 30

session:
  default_length_minutes: 45
  challenge_mode: "focus_sprint"

πŸ’» Example Console Invocation

For advanced users, the entire application can be controlled via a CLI for scripting and automation.

# Launch the application with a specific profile
mindful-loop --profile calm_focus --log-level INFO

# Start a 30-minute challenge session
mindful-loop start --challenge composure_interval --duration 30

# Export your session data for the last week
mindful-loop export --data sessions --format json --from 2026-04-01

# Check system status and sensor connectivity
mindful-loop status --verbose

πŸ”— System Architecture

The application is built with a modular, event-driven architecture to ensure responsiveness and ease of extension.

graph TD
    A[User] -->|Camera/Mic/Sensor Data| B[Input Layer];
    B --> C{Analysis Engine};
    C -->|Local ML Model| D[State Inference];
    C -->|Optional Cloud API| E[Advanced Analysis];
    D --> F[Feedback Orchestrator];
    E -.-> F;
    F --> G[Visual Feedback];
    F --> H[Auditory Feedback];
    F --> I[Haptic Feedback];
    F --> J[Data Logger];
    J --> K[Local Database];
    K --> L[Insights Dashboard];
    G --> A;
    H --> A;
    I --> A;
Loading

πŸ€– AI Integration

Mindful Feedback Loop can be enhanced with external AI services for more nuanced state analysis. These are entirely optional and configured via config/api_keys.yaml.

  • OpenAI API Integration: Provides advanced natural language processing for journaling analysis and generating personalized mindfulness prompts based on your logged state data.
  • Claude API Integration: Used for ethical reasoning checks on user-defined goals and generating descriptive, empathetic summaries of your weekly cognitive trends.

Example API config snippet:

openai:
  enabled: false # Opt-in only
  endpoint: "https://api.openai.com/v1/chat/completions"
  model: "gpt-4o-mini"
  usage: "prompt_generation"

anthropic:
  enabled: false # Opt-in only
  endpoint: "https://api.anthropic.com/v1/messages"
  model: "claude-3-haiku-20240307"
  usage: "trend_summarization"

🌐 Multilingual & Accessibility

The application interface and documentation are available in English, Spanish, Japanese, German, and French. Screen reader compatibility is a priority, with full ARIA label support in the desktop UI. All feedback modalities can be adjusted or substituted to accommodate different sensory needs.

⚠️ Disclaimer & Ethical Use

Mindful Feedback Loop is a tool for self-exploration and cognitive aid. It is not a medical device, therapeutic intervention, or substitute for professional mental health care.

  • Intended Use: For adults seeking to increase self-awareness and practice cognitive techniques in their daily digital life.
  • Data Privacy: We are staunch advocates of local-first data processing. You own your data. Review our Privacy Policy (included in the installation) for detailed information.
  • Ethical Design: The application is designed to empower, not manipulate. "Challenge" modes are intended to be playful and consensual, never punitive. Users have complete autonomy to disable, modify, or ignore any feedback.
  • Limitation of Liability: By using this software, you agree that the developers are not liable for any direct or indirect outcomes resulting from its use.

πŸ“„ License

This project is licensed under the MIT License.

Β© 2026 Mindful Feedback Loop Contributors. See the full legal terms in the LICENSE file distributed with this software.

πŸ™ Support & Contribution

We are building a community around intentional technology. If you encounter an issue, have a feature idea, or want to contribute code or translations, please visit our repository.

Community-Powered Assistance: Our community forums and issue tracker are monitored around the clock, providing a 24/7 collaborative support network.

Ready to begin your journey of ambient self-awareness?

Download

Releases

No releases published

Packages

 
 
 

Contributors