README - randomcrap - random crap programs of varying quality
 (HTM) git clone git://git.codemadness.org/randomcrap
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       README (1322B)
       ---
            1 chess diagram scanner
            2 
            3 
            4 # Usage:
            5 
            6 python3 main.py < someimage
            7 
            8 Output is in the FEN format, one line per diagram.
            9 
           10 
           11 # Dependencies
           12 
           13 - python3
           14 - opencv2
           15 
           16 
           17 # Features
           18 
           19 - Automatically detect the board style.
           20 - Simple FEN output and easy to use this way with other chess programs.
           21 - Check basic castle rights.
           22 
           23 
           24 # How to add a board style:
           25 
           26 - Setup the pieces on the board using FEN boardstyles/fen.txt.
           27 - Save the board has a high-resolution PNG image in boardstyles/. 
           28 
           29 
           30 # Limitations and room for improvement
           31 
           32 There are many limitations and there is much room for improvement.
           33 This diagram scanner was written to convert diagrams from the book "The
           34 Woodpecker Method" to a digital format.
           35 
           36 - Does not detect flipped boards yet (only from white its side).
           37 - There should probably be some image filter/threshold for pieces, so
           38   highlighted squares or slightly different piece colors are better detected.
           39 - Scan speed could still be faster (0.5 seconds per diagram on my machine).
           40   For example it would be cool to be able to detect boards very fast from a video
           41   stream (although using the Lichess API makes more sense here).
           42 - No support for misalignment/skewed images yet.
           43   This could be useful for photographed or physically scanned books.
           44   But maybe this is out of the scope of this program and could be a pre-pass.