Skip to content
garblesPublic

About

Simply the best way to play Sudoku. Feels like pen and paper. Does the work that paper cannot.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

159 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sudoku for reMarkable Paper Pro and Paper Pro Move

Note

The app has not been tested on a real Paper Pro Move. Only the design images and the tests on the computer examine the Paper Pro Move version. If you have a Paper Pro Move and you find a problem, please open an issue.

A Sudoku game for the color e-ink display. It is the best way to play Sudoku: it feels like pen and paper, and it does the work that paper cannot do.

Demo: pencil marks, numbers, a clash, the Cell colors menu and the eraser

Features

Play with the pen

  • Handwriting: Write your numbers in the cells, as on paper.
  • Pencil marks: Keep track of the possible digits in each cell.
  • Eraser: Remove your numbers with the eraser end of the pen.

Helpers

  • Hide impossible pencil marks: Pencil marks that are no longer possible are hidden.
  • Clashes: See a repeated digit in a row, column or box immediately.
  • Highlight on tap: Tap a number to highlight them all.
  • See completed groups: Highlight your progress in each row, column and box.
  • Checkpoints: Use the Nishio strategy without having to manually undo your failed attempt.

Puzzles

  • 7 difficulty modes: Play at your level, from Easy to Hard.
  • Toggleable symmetry: Optionally play non-symmetrical puzzles.
  • One solution: Each puzzle has a unique solution. No guessing.

Other

  • Statistics: Follow your times and your completed games.
  • Portrait and landscape mode: Hold your reMarkable in any way you like.
  • Autosave: Game saves after every move.
  • Updates: Install application updates with one tap.

Installation

You need a computer with macOS or Linux and a reMarkable Paper Pro or Paper Pro Move in developer mode. Run the step-by-step installer in your terminal:

curl -fsSL https://github.com/garbles/sudoku/releases/latest/download/install.sh | bash

The script can occasionally fail; however, the steps are idempotent so running it again does not have any adverse effect.

Manual installation

If you would rather install this application manually:

  1. Install the AppLoad launcher with Vellum. Sudoku needs AppLoad 0.6.0 or newer. If your AppLoad is older, update it with vellum update && vellum add -u appload:

      vellum add appload
      /home/root/xovi/rebuild_hashtable
  2. Download sudoku-<version>.tar.gz from the Releases page. Extract the archive to dist/ (mkdir -p dist && tar -xzf sudoku-<version>.tar.gz -C dist). Alternatively, you can build it yourself.

  3. Start xovi and install the power-button starter. The user interface of the tablet starts again:

      ssh root@10.11.99.1 /home/root/xovi/start
      ssh root@10.11.99.1 '/home/root/.vellum/bin/vellum update && /home/root/.vellum/bin/vellum add tripletap'

    After a restart of the tablet, press the power button 3 times to start xovi.

    After an update of the tablet software, run /home/root/.vellum/bin/vellum upgrade, /home/root/.vellum/bin/vellum reenable, /home/root/xovi/rebuild_hashtable and /home/root/xovi/start.

  4. If you have an older version of Sudoku that used an ink patch, delete the patch and its stamp file from the tablet. Sudoku does not use them now:

      ssh root@10.11.99.1 "rm -f /home/root/xovi/exthome/qt-resource-rebuilder/sudoku-penregion.qmd /home/root/xovi/exthome/qt-resource-rebuilder/sudoku-penregion.json"
  5. Copy the dist/sudoku folder to the tablet and make the program executable:

      scp -r dist/sudoku root@10.11.99.1:/home/root/xovi/exthome/appload/
      ssh root@10.11.99.1 "chmod 755 /home/root/xovi/exthome/appload/sudoku/sudoku /home/root/xovi/exthome/appload/sudoku/backend/entry"

    10.11.99.1 is the address of the tablet on a USB connection. On Wi-Fi, use the IP address of the tablet.

  6. AppLoad reads the list of apps only when the interface starts. Thus, when the folder sudoku was not on the tablet before, or the installed Sudoku was a release from before the frontend, start the interface again with ssh root@10.11.99.1 /home/root/xovi/start. (A tap on Reload in the AppLoad menu is an alternative.) Then open AppLoad and tap Sudoku.

Build

You need:

  • The Rust toolchain, to run the tests on your computer (macOS or Linux).
  • Docker, to build the program for the tablet.
  • The reMarkable Sans font files scripts/fonts/rmsans-400.ttf and scripts/fonts/rmsans-500.ttf. reMarkable owns the font, so the repository does not contain these files. The tests and the Docker builds of the tests, the images and the videos need them. scripts/fonts/README.md tells how to make them from a tablet.
Task Command
Run all tests cargo test
Run all tests on aarch64 Linux docker build --platform linux/arm64 -f Dockerfile.test .
Build for the tablet (no tests) docker build --platform linux/arm64 --output type=local,dest=dist .

The Docker build makes the folder dist/sudoku/. It contains the program sudoku, the AppLoad manifests manifest.json and external.manifest.json, the interface file resources.rcc, the starter backend/entry and the launcher icon icon.png.

You can push development builds over SSH after running rm-ssh-over-wlan on on the tablet. Store the address at REMARKABLE_HOST in .env and make install-dev will use it to push over wifi. To keep the address of your tablet, copy .env.sample to .env and set REMARKABLE_HOST (git ignores .env).

AGENTS.md gives the other tools (reference images, demo video, performance bench, tablet self-test) and the release procedure.

Developing

See the full list of commands by running:

make help

The source code is for the agents. It is pure slop, so you should probably not try to change it manually.

I'm not interested in contributions that:

  • Refactor the code.
  • Bump libraries.
  • Add new features. Please open an issue.

License

MIT

The app contains open source components with their own licenses. scripts/licenses.py collects them from cargo metadata into assets/licenses.json, and the app shows them (Settings > Third-party licenses). After a change of Cargo.lock, run python3 scripts/licenses.py (a test fails if the file is not up to date).

About

Simply the best way to play Sudoku. Feels like pen and paper. Does the work that paper cannot.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages