dnfield / flutter-chessground

Chessboard package for flutter

Chessground is a chessboard package developed for lichess.org. It doesn't handle chess logic so you can use it with different chess variants.

Features

• pieces animations: moving and fading away
• board highlights: last move, piece destinations
• move piece by tap or drag and drop
• displays a shadow under dragged piece to indicate the drop square target
• board themes
• promotion selector

Getting started

This package exports a Board widget which can be interactable or not. It is entirely configurable with a Settings object.

Usage

This will display a board with the starting position, using the default theme:

import 'package:flutter/material.dart';
import 'package:chessground/chessground.dart' as cg;

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String fen = 'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR';

  @override
  Widget build(BuildContext context) {
    final double screenWidth = MediaQuery.of(context).size.width;

    return Scaffold(
      appBar: AppBar(
        title: const Text('Chessground demo'),
      ),
      body: Center(
        child: cg.Board(
          size: screenWidth,
          orientation: cg.Color.white,
          fen: fen,
        ),
      ),
    );
  }
}

See the example app for an interactable version against a random bot.