Obsidian Stats logoObsidian Stats

Ink Buddy

by mgcsysinfcat
5
4
3
2
1
Score: 35/100
Install Code

Description

This plugin has not been manually reviewed by Obsidian staff. A writing companion that tracks your stats with a reactive emoji buddy.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
1
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

Ink Buddy (Ink Buddy ✍️)

GitHub release (latest by date) GitHub all releases

Ink Buddy is an Obsidian plugin that acts as your personal writing companion. It tracks your writing session statistics and features a reactive Emoji Buddy that changes its mood and behavior based on your writing speed and status.

✨ Features

  • Floating Emoji Mascot: A cute, unobtrusive emoji that floats in the corner of your editor.
  • Reactive States: The mascot reacts to your typing speed:
    • 😴 Sleep: When you've been idle for a while.
    • 🤔 Thinking: When you pause briefly.
    • ✍️ Writing: Normal writing pace.
    • 🏄 Flowing: Getting into the zone!
    • 🔥 Burning: High speed writing!
    • 🤯 Exploding: Insane typing speed!
  • Session Statistics:
    • Words: Words written in the current session.
    • Time: Duration of your current writing session.
    • WPH: Real-time Words Per Hour calculation.
  • Per-File Tracking: Statistics reset cleanly when you switch files, letting you focus on the current document.
  • Minimalist Design: Transparent, glass-morphism UI that doesn't clutter your workspace.

📥 Installation

From Community Plugins

  1. Open Settings > Community Plugins in Obsidian.
  2. Turn on Restricted mode (if not already enabled).
  3. Click Browse and search for "Ink Buddy".
  4. Click Install and then Enable.

Manual Installation

  1. Download the latest release from the Releases page.
  2. Extract the main.js, manifest.json, and styles.css files.
  3. Create a folder named obsidian-ink-buddy in your vault's plugin directory: <VaultFolder>/.obsidian/plugins/.
  4. Move the extracted files into that folder.
  5. Reload Obsidian and enable the plugin.

🚀 Usage

Just open any Markdown file and start writing! The Ink Buddy widget will automatically appear in the bottom right corner of your active pane.

  • Start typing to wake up the buddy.
  • Stop to let it rest.
  • Sprint to see it catch on fire! 🔥

🤝 Contributing

Contributions are welcome! If you have ideas for new mascot states or features, feel free to open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

Sponsors