summaryrefslogtreecommitdiffstats
path: root/games/scrabbleai/scrabbleai.6
blob: f420645e94ddc50a9ee4e70227f4545516ca1d45 (plain)
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SCRABBLEAI" 6 "2023-03-24" "20150324_6f8db6b" "SlackBuilds.org"
.SH NAME
scrabbleai \- Scrabble[TM] game
.\" RST source for scrabbleai(6) man page. Convert with:
.
.\" rst2man.py scrabbleai.rst > scrabbleai.6
.
.SH SYNOPSIS
.sp
\fBscrabbleai\fP
.SH DESCRIPTION
.sp
\fBscrabbleai\fP is an application for Linux that lets you play
the popular word game against a computer opponent at varying
difficulties. It has a graphical user interface, and is played with
the mouse and keyboard.
.sp
There is no way to play against another human, either locally or
via the network. This is strictly a single\-player game.
.sp
There are no command\-line options.
.SH GAMEPLAY
.sp
At startup, or after choosing \fBNew Game\fP from the \fBFile\fP menu, choose
a difficulty level (1 to 10; default is 5), then click \fBStart Game\fP\&.
.sp
You (the human) always go first. If you don\(aqt like this, you can click
\fBPass Turn\fP to make the AI play first. Remember that on the first
turn, you have to place one of your tiles on the center square of the
board.
.sp
On your turn, use the mouse to drag letter tiles onto the board
to spell out a word in the usual Scrabble fashion. Your move isn\(aqt
finalized until you click \fBMake Move\fP and the game decides your word
is valid. Until then, you can move your tiles around as desired, or
click \fBReturn Tiles to Rack\fP to start over.
.sp
When placing a blank tile, you\(aqll be prompted to right\-click on it and
set the letter it represents. If you return the blank tile to the rack
after doing this, don\(aqt forget to right\-click on it and press Space,
to make it appear blank again. If you forget which tile was the blank
one, it\(aqs the one with no score number in the lower\-right corner.
.sp
If your rack is empty at the end of the game, you still get a turn;
you must click \fBPass Turn\fP to end the game. When the game is over,
click \fBFile\fP => \fBNew Game\fP to start a new one.
.SH NOTES
.sp
Note that the first time you start a new game, it will take
longer than usual to launch as the dictionary is cached for future
use. Subsequent games (even after relaunching the program) will be
able to skip this step and start up faster.
.sp
The AI is based on an algorithm from a paper written by Andrew
W. Appel and Guy J. Jacobson, which you can find here::
\fI\%http://www.cs.cmu.edu/afs/cs/academic/class/15451\-s06/www/lectures/scrabble.pdf\fP
.sp
The AI is \fIreally\fP good. However many words you know, it knows
more. On level 5, the AI beats the author of this man page about 50%
of the time, with final scores averaging above 250. The original
Scrabble rules say that a good player should be able to score 300, so
your mileage may vary.
.sp
If you want to peek at the dictionary, there are two of them located
in /usr/doc/scrabbleai\-20150324_6f8db6b/. \fBenable.txt\fP is used to validate
your words, and a smaller \fBospd.txt\fP is used for the computer\(aqs
words.
.sp
The game board is the standard 15x15 version, with the bonus squares
in the regular locations. There\(aqs no way to customize the board or the
tile distribution.
.SH SCREENSHOTS
.sp
The intro screen: \fI\%https://apikler.github.io/ScrabbleAI/intro_screen.png\fP
.sp
The main game screen: \fI\%https://apikler.github.io/ScrabbleAI/game_screen.png\fP
.sp
A completed game: \fI\%https://apikler.github.io/ScrabbleAI/finished_game.png\fP
.sp
The help dialog: \fI\%https://apikler.github.io/ScrabbleAI/help_dialog.png\fP
.SH VIDEOS
.sp
The AI makes a move: \fI\%https://apikler.github.io/ScrabbleAI/ai_move.html\fP
.sp
Resizing the window: \fI\%http://apikler.github.io/ScrabbleAI/resize.html\fP
.SH FILES
.sp
The directory \fB~/.config/ScrabbleAI/\fP contains the settings and
cached dictionary, as \fBperl\fP(1) \fBStorable\fP(3) files, which
means they\(aqre not human\-reable or \-editable. If the directory or its
contents do not exist at startup, \fBscrabbleai\fP will create them.
.INDENT 0.0
.TP
.B \fBsettings\fP
Application settings: default difficulty, window size and position.
.TP
.B \fBlibrary\fP
Cached dictionary, used to speed program startup.
.UNINDENT
.SH COPYRIGHT
.sp
See the file /usr/doc/scrabbleai\-20150324_6f8db6b/LICENSE for license information.
.SH AUTHORS
.sp
scrabbleai was written by apikler (GitHub username).
.sp
This man page written for the SlackBuilds.org project
by B. Watson, and is licensed under the WTFPL.
.SH DISCLAIMER
.sp
This program is free, not for profit, and for educational purposes
only. Any usage of elements from the Scrabble board game is provided
only to illustrate the functioning of the AI. Scrabble is a registered
trademark belonging to Hasbro Inc in the US, and to J.W. Spear &
Sons Ltd., a subsidiary of Mattel Inc., throughout the rest of the
world. Neither the author nor this program are affiliated with the
Scrabble Crossword Game, Hasbro, Spear & Sons, or Mattel in any
fashion.
.SH SEE ALSO
.sp
The scrabbleai homepage: \fI\%https://github.com/apikler/ScrabbleAI\fP
.sp
The Wikipedia entry on Scrabble: \fI\%https://en.wikipedia.org/wiki/Scrabble\fP
.\" Generated by docutils manpage writer.
.