Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 3.87 KB

README.md

File metadata and controls

90 lines (67 loc) · 3.87 KB
Raw

Gudoku - Sudoku solving app

App for Sudoku solving written using awesome Godot Engine.

Warning

This is still in intense development! Bugs expected!

Features

  • Fully open-source and adds-free.
  • Linux + Windows + Android support.
  • In-app Sudoku generation and difficulty checking using Sudoku C++ Library.
  • Keyboard oriented desktop app. Use hjkl and m to move across the grid. More shortcuts are below.

Shortcuts

Shortcut Action
1-9 Toggle some number.
hjkl and arrows Move across the grid.
m + 1-9 + 1-9 Move across the grid. First number represents number of big square, second number represents number of small square. E.g. m12 will move you to x=0 y=1, m46 to x=2 y=4.
/ Switch between pencilmarks and clue mode
c Toggle clue mode.
p Toggle pencilmark mode.
H + 1-9 Highlight number.
HH Clear highlight.
s Save puzzle.

How to install

Windows, Linux

  1. Grab latest release for your platform (.zip archive).
  2. Unarchive it to some folder on your computer.
  3. Launch Gudoku executable.
  4. Optional: Create shortcut to Gudoku for quick access from desktop.
  • if you are using nixos, and binary does not run, check out this

Android

  1. Grab latest released .apk.
  2. Launch it on your phone.

Little tip for Android users. For all of my open-source apps, I use app manager Obtainium. Because this project is currently only on GitHub, you can't receive updates automatically if you only install .apk. But Obtainium can help you with this.

How to build

  1. If there is no extnesion in bin folder, grab (or build yourself) SudokuLib binding for your platform and put it into bin folder.
  2. Export project in Godot

Plans

  • Write better building documentation (build with godot-headless, for example)
  • Better generating engine with options.
  • Better file manager, especially for Android. There are PR to Godot, adding support for native file picker, but no one knows when it will be done and merged : (. And, as far as I know, there are no Android native file piker openers for Godot now.
  • Add colors to the grid.
  • Multiple selection.
  • Scanning Sudoku from image.
  • Parsing Sudoku from websites.
  • Built-in wiki with Sudoku methods description and app in general.
  • Statistics for solved puzzles.
  • Replay of solving.
  • Undo and redo.
  • New kinds of puzzles (like Killer Sudoku, and many others)

How you can help

If you know Java, you can write Android plugin that can open Android's native file manager.

If you are good at designing in Godot, you can help improve app design. Gudoku lacks good UI...

You can provide feedback about your experience with Gudoku in Issues tab. I'll be very glad if you do this