Search packages, repositories and app categories

GitHub repositoryalexobviously/squares

squares

A flexible chessboard widget for Flutter

squares project cover
Stars
40
Forks
19
Last push (UTC)
Aug 8, 2023
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

Squares

A flexible chessboard widget for Flutter.

Squares is a chessboard like you've never seen before. Or more accurately, it is a chessboard very much like the ones you have seen before, but one that can do a pretty wide variety of things.

It is a UI package only, meaning it doesn't handle game logic. The Bishop package is recommended for game logic, and there is also a small interoperability package, Square Bishop that provides convenience methods for common type, a state for Squares to use, and extension methods on Bishop.Game that generate it.

There are two examples: a simple one in around 100 lines, and a more complex and featureful app that demonstrates the various features of Squares in a realistic architecture.

Squares has a stateless Board widget that can used to display a complete board representation, and can be integrated at a low level with your own UI logic. However, the more likely use case involves the BoardController widget, which implements all of the piece selection and movement logic you're likely to need, including premoves and piece promotion.

Features
  • Highlighting previous moves, possible moves, check/checkmate

  • Board themes

  • Marker themes

  • Piece animations

  • Premoves

  • Supports arbitrary board sizes and pieces



  • Piece promotion

  • Flexible piece set definitions - any widget will do, use an svg, image asset, text, etc

  • Dropping pieces from hands (à la Crazyhouse)

Alex Baker GitHub avatar
GitHub author

Alex Baker ↗

generative art and music, dart, flutter apps, chess stuff, etc

A medtech company
LanguagesDartC++CMakeHTMLRubySwiftCKotlinObjective-C

Categories

Packages published by this repository

Dependencies used

Dependency list 5 items

  • flutter{"sdk":"flutter"}
  • badges^3.0.2
  • equatable^2.0.5
  • flutter_testDevelopment{"sdk":"flutter"}
  • lintsDevelopment^2.0.0

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗