#chess

chessground

A chessboard widget for Relm/GTK

11 releases (7 breaking)

0.8.0 Jun 5, 2018
0.7.0 Mar 25, 2018
0.6.0 Mar 3, 2018
0.5.0 Jan 24, 2018
0.1.3 Aug 30, 2017

#74 in Games

Download history 46/week @ 2019-03-21 13/week @ 2019-03-28 14/week @ 2019-04-04 6/week @ 2019-04-11 1/week @ 2019-04-18 13/week @ 2019-04-25 13/week @ 2019-05-02 22/week @ 2019-05-09 18/week @ 2019-05-16 25/week @ 2019-05-23 30/week @ 2019-05-30 45/week @ 2019-06-06 1/week @ 2019-06-13 37/week @ 2019-06-20 167/week @ 2019-06-27

67 downloads per month

GPL-3.0+

130KB
1K SLoC

rust-chessground

crates.io

A chessboard widget for Relm/GTK. Inspired by chessground.js.

Features

  • Uses vocabulary from Shakmaty but is chess rule agnostic
  • Can show legal move hints
  • Check hints
  • Move pieces by click
  • Move pieces by drag and drop
    • Minimum distance
    • Piece ghosts
  • Draw circles and arrows on the board
  • Integrated promotion dialog
  • Smooth animations

Only a minimum of the features is exposed in the public API. Feel free to request more.

Documentation

Read the documentation

Example

A board that lets the user freely move pieces. Run with cargo run --example editor.

#![feature(proc_macro)]

extern crate gtk;
extern crate chessground;
#[macro_use]
extern crate relm;
extern crate relm_attributes;
#[macro_use]
extern crate relm_derive;
extern crate shakmaty;

use gtk::prelude::*;
use relm::Widget;
use relm_attributes::widget;

use shakmaty::{Square, Board};
use chessground::{Ground, UserMove, SetBoard};

use self::Msg::*;

#[derive(Msg)]
pub enum Msg {
    Quit,
    PieceMoved(Square, Square),
}

#[widget]
impl Widget for Win {
    fn model() -> Board {
        Board::default()
    }

    fn update(&mut self, event: Msg) {
        match event {
            Quit => gtk::main_quit(),
            PieceMoved(orig, dest) => {
                if let Some(piece) = self.model.remove_piece_at(orig) {
                    self.model.set_piece_at(dest, piece, false);
                    self.ground.emit(SetBoard(self.model.clone()));
                }
            }
        }
    }

    view! {
        gtk::Window {
            title: "Chessground",
            #[name="ground"]
            Ground {
                UserMove(orig, dest, _) => PieceMoved(orig, dest),
            },
            delete_event(_, _) => (Quit, Inhibit(false)),
        }
    }
}

fn main() {
    Win::run(()).expect("initialized gtk");
}

Piece sets

Set Author License
Merida Armando Hernandez Marroquin GPL-2+

License

Chessground is licensed under the GPL-3.0 (or any later version at your option). See the COPYING file for the full license.

Dependencies

~13MB
~322K SLoC