search

Aryetis / Obenkyobo

Japanese learning Application for Kyobo ereaders
Other
15 stars 0 forks source link
ereader japanese-study kobo kobo-ereader

readme

Obenkyobo

What is it ?

Obenkyobo is an application for kyobo ereaders designed to help you memorize Hiraganas, Katakanas and vocabulary.

It is very inspired by an Android application called Obenkyo, available at google play. I have no affiliation with Obenkyo whatsoever. But check it out it's free and worth your time too if you can resist the urge to procrastinate on your samrtphone instead of studying.

How does it look ?

More screenshots : here

Any demo video ? Settings Explanations ?

https://user-images.githubusercontent.com/4246001/197065422-db6f3642-189e-4b5f-9f7d-373bd2ce00aa.mp4

Youtube link (better video quality)

Features ?

Here's what available currently :

Tested and working on :

How to install ?

Firstly, this application is designed to be compatible with most (except some new models) Kobo devices with a recent firmware (probably 4.6+). Do not try to install it for other ereader, it will not work ! This application is provided "as is". Don't come to me if somehow your device catch on fire after installing this.

Secondly, you'll need to install a "launcher" beforehand. Common options are :

Once you're done installing at least one of those you can :

If you're only updating Obenkyobo, you can try to install the "light" version of the archive instead. Obenkyobo_Light_Release_V..*.zip. This version is stripped from qt packages you already installed with the previous AIO version and should work fine for updating except if told otherwise.




And voilà ! You should now have a NickelMenu entry at the bottom right corner of your ereader "home screen" and/or a new "book" in your library to open with KfMon.

How to create my vocabulary sheets ?

Each ****.oben file in .adds/Obenkyobo/vocab is a Vocabulary sheet. Depending of your operating system, you might have to enable "hidden files" to see those directories. I encourage you to write your owns, searching for new words and writing sheets is also part of the learning process. To make your own sheet, create a file and follow the same template as the default ones.

Each line should follow this format : [fontType=hiragana][jp=いぬ][kanji=犬][trad=dog][learningScore=5]

Provided Vocabulary Sheets can be found on this repository at this page

You can insert commentary line by having it start with a #.

Possible values for fontType are hiragana, katakana, it will determine what font is used in Obenkyobo to display this entry's jp value.

LearningScore (LS)'s value ranges from 0 to 5, please note that the value actually registered in the file is inversed from what is displayed in Obenkyobo. Therefore you should probably put 5 for each new Entry.

Feel free to share your own Vocabulary Sheets in Obenkyobo's mobileread thread

If your file is misinterpreted in Obenkyobo, please make sure your text editor (notepad++, sublimeText, etc) is saving the file in UTF-8 format.

Issues ?

If you encounter any issues, please report them by either :

Thanks

Thank you for actually reading a readme file.

And big big thanks to @Rain92/OfficerAction , @NiLuJe, @NiMa and @Szybet for putting up with me on Discord, helping me setup my environment, walking me throught some Qt Kobo specific minefields and creating all those nice tools/libraries like QPA allowing me to develop this app.

Resources licensing (fonts, icons, pictures)

Everything used in this software is "free-to-use and share in any way" (tldr version). Still, credit is given where credit is due. You can find the details about who made what in the following file Resources Licenses and Details

For developpers, dummies, and future me. How to compile it ? And other dev related tricks and whatnot.

Please check the DevReadme.md file.