GithubHelp home page GithubHelp logo

zachatoo / obsidian-achievements Goto Github PK

View Code? Open in Web Editor NEW
22.0 22.0 0.0 293 KB

Add achievements to Obsidian to help guide the user to build good habits in Obsidian.

License: MIT License

JavaScript 10.05% TypeScript 80.89% CSS 1.16% Shell 0.28% Svelte 7.62%
obsidian-plugin svelte typescript

obsidian-achievements's Introduction

My name is Zach Young. I am passionate about using technology to make people’s lives easier and more efficient.

Check out my website to learn more about me https://zachyoung.dev

obsidian-achievements's People

Contributors

dependabot[bot] avatar zachatoo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

obsidian-achievements's Issues

Feature Request: Add Custom Achievements and Rewards

Is your feature request related to a problem? Please describe.
The achievements are an amazing idea. However, since I already know my way around Obsidian, the achievements are rendered useless. In addition, the lack of rewards feels unsatisfying.

Describe the solution you'd like
Adding custom achievements with the option to create new ones. It can extract achievements from a markdown file in the vault. In addition, adding a rewards option similar to https://github.com/Gnopps/obsidian-rewarder

Ideally, the earned rewards would be added to an inventory

Describe alternatives you've considered
Rewarder is a great plugin, but it's also quite buggy. In addition, my rewards aren't tracked

Additional context
Gamifying productivity can help increase motivation, especially with individuals who have Autism, ADHD, or general focus/motivation issues. There is currently no plugins that add this functionality to Obsidian

Quick switcher and command palette achievements do not work on mobile

Describe the bug
The "Commander" and "Quickly Now" achievements do not get triggered on iOS or Android.

To Reproduce

  1. Install plugin on iOS or Android.
  2. Open the command palette by dragging down.
  3. Open the quick switcher by tapping the plus icon in the bottom action bar.

Expected behavior
The "Commander" and "Quickly Now" achievements should be completed.

Change how links are retrieved from metadata cache

Need to replace this undocumented Obsidian function with one from the public api.

// before
return this.app.fileManager.getAllLinkResolutions().length;

// after
let count = 0;
this.app.metadataCache.iterateReferences((sourcePath: string, reference: ReferenceCache) => {
  count++;
});
return count;

Should also remove the typescript declaration for this undocumented Obsidian function.

Ideas for achievement types

  • Using markdown features
    • Headings
    • #3
    • Tags
    • Markdown link
    • Heading/block links
    • Checklists
    • Lists
    • Frontmatter (aliases, tags)
  • Using command palette
  • Quick switcher

Number above progress bar doesn't show on iOS

Describe the bug
The progress numbers do not show above the progress bars on iOS.

To Reproduce

  1. Install plugin on iOS.
  2. View achievements list in either settings or the achievements pane.

Expected behavior
Progress numbers should show above progress bars.

Screenshots
image

Add tests

Would like to add some way to have automated tests, ideally in a CI/CD pipeline.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.