README.md

Sapla

A cool flashcard app made in QT! It is extremely flexible and allows you to make flashcards as easy or complicated as you want extremely efficiently by having many complex mechanics built on simple fundamentals. Go as complex as you desire!

If you need any help, please use the Help -> App help (or Help -> This screen help for more specific things).

How it works

There are Decks which contain Notes which generate (using note features) Cards. Decks are like different subjects, Notes are like different concepts, and Cards are the physical flashcards that you study.

Screenshots

Home screen Browse scene Playing the default game Playing the default game with the winter colour scheme plugin Playing the grid game (a plugin) with the winter colour scheme

Features

• Example cards, comprehensive help screens and quick references to help you and explain every feature

Decks

• Can add, copy, rename and delete decks of notes!
• Can make temporary decks that vanish on the next app load (or manually)

Notes & cards

• Browse all your notes, edit them, delete them or add more
• Many different card features!
• Example cards to help
• A note preview which also reveals errors
• Extended markdown support
  • Including underlines and highlights!
  • Markdown editors that reveal text underneath on selection
• Saves notes to a file automatically as you type
• Tags for ease of sorting
• Scheduling - cards revised based on their schedule time!
• Rate whether you know the card based on a scale and it reschedules accordingly!

Note features

• Single/double sided notes
• Hidden text (gradually hides more as you get better)
• Random text
• Word scrambling And much, much more!

Gameplay

• Grow a tree with your answers
• Different short flashcard 'games' to test your knowledge in different ways

App

• Whole app setings and per-deck settings (tho currently not used much)
• Neat logging with popups and a log view
• Custom UI svgs hand drawn by me that change colour based on the theme
• Responsive layout
• Dynamic menubar

Customisability

• Ease of plugin creation through the extensable code structure
• Import/disable/remove plugins
• Plugins can add new games, features, change the colour scheme and more!

Templates

• Note templates for creating many custom fancy notes with ease!
• Global and local templates
• Custom argument parsing with fancy options

Plugins

• Built in plugin which comes with the app, which adds
  • A simple flashcard game - just a regular flashcard
• Grid plugin, which adds
  • A flashcard game - multiple flashcards in a grid you have to work through
• Winter plugin, which adds
  • A new colour theme

Usage instructions

If you need help on anything, look at the help > this screen help or help > application help

Getting it

The easy way

Download the executable from the releases tab

The hard way (build from source)

• Ensure you have cmake installed (on any Linux just install cmake)
• Ensure QT is installed (and the svg library too)
  • For Linux, find which package it is.
    • Ubuntu:

    sudo apt install qt6-base-dev qt6-svg-dev
    

    • Arch:

    sudo pacman -S qt6-base qt6-svg
    

    • Nix:

    nix-shell -p cmake qt6.qtbase qt6.qtwayland
    

• Then to publish as an appimage run ./publish.sh or make publish (you can also run make debug or make build to just build it)

Automatic building and packaging

./publish.sh

Run ./publish.sh --help for usage options

Manual building

cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
cmake --build build --parallel

Then go find the executable in the build folder! (Usually at the top level)

If you want to package it run ./publish.sh -built build (or wherever the output folder is)

Windows

You're on your own. There was literally no nice way I could think of to do it on windows, I tried for a while then gave up. You could probably compile it with QT creator or something, but there may be a few 'windows bein silly' bugs as I haven't Windows-proofed the app in a while.