# Goal Flow

Connect Markdown tasks, projects and problems using shared Tasks IDs.

Goal Flow is an Obsidian plugin for managing projects, visualizing task relationships, and recording problems and possible solutions. The current interface is in Chinese.

## Features

- Read projects and tasks from Markdown notes.
- View projects in a table and edit project priority and note status.
- Visualize task relationships on a canvas and filter by project.
- Connect tasks and track problems and alternative solutions.
- Add stable task IDs automatically and edit task due dates.
- Open Goal Flow in a workspace tab.

## Getting started

1. Enable the plugin and open **打开 Goal Flow** from the command palette or the ribbon icon.
2. Create a Markdown project note with the following content:

```markdown
---
goal-flow: true
优先级: "2"
笔记状态:
  - 进行中
---
# Example project
- [ ] Define the goal
- [ ] Complete the first step
```

3. Goal Flow automatically adds stable IDs to tasks in project notes. You can also run **为当前项目任务补充 ID** on the active project note.
4. Use the project table, relationship canvas, and problem focus views to manage your work.
5. Configure **项目文件夹** to limit which folder is scanned. Leave it empty to scan the vault.

## Data storage

Tasks remain in Markdown notes. Goal Flow can write task IDs, due dates, priority, and note status back to those notes. Relationships and supporting graph data are stored in `TaskExtension/goal-flow-data/graph.json` by default. Change this location using **关系图文件** in the plugin settings. Keep your vault backed up before trying a new release.

## Manual installation

Download `main.js`, `manifest.json`, and `styles.css` from a release and place them in `<vault>/.obsidian/plugins/goal-flow/`. Restart Obsidian and enable Goal Flow in Community plugins.

## Source code

The full readable JavaScript implementation is in `main.js`; styles are in `styles.css`. No compilation is needed for these checked-in plugin files. The header in `main.js` records the original generator name; that historical build script is not included in this repository.

## Compatibility

The manifest declares Obsidian 1.5.0 or later and allows mobile installation. Mobile behavior has not yet been verified for this public release.

## Support

Report bugs and feature requests through the repository's Issues page. Include your Obsidian version and steps to reproduce, and use example notes rather than private vault data.

## License

Copyright (c) 2026 Philia. Licensed under GNU GPL version 3 only (GPL-3.0-only). See LICENSE. Distributed without warranty.