2 ;;; chess.el --- Play chess in Emacs
4 ;; Copyright (C) 2001 John Wiegley <johnw@gnu.org>
6 ;; Emacs Lisp Archive Entry
10 ;; Author: John Wiegley <johnw@gnu.org>
11 ;; Maintainer: John Wiegley <johnw@gnu.org>
12 ;; Description: Play chess in Emacs
13 ;; URL: http://www.gci-net.com/~johnw/Emacs/packages/chess.tar.gz
14 ;; Compatibility: Emacs20, Emacs21, XEmacs21
16 ;; This file is not part of GNU Emacs.
18 ;; This is free software; you can redistribute it and/or modify it under
19 ;; the terms of the GNU General Public License as published by the Free
20 ;; Software Foundation; either version 2, or (at your option) any later
23 ;; This is distributed in the hope that it will be useful, but WITHOUT
24 ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
25 ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
28 ;; You should have received a copy of the GNU General Public License
29 ;; along with GNU Emacs; see the file COPYING. If not, write to the
30 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
31 ;; MA 02111-1307, USA.
35 ;; Welcome to Emacs Chess, a chess playing module for GNU Emacs.
37 ;; This program will not play chess against you; it is not a chess
38 ;; computer. It can use a chess computer, however, to simulate your
39 ;; opponent's moves. This is decided when you choose your opponent.
40 ;; You must, of course, have that chess computer installed. See the
41 ;; top of chess-player.el for more information.
43 ;; To just get a chessboard up, put the following in your .emacs file:
45 ;; (add-to-list 'load-list "<the path to Emacs Chess>")
47 ;; (autoload 'chess "chess" "Play a game of chess" t)
49 ;; Now you can type `M-x chess', and play chess against anyone else in
50 ;; the room with you, without having to install anything more.
52 ;; Once this is working, the next thing to do is to customize
53 ;; `chess-use-modules'. This is a list of functionality modules used
54 ;; by chess.el to provide its functionality. You can enable or
55 ;; disable modules so that Emacs Chess better suites your tastes.
56 ;; Those modules in turn often have configuration variables, and
57 ;; appropriate documentation at the top of the related file.
59 ;; Emacs Chess is designed in a highly modular fashion, using loosely
60 ;; coupled modules that respond to events on the chess board. This
61 ;; makes it very easy for programmers to add their own types of
62 ;; displays, opponents, analysis programs, etc. See the documentation
63 ;; in chess-module.el to learn more.
65 ;; There is no documentation for this program other than what exists
66 ;; in the source files. This is because the source files aim at being
67 ;; self documenting, and as chess is such a simple game, most chess
68 ;; players aren't going to need to know much about this program in
71 ;; However, most people will probably be interested in reading the top
72 ;; of chess-display.el and chess-pgn.el, which describe the user
73 ;; interface commands available in each of those buffer types.
80 (require 'chess-display)
81 (require 'chess-engine)
85 "An Emacs chess playing program."
87 (defconst chess-version "2.0a4"
88 (defconst chess-version "2.0a7"
89 "The version of the Emacs chess program.")
91 (defcustom chess-default-display (if (display-graphic-p)
92 'chess-images 'chess-ics1)
93 "Default module set to be used when starting a chess session."
97 (defcustom chess-default-engine 'chess-gnuchess
98 "Default engine to be used when starting a chess session."
101 (defcustom chess-announce-moves t
102 (defcustom chess-announce-moves t
103 This happens verbally if 'festival' is installed, otherwise it just
104 prints a message in your minibuffer, which works well for Emacspeak
106 minibuffer, which works well for Emacspeak users."
110 (defun chess (&optional arg)
111 "Start a game of chess."
113 (let ((game (chess-game-create)) ; start out as white always
116 (game (chess-game-create)))
119 (require chess-default-display)
120 (let ((display (chess-display-create chess-default-display my-color)))
121 (chess-display-set-game display game)
122 (chess-display-set-main display))
123 (chess-display-set-main display)
126 (intern (or (read-string "Engine module to play against: ")
128 chess-default-engine)))
129 (let ((engine-module (or engine chess-default-engine)))
130 (chess-engine-set-game (chess-engine-create engine-module) game)
131 (chess-engine-command engine 'ready))
132 (when chess-announce-moves
133 (require 'chess-announce)
134 (chess-announce-for-game game))))))
135 (cons display engine)))
138 (defun chess-read-pgn (&optional file)
139 "Read and display a PGN game after point."
141 (if (or file (not (search-forward "[Event" nil t)))
142 (setq file (read-file-name "Read a PGN game from file: ")))
145 (let ((game (chess-pgn-to-game)))
147 (require chess-default-display)
148 (chess-display-set-game
149 (chess-display-create chess-default-display
150 (chess-game-side-to-move game)) game))))
152 (defvar chess-puzzle-locations nil)
154 (defun chess-puzzle-next ()
155 "Play the next puzzle in the collection, selected randomly."
157 (if chess-puzzle-locations
158 (chess-puzzle (aref chess-puzzle-locations 0))))
161 (defun chess-puzzle (file)
162 "Pick a random puzzle from FILE, and solve it against the default engine.
163 The spacebar in the display buffer is bound to `chess-puzzle-next',
164 making it easy to go on to the next puzzle once you've solved one."
165 (interactive "fRead chess puzzles from: ")
167 (with-current-buffer (find-file-noselect file)
168 (when (or (null chess-puzzle-locations)
169 (not (equal file (aref chess-puzzle-locations 0))))
171 (goto-char (point-min))
172 (while (search-forward "[Event" nil t)
173 (push (point) locations))
174 (setq chess-puzzle-locations (vector file locations nil nil)))
176 (goto-char (nth (random (length (aref chess-puzzle-locations 1)))
177 (aref chess-puzzle-locations 1)))
178 (let ((game (chess-pgn-to-game)))
180 (require chess-default-display)
181 (let ((puzzle-display
182 (or (and (buffer-live-p (aref chess-puzzle-locations 2))
183 (aref chess-puzzle-locations 2))
184 (chess-display-create chess-default-display
185 (chess-game-side-to-move game)))))
186 (chess-display-set-game puzzle-display game)
187 (aset chess-puzzle-locations 2 puzzle-display)
188 ;; setup spacebar as a convenient way to jump to the next puzzle
189 (with-current-buffer puzzle-display
190 (define-key (current-local-map) [? ] 'chess-puzzle-next)))
191 (require chess-default-engine)
193 (or (and (buffer-live-p (aref chess-puzzle-locations 3))
194 (aref chess-puzzle-locations 3))
195 (chess-engine-create chess-default-engine))))
196 (chess-engine-set-game puzzle-engine game)
197 (aset chess-puzzle-locations 3 puzzle-engine)))))))
201 ;;; chess.el ends here