Section Goals Badge

by k-quels
5
4
3
2
1
Score: 51/100

Description

Mobile-friendly floating character counter for Obsidian to set and track writing goals per section.

Reviews

No reviews yet.

Stats

1
stars
1,759
downloads
0
forks
86
days
25
days
26
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
1
total issues
0
open issues
1
closed issues
50
commits

Latest Version

a month ago

Changelog

(EN) I'm excited to finally introduce the Date Goal tracking in this release! 🥳

🎉 New Features

  • Due Date & Schedule Tracking: You can now set target deadlines, start dates, and recurring schedules (daily, weekly, monthly, etc.) for the entire note as well as individual sections (headings).
  • Due Date Progress Badge: Added a date badge that displays remaining time and time progress status. It can be integrated into the word count badge or displayed separately.
  • Added "Date" Tab to Goal Setting Window: Added a dedicated UI to manage and edit due date goals.
  • Folder Default Date Settings: Added default due date and schedule settings to folder configurations.

Bug Fixes

  • Fixed a bug where goals might not be mapped correctly when duplicate headings exist in a note.
  • Improved Frontmatter synchronization when renaming headings.

(JP)

🎉新機能

  • 期日・スケジュール管理機能: ノート全体および各セクション(見出し)ごとに目標日時、着手日時、定期スケジュール(日・週・月などの繰り返し)を設定できるようになりました。
  • 期日進捗バッジ: 残り時間や時間進捗状態を表示する期日バッジを追加。文字数バッジへ統合することも、分離することも可能です。
  • 目標管理ウィンドウに「期日」タブを追加: 期日目標を編集できるUIを追加しました。
  • フォルダごとの期日初期値設定: フォルダ設定に期日関連のデフォルト設定項目を追加しました。

バグ修正

  • 同名見出しがある時に目標値が正しくマッピングされないことがあるバグを修正。
  • 見出し名を変更した際のFrontmatter同期処理を改善。

Full Changelog: https://github.com/k-quels/section-goals-badge/compare/1.3.0...1.4.0

README file from

Github

Section Goals Badge

English | 日本語

Obsidian Downloads GitHub release License: MIT

A floating character/word counter and target date tracker per heading for Obsidian, designed for novel writers and long-form document creators.

Display floating badges on your editor to keep track of word/character counts, progress rates, and target dates for the active heading (section) or entire note in real time.

▼ Desktop

▼ Mobile (with date badge hidden)


Key Features

  • 🎯 Goal Tracking per Section (Heading): Set target counts per folder, per note, or for each chapter and section.

  • 📅 Target Dates & Deadline Tracking: Set target dates, start dates, and recurring schedules per note or section.

  • 📛 Unobtrusive Floating Badge: Position at any corner of the editor, with drag-and-drop movement and opacity adjustments.

  • 🚥 3 Configurable Progress Badges:

    • Progress to Cursor: Counts characters from note top (or section top) up to cursor position.
    • Active Section Progress: Counts characters within the current heading block.
    • Note Total Progress: Counts characters for the entire note.
  • 🎨 Dynamic Badge Colors: Define custom color styles and visually track progress rates at a glance.

  • 📱 Mobile-Friendly: Works smoothly on smartphones even with massive documents.

  • 🔢 Character & Word Counting: Switch between Character count and Word count freely.

  • ✂️ Exclusion Rules: Exclude whitespace, Japanese novel ruby notation, and custom user-specified symbols.

  • ⚡ Fast & Battery Efficient (1M+ characters): Optimized to minimize typing latency and reduce mobile battery drain even in long-form writing.


Usage

1. Open Goal Management Window

  • Tap or click the badge on the editor to open the goal management window. Note: Tapping the date badge opens the modal directly in Target Dates mode.
    • Tips: Change to "Long press to open" in settings to avoid accidental taps.
    • Tips: Click a section name to close the modal and jump directly to that heading.

2. Set Target Counts & Dates

Enter target goals for each item (automatically saved to Frontmatter). Note: To configure goals per folder, add folder definitions in the plugin settings.

  • Word / Character Count Goals

    • Note Total Goal: Target count for the entire note being edited.
    • Section Goal: Default target count applied to headings without individual goals.
    • Heading Level Goals: Set default target counts for each heading level (H1–H6).
    • Individual Section Goals: Enter specific target counts for each row in the heading list.
  • Target Date Goals

    • Note Total Goal: Target date and time for the entire note.
    • Default Section Goals
      • Reference: Inherit recurring schedules or deadlines from note or parent sections.
      • Recurring Schedule: Automatically calculate deadlines by adding duration (days, weeks, months, etc.) to the preceding section.
    • Individual Section Goals: Set individual target dates/times or custom recurring schedules for each heading.

3. Adjust Badge Position & Appearance

  • Drag and drop the badge to place it anywhere on your editor.
    • You can also specify exact values in the settings tab (synced with drag-and-drop values).

Settings

The following features and options can be customized:

1. Badge Display Customization (Cursor / Section / Total / Target Date)

  • Toggle Visibility: Enable or disable the 3 progress badges independently.

    • ▼ e.g., Hide note total badge:
  • Heading Level Progress (H1–H6): Display progress for specific heading levels (H1–H6) in the section progress badge.

    • ▼ e.g., When H1 and H2 are enabled, you can monitor H1 progress while editing H2:
  • Display Content: Toggle current count, target goal, and progress percentage.

    • ▼ e.g., Show only count for cursor position, full details for section:
  • Icon / Label: Toggle prefix icons and text labels.

    • ▼ e.g., Hide both for cursor, icon only for section, full for total:
  • Display as Progress Bar: Display the progress percentage using the badge background color as a gauge.

    • ▼ e.g., Using cursor position and section badges as progress bars:
  • Independent Date Badge: The target date badge can be separated into an independent badge.

    • ▼ e.g., Setting position to "Independent", customizing its position, font size, and opacity separately:

2. Counting Rules

  • Counting Method: Switch between Character count and Word count.
  • Exclusion Settings: Exclude whitespace, Japanese novel ruby notation, and custom specified characters.

3. Appearance & Position

  • Configure badge position preset, opacity, and font size.

4. Color Styles

  • In the plugin settings under Color styles, freely define and customize color schemes (up to 20 styles).

    • Two color modes available: Threshold (step-based) and Gradient (smooth transitions).
    • Progress thresholds for threshold-type styles (default: 50% / 80% / 100%) can be customized in settings.
  • Default Presets:

    • ① Limit Goal Style: Best for strict word/character caps (Gray → Yellow → Orange → Red)  

    • ② Target Achievement Style: Best for aiming to reach a target count (Gray → Orange → Green → Blue)  

  • In the Goal Management modal, select your preferred style per note from the "Color style" dropdown.

5. Date Goals & Deadlines

  • Configure date badge visibility, default start/target times, recurring schedules, and other date defaults.

6. Folder-Level Defaults

  • Set default target goals, color styles, and date-related defaults for notes under specified folders.
    • Note: Settings specified within individual notes take precedence.

Frontmatter Format

  • Target goals and color style choices are stored in the note's YAML Frontmatter in the following format.
  • You can manage goals via the Goal Management modal or edit them directly.
  • Setting goals is completely optional.
---
goal-file: 10000       # <- Target count for the entire note
goal-section: 2000     # <- Default target count for sections
goal-section-h1: 3000  # <- Default target count for H1 (H1–H6 supported)
goal-style: 2          # <- Color style ID (omitted for default style)
goal-target-date: 2026-10-31  # <- Target date for the note (optional)
goal-start-date: 2026-10-01   # <- Start date for the note (optional)
goal-cycle: 1w                # <- Recurring cycle (1d, 1w, 1m, etc., optional)
goals:
  - Chapter 1: 2500    # <- Target count for specific section (simple format)
  - heading: Chapter 2 # <- Unified section settings (word count, date, cycle)
    goal: 3000
    target-date: 2026-10-31
    start-date: 2026-10-15
    cycle: 1w
  - heading: Notes     # <- Use index (1-based) to identify duplicate headings
    index: 1
    goal: 500
    target-date: 2026-10-20
---
  • Tips: If you want to clear all goals or target dates at once, simply delete these lines from the Frontmatter.

Support & Donation

If you enjoy Section Goals Badge, your support is greatly appreciated!

Buy Me A Coffee


License

This software is released under the MIT License.