Mobile-SR

by KfirG
5
4
3
2
1
Score: 50/100

Description

Spaced Repetition with mobile support

Reviews

No reviews yet.

Stats

1
stars
218
downloads
0
forks
57
days
5
days
5
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
35
commits

Latest Version

5 days ago

Changelog

Sentence cards

Learn definitions and quotes word for word. Add the #sentences tag to a deck note (next to #flashcards) and wrap the key words in **bold** or ==highlight==: these anchor words are never hidden.

  • Gradual deletion: new cards walk through stages, from the full sentence to anchor words only. Later reviews open at the last stage, and Show more words brings back one stage at a time.
  • Fill in the blanks: every hidden word is a field. Type the missing words and select Check to see which ones are right. Turn it off with Type into sentence blanks.
  • Check yourself: the answer side marks the hidden words and the ones you got wrong. Tap a word to change its mark, and turn a missed word into an anchor with one tap (★).
  • Sentences or flashcards: each sentence deck on the dashboard can be studied as sentences or as ordinary cards. The choice is kept per deck.
  • Works with a remote (new action Show more words) and with read aloud. Sentence decks are left out of Blast, Match and Hangman.

📘 Tutorials

Short hands-on lessons for every feature except the games: reviewing, hints, reversed cards, type before reveal, sentence cards, read aloud, the remote, and a playground for writing your own cards with a live preview. Open them from the dashboard, the settings, or the command Open tutorials. Nothing in a tutorial is saved, and finished tutorials are marked as completed.

README file from

Github

Mobile-SR

Spaced repetition for Obsidian that works on your phone, with five games to make the practice stick.

Write flashcards in plain Markdown, review them with the FSRS scheduler on desktop or mobile, and when you are tired of flipping cards, shoot asteroids, race the clock or save the hangman using the same decks. Keeping up with your reviews unlocks new ships, designs and weapons in the games.

Play your decks

Every game has its own menu, and each one keeps your records. The games are practice only: they never change your review schedule, so you can play as much as you like without disturbing FSRS.

🚀 Blast

A question appears at the top and asteroids carrying answers float around the space above your ship. Shoot the right one.

  • You have 60 seconds per level to reach the target: 50 points on level 1, 100 on level 2, and so on.
  • The first hit is worth 5 points, and every hit in a row raises the multiplier.
  • A wrong shot costs 2 points and resets your streak.
  • Higher levels bring more asteroids that move faster.
  • Your high score and best streak are saved.

🧩 Match

Six random cards from your deck are split into twelve tiles. Pair each question with its answer and clear the board as fast as you can.

  • The clock counts up and a wrong match adds one second.
  • Your best time is saved separately for every deck.

🪢 Hangman

One side of a card is the clue, the other is hidden. Guess it letter by letter before the figure is complete.

  • Six wrong letters end the run. Your score is how many cards you solve in a row, saved per deck.
  • Stuck? Reveal up to half of the letters one at a time, or skip the card without breaking your streak.
  • Works in any alphabet. The on-screen keyboard follows the script of the hidden word, and a physical keyboard works too.

👾 Aliens

A 2D arcade shooter that is a reward for studying rather than a quiz. Steer the ship by dragging, with the mouse or with the arrow keys; it fires by itself.

  • Three levels: scouts, raiders and the mothership.
  • You have three lives. The number of levels is fixed, so your record is the fastest time in which you clear them all.
  • Five weapons, from the basic blaster to the Nova Storm. Which ones you can use depends on your reviews (see below).

⚔️ Sword

A second reward game: a warrior with a sword against monsters that close in from both sides.

  • Move left and right with the arrow keys or the on-screen buttons, and click or tap the arena to swing the sword in that direction.
  • Three levels, ending with a boss. Your record is the fastest time in which you clear them all.
  • Five swords, from wooden to legendary, each stronger and longer than the last. Which one you carry depends on your reviews (see below).

Open the games from the Games section at the bottom of the dashboard, or with the commands Play Blast Game, Play Match Game, Play Hangman Game, Play aliens game and Play sword game.

⭐ Unlocks

Your regular reviews are what upgrade you in the games. By default the plugin counts the cards you have reviewed that are not due again yet, and every 50 of them opens the next item:

  • Blast: five ship designs.
  • Match: five card designs.
  • Hangman: five figure designs.
  • Aliens: five weapons.
  • Sword: five swords.

Fall behind on your reviews and the count drops, so the items lock again until you catch up. In the settings you can count the reviews you did in the last 24 hours instead. The games only read your progress; they still never change it.

🎵 Music

Each game has its own playlist, set up under Music in the game's menu.

  • Add as many audio files of your own as you like (MP3 and other common formats). They are copied into a game-music folder in your vault, next to the game records, so they sync with your notes.
  • Four built-in electronic tracks are included. They are generated by the plugin itself, so they are free of copyright. Choose which of them play in which game.
  • Tracks are picked at random and play one after another.

Review without looking: remote control and read aloud

Review on a walk or with your hands busy: a cheap Bluetooth ring or page-turner remote rates the cards, and the plugin reads them to you.

🎮 Remote control

Works with remotes that send swipes and taps to the phone (the kind sold for scrolling short videos or turning e-book pages), and with remotes that send keyboard keys.

  • Bind any button to any action: flip / show answer, show hint, next card (skip), previous card, rate Again / Hard / Good / Easy, exit the review, and read the card aloud again. Select Listen… next to an action and press the button on the remote.
  • Only the remote is caught. Swipes from the remote are told apart from your finger, so normal scrolling still works. The remote is active only while a review is open.
  • Double tap on the center button is an extra input. Turn it off to make every tap instant.
  • Skip and go back. A skipped card comes back at the end of the session. Going back to a card you already rated lets you rate it again, and the new rating replaces the earlier one.
  • Buttons stay the same when you rotate the phone. A remote's swipes turn with the screen, so its buttons would change actions in landscape. The plugin corrects this; you can turn it off in the settings.
  • Presets for several remotes. Each remote keeps its own bindings and sensitivity; pick the active one in the settings.
  • Test remote shows every detected press and the action it is bound to, and sliders tune the sensitivity.
  • Remote tutorial: a short practice deck that walks through every action. Nothing in it is saved. Start it from the settings or with Remote: start tutorial.
  • Remote: open input logger lists the raw events that reach the app, for setting up a remote that behaves differently.

🔊 Read aloud

  • Reads the question when a card opens, and the answer when you flip it.
  • Can say what the remote did ("Good", "Skipped") before the next card, so you know the right button was pressed.
  • Text in two languages within one card is read part by part, each with a voice for its language.
  • Voice engines: the voices built into your device, a free online voice, or Google Cloud Text-to-Speech with your own API key. Automatic uses the device voices when the app has them and online speech otherwise (Obsidian on Android has no built-in voices).
  • The next side and the next card are downloaded ahead of time, so there is no wait between cards.
  • Mute button. Every review has a speaker button at the top, so you can turn reading off and back on at any moment. Your choice carries over to the next session.

The API key is optional. Read aloud works without one; you only need it if the free online voice fails, for example behind a VPN or on another shared network. To use Google Cloud, enable the Cloud Text-to-Speech API in a Google Cloud project, create an API key, restrict it to that API, and paste it in the settings. Check key confirms it works and lists the available voices.

Network use and privacy

Reviews, the games and your records work fully offline. Your game records are personal bests kept in your own vault.

The only network use is the optional read aloud feature, and only when it uses online speech: the text of the card being read is sent to Google to turn it into audio. With device voices nothing leaves your device. A Google Cloud API key is stored in the plugin's data.json, which syncs with your vault, so restrict the key to the Text-to-Speech API.

Features

  • Built for mobile. Everything works on Android and iOS: reviews, the dashboard and all five games.
  • Hands-free reviews. Rate cards with a Bluetooth remote and have them read aloud (see above).
  • FSRS scheduling. Cards come back just before you would forget them.
  • Plain Markdown cards. A deck is just a note. No special editor and no lock-in.
  • Syncs like a note. Your progress is stored in a Markdown file inside the vault, so any sync that handles your notes also carries your review schedule between devices.
  • Dashboard. See every deck with its due cards, start a session for one deck, and search a table of everything you have reviewed with its next due time.
  • Reversed cards. One card can be studied in both directions.
  • Sentence cards. Learn definitions and quotes word for word: words disappear in stages until only your bolded anchor words remain.
  • Hints. Mark a deck as a hint deck and each card gets a Show hint button. A setting turns it into small, faded text, so it is easier to resist.
  • Type before reveal. Turn this on and you must type an answer and submit it before the back of the card appears, with your answer shown next to it. It stops the "I knew that" feeling.
  • Edit while reviewing. Fix a typo in a card without leaving the session.
  • Interval previews. The rating buttons can show when the card will return (for example 10m, 3d, 2mo).
  • Deck cleanup. One command fixes spacing and removes duplicate cards from a note.
  • Self-cleaning data. Cards you delete from your notes are removed from the saved schedule automatically.
  • Right-to-left friendly. Decks and cards in right-to-left languages display correctly.

Installation

Simply get it from obsidian community , but here are some alternatives:

  1. Install the BRAT plugin from Settings → Community plugins → Browse and enable it.
  2. Open Settings → BRAT → Add beta plugin.
  3. Paste https://github.com/kfirgumay2005-hash/Mobile-SR and select Add plugin.
  4. Enable Mobile-SR in Settings → Community plugins.

This works the same way on mobile.

Manually

  1. Download main.js, manifest.json and styles.css from the latest release.
  2. Put them in <your vault>/.obsidian/plugins/mobilesr/ (create the folder if needed).
  3. Reload Obsidian and enable Mobile-SR in Settings → Community plugins.

Writing cards

A deck is a note that contains the #flashcards tag. The note's name is the deck's name. Each card sits between two lines that contain only a hyphen, with a line containing only ? between the question and the answer:

#flashcards

- What is the capital of France?
  ?
  Paris
- enigma
  ?
  A mystery; something that cannot be deciphered.
-
  • The hyphen lines matter. Every card needs a - line before it and after it. Neighbouring cards share the hyphen between them.
  • Reversed cards: use ?? instead of ? to study the card in both directions.
  • Hints: add the #hint tag to the note as well. The first line of each card is then the question, and any lines between it and the ? are hidden behind a Show hint button.

Sentence cards

For text you must know word for word, such as definitions and quotes, add the #sentences tag to the note as well. The card format stays the same: a short title, the ? line, then the full sentence, which may run over several lines. Wrap the key words of each part in **bold** or ==highlight==: these anchor words are the skeleton of the sentence and are never hidden.

#flashcards #sentences

-

Balfour Declaration
?
The British government **views with favour** the establishment in Palestine of a **national home** for the Jewish people, and will use its **best endeavours** to facilitate this.
-
  • Gradual deletion. The sentence is shown in stages: the full sentence, then about a third of the other words hidden, then about two thirds, then only the anchor words. Hidden words become blanks about as long as the word; punctuation and line breaks stay.
  • New cards walk through all four stages in one sitting: recite the sentence, then flip to hide more words. After the last stage, flipping shows the full sentence and the rating buttons.
  • Later reviews open at the anchor-words stage. Show more words brings back one stage at a time, like a hint. Each card still gets one rating, scheduled by FSRS as usual.
  • Fill in the blanks. Every hidden word is a small field. Type the missing words and select Check (Enter moves to the next field and checks after the last one): right words turn green, wrong ones red. Fields you leave empty are fine, for when you would rather say the words aloud. Turn the fields off with Type into sentence blanks.
  • Check yourself. The answer side highlights the words that were hidden and lists each blank you typed wrong next to the right word; those words start out marked as missed. With the fields off and Type answer before reveal on, what you typed is compared word by word, ignoring punctuation, case, spacing and vowel marks: missing words show in red and wrong or extra words in orange. Otherwise tap the words you missed.
  • Make anchor. Every missed word gets a one-tap button that makes it bold in the note itself, so it stays visible from then on.
  • With a remote, the flip button moves through the stages, and Show more words can be bound to a button of its own. Read aloud reads the title, then the full sentence on the answer side.
  • Sentences or flashcards. A sentence deck on the dashboard has two small buttons, Sentences and Flashcards. Pick Flashcards to study it as ordinary cards (question, then the whole answer) for a while. The choice is kept for each deck until you change it, and both ways share the same schedule.
  • Sentence decks are left out of Blast, Match and Hangman, but their reviews count toward unlocks. ?? works like ? in these decks.

Importing a deck

To bring in a deck from somewhere else (for example Quizlet), paste it into an AI assistant and ask it to put a ? line between each term and its meaning, add the hyphen lines, and return plain text. Paste the result into a note and run Fix Cards Spacing and Remove Duplicates to tidy it up.

Using the plugin

Select the plugin's icon in the ribbon, or run Mobile-SR: Open.

📘 Tutorials

New to the plugin? Open Tutorials from the dashboard, from the settings, or with the command Open tutorials. Each tutorial is a short practice review that you work through yourself, and nothing in it is saved: your schedule, notes and unlocks stay as they are.

  • Reviewing cards: flip, rate, fix a card while reviewing, and the dashboard.
  • Hints, Reversed cards, Type before reveal and Sentence cards: each feature on cards you can try out.
  • Read aloud: turn reading on and learn its settings.
  • Remote control: every remote action, using your current bindings.
  • Write your own cards: type or paste cards and see at once how the plugin reads them. Fix their spacing, remove duplicates, copy the text into a note, or try the cards in a practice review.

A tutorial is marked ✓ Completed once you rate its last card, and the menu shows how many you have finished. Reset progress clears the marks.

  • Decks: each deck shows how many cards are due and has its own Start button for a session with that deck only.
  • Reviewed flashcards status: a searchable table of the cards you have studied, with the time left until the next review and the current interval.
  • Games: Blast, Match, Hangman, Aliens and Sword.

Settings

Setting What it does
Target request retention How likely you want to be to remember a card when it comes up. Higher means more frequent reviews.
Maximum interval The longest gap, in days, allowed between two reviews of a card.
Flashcard deck tags / Hint deck tags The tags that mark a note as a deck or as a hint deck.
Sentence deck tags The tags that mark a deck as a sentence deck (default #sentences), studied word for word in stages.
Type into sentence blanks In sentence cards, type the hidden words into fields and check them (on by default).
Show interval previews Show the next review time on the rating buttons.
Duplicate detection mode Whether the cleanup command treats cards as duplicates when they are identical or when they share a first line.
Data folder path The vault folder where your review progress is saved.
Remote control Turn the remote on, choose the active remote, bind its buttons, test it, tune its sensitivity, and start the tutorial.
Read aloud Turn reading on, choose the voice engine and voices, the speech rate, and whether the answer and the remote's actions are spoken.
Games Sound effects, what the unlocks are based on, where the game records are saved, and a button to reset them.

Mobile-Translate is my other plugin. Its output builder can create new cards at the press of a button when configured for this card format.

License

0-BSD