Skip to content

Manage your tasks, projects, key results, and goals within Obsidian. This plugin follows #theGamificationProject's Success Plan Framework.

License

Notifications You must be signed in to change notification settings

thex3family/obsidian-success-plan

Repository files navigation

Success Plan for Obsidian

Official Updates from Joshwin can be found here: obsidian-success-plan channel in Co-x3's Guilded community

Preview

This plugin was developed by Joshwin Greene in collaboration with Conrad Lin (Designer of the Success Plan Framework) and the Co-x3 Family. If you would like to show Joshwin your appreciation, you can do so by buying him a coffee. If you are a fan of what Conrad, Joshwin, and the rest of the Co-x3 Family are doing, please support us by becoming a one-time or monthly Patron. Also, if you are interested in being a part of a community of co-creators and collaborators, then we would be happy to have you. Learn More.

This plugin offers capabilities that follow #theGamificationProject's Success Plan by Conrad Lin.

It allows you to manage your tasks, projects, key results, and goals within Obsidian. In the next release, you will also be able to push your wins (completed objectives) to the Make Work Fun app, which is the Co-x3 Family's solution to multiplayer for personal development. We recently open-sourced the code (with limitations)!

This plugin relies on markdown files that have the following format:

Markdown Preview

When the Make Work Fun integration is online, you will be able to share wins with the Co-x3 Family by changing an item's status to "Complete" and choosing the "Share with Family" option. When this is done, it will be pushed to Make Work Fun.

After you have shared the win, you will see the win in the "Recent Wins" table on your player page. Here's an example of what you can expect:

player page

Getting Started

  1. Install the plugin

  2. Download the Quick-Start-Vault folder. You can do this by downloading this repo (Click the green "Code" button at the top of this page and click "Download ZIP"). This folder contains everything that you need, i.e. the tags, the directory for the Success Plan Items and their associated subfolders, and templates for each type of item.

  3. Open the plugin's pane/view by clicking on its icon on the left hand bar/ribbon

  4. Read the following materials to understand how the Success Plan Framework works: Overview, Goals, Key Results, Projects, and Tasks

Features

  • List and Show/Hide Success Plan items that can be found in the Success Plan directory Success
  • Easily change the status of Success Plan items by clicking and selecting the new status (ex. In Progress) Success
  • Open Success Plan items in the Markdown Editor by Shift Clicking on an item Success
  • Create Success Plan items using the floating action button to the bottom right Success
  • Edit Success Plan Items by clicking an item and clicking on "Edit" Success
  • Turn gamification off/on Success
  • Use your preferred date format Success

Editor Options / Plugins that this plugin works best with

  • Dataview (Community Plugin)
  • Fold heading (Editor Option)

Coming Soon

  • Push completed wins to Make Work Fun
  • Be able to select upstream and downstream items when creating and editing items via the modal

Want to Help?

Join the Co-x3 Family! I'm one of the two co-leaders of the Artificer (Programmer) faction and I'm leading the official guild project that was created for this plugin. So, I and the Co-x3 Family would be happy to have you. Learn more about joining here.

Developers: Please create a fork and submit your contributions via Pull Requests.

About

Manage your tasks, projects, key results, and goals within Obsidian. This plugin follows #theGamificationProject's Success Plan Framework.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published