This is the Burn Progress userscript version 1.2.
The script adds a gold-colored progress bar at the very top of the dashboard showing your overall progress toward memorizing items with Wanikani:
The gold bar at top indicates I’ve burned 37% of the 8,995 currently published items, and have “seen” (burned or am still in the process of reviewing) 63%.
I’m currently at level 36 of 60 (or 60% “done”) which is pretty close to the “seen” value shown above, but I prefer to think of myself as only 37% “done” since I’ve only burned about a third of the total items on Wanikani.
This is my very first userscript and although at least a few users have reported success, it’s still possible that I’ve screwed something up.
While I can’t guarantee that this script won’t cause your computer to explode, I’m reasonably confident that most users won’t experience any problems.
Please do let me know if you do run into any issues by adding a comment to this thread. I’ll do my best to resolve them promptly.
Install Tampermonkey or your preferred script manager (installation instructions in this thread )
Install the Wanikani Open Framework user script. This must load before Burn Progress!
Browse to the Burn Progress script on greasyfork then click the “Install this script” link. You’ll have a chance to review the script before truly installing.
As always, review the script to ensure it doesn’t do anything evil. At a minimum, ensure the
@matchlines only match URLs within the
wanikani.comdomain. This script only requires
get(read) permissions (
I wanted a visually simple “overall progress” bar on my dashboard.
To me, “overall progress” should answer the question: “How many of the items on Wanikani have I successfully memorized?”.
The engineering motto is: “If you can’t measure it you can’t improve it.” One of the most important corollaries is, “Since you improve what you measure, be careful to measure what you want.”
The best metric currently available that I know of is the ratio of burned items to total items.
Burning an item literally means I’ve answered a review correctly at least nine times, with a four-month gap before the final review. It’s not a perfect metric because I’ve almost certainly forgotten at least a few burned items, but it works very well for me.
To me, leveling up just unlocks more unseen items, so focusing on levels seems like focusing more on getting into college rather than graduating!
I can’t help but feel that my current level is basically “internet points”: It has little value outside of Wanikani. Burned items, though, tell me how many of the roughly 9,000 or so kanji and vocabulary items on WK I’ve successfully memorized. That’s a pretty good proxy for how large a vocabulary I’ve built and how well I can now read Japanese.
Note that even burning every item on WK doesn’t indicate a huge degree of fluency in Japanese. There is still much more grammar and vocabulary to learn, and even “burning everything” provides no indication regarding speaking and understanding spoken Japanese.
In my professional life, I’ve also learned the importance of simplicity. The fact that the data is already available on my dashboard screen doesn’t diminish my desire at all. It’s the difference between data and information: A single prominent (if oversimplified) metric is often more valuable than a wall of supporting data.
Today, all of us use our “level” as the oversimplified metric for our overall progress. While there’s nothing wrong with that, I’d rather focus less on my level and more on my burns (final graduation exam results rather than getting into the next school year).
Personally, I feel “I’m on level 36 of 60” is less meaningful than “I’ve burned (‘learned’) 38% of the available items on WK.”
Design, implementation, and explaining the output
But I wanted something much simpler that also fit better with the (current) dashboard styling. Specifically, I wanted something that looked pretty close to the current level progress bar.
The KISS principle applied: I just wanted a simple bar graph with no dialogs to edit preferences or whatever. I also didn’t care to graph the percentages of all 9 stages. For the purposes of a progress bar, I just cared whether an item was burned (stage 9), in-progress (stages 1-8), or unseen (currently locked or stage0 lessons I’ve yet to review).
I wanted the script to be useful even for new users, however. It would be silly to only show “0 of 8995 Burned” for the first several months to new users. That’s why the bar shows a deeper gold color for burned items, and a lighter gold for the remaining seen but un-burned. Even beginners will soon have an appreciable number of “seen” items, even if they haven’t yet burned any.
In addition, users of the “free” subscription on levels 1 to 3 only have access to a much smaller number of study items. The script checks for this, though, and will display, e.g., “349 total free items: 28 seen” instead of “8995 total items: 5595 seen (3260 burned)” as is currently presented on my screen at level 36.
Burned is a strict subset of seen. That is: seen = burned + in-progress.
I’ve also strived to make the presentation of the progress bar responsive. It should render correctly for any reasonable display size. Please let me know if it doesn’t!
Lastly, it seems that using gold coloring rather than the standard dark gray to represent burned items is becoming a bit of a standard (likely due to @rfindley 's nifty Golden Burn userscript). He seems to know something about this scripting stuff.
For some reason, WK API + WKOF + @Pep95 's code is telling me I’ve currently burned 3260 items, but the default WK dashboard shows only 3258 items in that bucket. I’m not 100% sure I know why, but the most likely reason appears to be that the character 又 was moved from level 2 to level 51 after I’d already burned it.
I’m an only sporadic programmer and it took me a while to build up my chops again. I’d never have succeeded without “borrowing” code from my betters.
I’d also like to give a shoutout to all the absolutely astonishing “free software” tools involved in building this:
- Visual Studio Code
- Wanikani API
- Wanikani Open Framework
The fact that professional tools like these are freely available never ceases to amaze me.
Finally, thanks to Koichi, the team, and the terrific community here for keeping me motivated to improve my Japanese!