~ubuntu-branches/ubuntu/karmic/brutalchess/karmic

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Gürkan Sengün
  • Date: 2006-04-07 10:41:25 UTC
  • Revision ID: james.westby@ubuntu.com-20060407104125-18mnxbl1yzju7e84
Tags: upstream-0.0.20060314cvs
Import upstream version 0.0.20060314cvs

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Introduction
 
2
============
 
3
 
 
4
This is Brutal Chess Alpha, version 0.3. Brutal Chess is a cross-platform GPL 
 
5
chess game with 3D graphics powered by OpenGL and SDL. This release is an alpha
 
6
version and is by no means feature complete. The ai and graphics are the main 
 
7
focus of this release. Future versions will focus on other features such as the
 
8
user interface.
 
9
 
 
10
New In This Release
 
11
===================
 
12
 
 
13
* Much improved AI
 
14
* Reflections, textures, and other graphical improvements
 
15
* Commands can be typed into the console (only one command in this release)
 
16
* Selected piece can be dropped by right clicking
 
17
* Piece move animations improved
 
18
 
 
19
Building.Linux
 
20
==============
 
21
 
 
22
To build Brutal Chess on Linux, just type make. You will need recent version of
 
23
SDL, SDL_Image and FreeType. SDL 1.2.8 and FreeType 2.1.9 are known to work.
 
24
 
 
25
Building.Win32
 
26
==============
 
27
 
 
28
To build Brutal Chess on Windows, Microsoft Visual Studio .NETi 2003 is 
 
29
recommend. Building under other compilers may be possible, but hasn't been
 
30
tested. In addition, the FreeType, SDL, and SDL_Image  development libraries 
 
31
must be installed. Open brutalchess.sln and build Brutal Chess to make the 
 
32
executable.
 
33
 
 
34
Building.OSX
 
35
============
 
36
 
 
37
To build Brutal Chess on Mac OSX, install SDL framework, then install the other
 
38
required libraries(Freetype2, SDL_Image)  via Fink, then build using either 
 
39
XCode or the makefile. The XCode method is preffered as it creates a binary that
 
40
can be run by double clicking. The OSX build process is still experimental and 
 
41
we would appreciate feedback from users and developers about the build.
 
42
 
 
43
Running
 
44
=======
 
45
 
 
46
Run Brutal Chess from the source directory by running ./brutalchess on Linux,
 
47
by opening brutalchess.exe on Windows, or by double clicking the brutalchess
 
48
icon on OSX.
 
49
 
 
50
Gameplay Notes
 
51
==============
 
52
 
 
53
All standard chess moves should be supported. To move, simply click on a piece,
 
54
then click on the destination square. To deselect a piece, click on it again or 
 
55
click the right mouse button. To castle, simply move the king next to the rook. 
 
56
Pawn promotion is limited to queens in this release.
 
57
 
 
58
When the match ends, either with checkmate or stalemate, a new match will begin
 
59
immediately. A console can be displayed during the match by pressing the tilde
 
60
(~) key. The console displays the result of the match, as well as the last few
 
61
moves.
 
62
 
 
63
Graphics Notes
 
64
==============
 
65
 
 
66
The piece reflections, added in this release effectively double the number of
 
67
polygons drawn on the screen. If you experience slow gameplay, one possible
 
68
solution is to disable them. Either run Brutal Chess with the -r flag, or type
 
69
"reflections 0" into the in-game console.
 
70
 
 
71
Reporting Bugs
 
72
==============
 
73
 
 
74
When you notice a bug, please take a screenshot of the application (if 
 
75
applicable) and then quit the program. Copy the log.txt file to a different 
 
76
location and submit it with your bug report.
 
77
 
 
78
Please submit bug reports via the sourceforge.net tracker at:
 
79
 
 
80
        http://sourceforge.net/tracker/?func=add&group_id=139550&atid=743808
 
81
 
 
82
In order to help speed the bug fixing process, please provide as much 
 
83
information a possible when submitting the bug.
 
84
 
 
85
For additional bug information as well as code discussion, send an email to:
 
86
 
 
87
        brutalchess-devel@lists.sourceforge.net