{"id":19342890,"url":"https://github.com/deven98/flutter_chess_board","last_synced_at":"2025-04-08T03:10:02.766Z","repository":{"id":32906825,"uuid":"145711640","full_name":"deven98/flutter_chess_board","owner":"deven98","description":"A Chessboard widget for Flutter.","archived":false,"fork":false,"pushed_at":"2023-02-13T20:43:41.000Z","size":3138,"stargazers_count":193,"open_issues_count":17,"forks_count":64,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-31T17:18:38.417Z","etag":null,"topics":["chess","chessboard","flutter","flutter-package"],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deven98.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-22T13:17:38.000Z","updated_at":"2025-01-08T18:13:42.000Z","dependencies_parsed_at":"2024-06-21T13:02:18.530Z","dependency_job_id":"a8427841-25ce-493d-b0c1-4df9fd03a0b4","html_url":"https://github.com/deven98/flutter_chess_board","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deven98%2Fflutter_chess_board","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deven98%2Fflutter_chess_board/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deven98%2Fflutter_chess_board/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deven98%2Fflutter_chess_board/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deven98","download_url":"https://codeload.github.com/deven98/flutter_chess_board/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767236,"owners_count":20992548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chess","chessboard","flutter","flutter-package"],"created_at":"2024-11-10T03:36:34.155Z","updated_at":"2025-04-08T03:10:02.742Z","avatar_url":"https://github.com/deven98.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flutter_chess_board\n\nA full-fledged Chessboard widget for Flutter. Includes the Chessboard widget, stores game \nstate, and includes a controller to check and manipulate game state. \n\nFull support for formats like PGN, FEN as well as ASCII. Supports multiple colors and displaying \narrows on the board. Easy access to making / undoing moves on the board. \n\nNote: v1.0+ is a major refactor and the earlier architecture which used `scoped_model` internally \nis no longer in use. The `ChessBoardController` now stores the state of the game as well as contains \noptions to change and check state. Arrows on the board are now supported.\n\n## Setting Up\n\nAdd a `ChessBoard` widget and attach a `ChessBoardController` to it.\n\nLet's also set the board color and specify the board orientation (default is towards white).\n\n```dart\nimport 'package:flutter/material.dart';\nimport 'package:flutter_chess_board/flutter_chess_board.dart';\n        \nclass HomePage extends StatefulWidget {\n  const HomePage({Key? key}) : super(key: key);\n\n  @override\n  _HomePageState createState() =\u003e _HomePageState();\n}\n\nclass _HomePageState extends State\u003cHomePage\u003e {\n  ChessBoardController controller = ChessBoardController();\n\n  @override\n  Widget build(BuildContext context) {\n    return Scaffold(\n      appBar: AppBar(\n        title: const Text('Chess Demo'),\n      ),\n      body: Center(\n        child: ChessBoard(\n          controller: controller,\n          boardColor: BoardColor.orange,\n          boardOrientation: PlayerColor.white,\n        ),\n      ),\n    );\n  }\n}\n```\n\nLet's try to display arrows on the board and also display moves of the current game:\n\n```dart\nimport 'package:flutter/material.dart';\nimport 'package:flutter_chess_board/flutter_chess_board.dart';\n        \nclass HomePage extends StatefulWidget {\n  const HomePage({Key? key}) : super(key: key);\n\n  @override\n  _HomePageState createState() =\u003e _HomePageState();\n}\n\nclass _HomePageState extends State\u003cHomePage\u003e {\n  ChessBoardController controller = ChessBoardController();\n\n  @override\n  Widget build(BuildContext context) {\n    return Scaffold(\n      appBar: AppBar(\n        title: const Text('Chess Demo'),\n      ),\n      body: Column(\n        children: [\n          Expanded(\n            child: Center(\n              child: ChessBoard(\n                controller: controller,\n                boardColor: BoardColor.orange,\n                arrows: [\n                  BoardArrow(\n                    from: 'd2',\n                    to: 'd4',\n                    color: Colors.red.withOpacity(0.5),\n                  ),\n                ],\n                boardOrientation: PlayerColor.white,\n              ),\n            ),\n          ),\n          Expanded(\n            child: ValueListenableBuilder\u003cChess\u003e(\n              valueListenable: controller,\n              builder: (context, game, _) {\n                return Text(\n                  controller.getSan().fold(\n                        '',\n                        (previousValue, element) =\u003e\n                            previousValue + '\\n' + (element ?? ''),\n                      ),\n                );\n              },\n            ),\n          ),\n        ],\n      ),\n    );\n  }\n}\n```\n\nThis gives us:\n\n![alt text](https://github.com/deven98/flutter_chess_board/blob/master/screen_shot_4.png)\n\n### Watch for game changes\n\nYou can listen to game state changes (move, half moves, etc) using either a listener or a `ValueListenableBuilder`:\n\n```dart\n  ChessBoardController controller = ChessBoardController();\n  \n  @override\n  void initState() {\n    super.initState();\n    controller.addListener(() {\n      // Do something here\n    });\n  }\n```\n\n```dart\n  ValueListenableBuilder\u003cChess\u003e(\n    valueListenable: controller,\n    builder: (context, game, _) {\n      // Build on new game state\n    },\n  ),\n```\n\n## Checking Game States\n\nThe `ChessBoardController` holds the game itself and you can do various kinds of things using it:\n\n### Load New Game\n\n`controller.loadPgn('demo PGN')`\n\n`controller.loadFen('demo FEN')`\n\n### Make Move:\n\n`controller.makeMove(from: 'd2', to: 'd4')`\n\n### Undo Move:\n\n`controller.undoMove()`\n\n### Check states:\n\n`controller.isCheckMate()`\n\n`controller.isDraw()`\n\n`controller.isStaleMate()`\n\n`controller.isThreefoldRepetition`\n\n...and more...\n\n### Move Count \n\n`controller.getMoveCount()`\n\n`controller.getHalfMoveCount()`\n\n### Other Board Types\n\n![alt text](https://github.com/deven98/flutter_chess_board/blob/master/screen_shot.png)\n\n![alt text](https://github.com/deven98/flutter_chess_board/blob/master/screen_shot_2.png)\n\n![alt text](https://github.com/deven98/flutter_chess_board/blob/master/screen_shot_3.png)\n\n### Import the package \n\nTo use this package, [add chess_board as a dependency](https://pub.dartlang.org/packages/flutter_chess_board#-installing-tab-) in your pubspec.yaml\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeven98%2Fflutter_chess_board","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeven98%2Fflutter_chess_board","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeven98%2Fflutter_chess_board/lists"}