Miniature

(Phase 1)
(Splitting developer content from Miniature)
Line 14: Line 14:
Basing this on Qt 4.6 would be useful to assure the Fremantle - Harmattan path, be fully compliant with whatever the Ovi store brings and have ports for Symbian, Windows Mobile and desktop OSs (Linux, Windows, Mac).
Basing this on Qt 4.6 would be useful to assure the Fremantle - Harmattan path, be fully compliant with whatever the Ovi store brings and have ports for Symbian, Windows Mobile and desktop OSs (Linux, Windows, Mac).
-
== Project status ==
+
== Features ==
-
* 2009-11-08: [http://talk.maemo.org/showpost.php?p=368538&postcount=117 First running example] mimicking the "first realistic mockup".
+
-
* 2009-11-07: [http://gitorious.org/miniature/miniature/trees/master/data/figures Piece set committed], the same [http://commons.wikimedia.org/wiki/Standard_chess_diagram used by Wikipedia].
+
-
* 2009-11-06: Code repository created: http://gitorious.org/miniature - source code exists since the beginning.
+
-
* 2009-11-06: First post in the developer mailing list: https://garage.maemo.org/pipermail/chess-developer/
+
-
* 2009-11-06: [http://wiki.maemo.org/images/2/26/Miniature-playgame-portrait.png First realistic mockup for playing basic online chess] (portrait).
+
-
* 2009-11-04: [http://talk.maemo.org/showpost.php?p=365071&postcount=70 Portrait mode gets priority] to maximize board size + chats won't come till later.
+
-
* 2009-11-03: [http://wiki.maemo.org/index.php?title=Miniature&oldid=21793#Roadmap Roadmapping started].
+
-
* 2009-11-03: [http://wiki.maemo.org/index.php?title=Miniature&oldid=21755#Development_Status Plann for first phases started].
+
-
* 2009-11-03: [http://wiki.maemo.org/images/archive/d/de/20091103171812!Miniature_normal_mode.jpg First concept of play + chat] (landscape).
+
-
* 2009-11-01: [http://wiki.maemo.org/images/1/17/Miniatura-playgameh.png First mockup].
+
-
* 2009-10-31: This wiki page created.
+
-
* 2009-10-31: "Miniature" project name decided.
+
-
* 2009-10-31: Garage project created: https://garage.maemo.org/projects/chess/
+
-
* 2009-10-31: Talk thread created: [http://talk.maemo.org/showthread.php?t=33764 Contributors needed: the killer free chess game for Maemo]
+
-
 
+
-
== Mockups ==
+
-
 
+
-
These are the current sketches.
+
-
 
+
-
[[Image:Miniature-playgame-portrait.png|frameless|main-p: main window in portrait mode]] [[Image:Miniature_normal_mode.jpg|frameless|main-l: main window in landscape mode (needs update)]] [[Image:Miniature_normal_options.jpg|frameless|menu layout]]
+
-
 
+
-
 
+
-
=== Old ;) ===
+
-
 
+
-
[[Image:Miniatura-playgameh.png|frameless|deprecated]] [[Image:Miniatura_alternative.png|frameless|deprecated]]
+
-
 
+
-
== Current features ==
+
None. Minuature is currently vaporware. :(
None. Minuature is currently vaporware. :(
Line 103: Line 76:
# Display several games at a time.
# Display several games at a time.
# Watch game via webcam stream
# Watch game via webcam stream
-
 
-
== Development Status ==
 
-
 
-
=== Phase 1 ===
 
-
# Setup development environment
 
-
## DONE: Miniature [http://gitorious.org/miniature/miniature is hosted @ Gitorious]. It uses the community port of Qt and [http://www.tsunanet.net/autotroll/ autrotroll]. Warning: Miniature uses the no_keyword switch since some of the [http://amigadave.blogspot.com/2009/07/still-not-impressed-with-macros.html Qt macros have very common names that can lead to wierd debug sessions]. It's defensive programming, and not too bad, really.
 
-
# Implementing the Board. The Board represents the current state of the game and is equivalent to a real physical chess board. It has no knowledge of legal or illegal moves. For now it will only accept chess pieces. The board does not know about the future or the past, any logic will be in the Game.
 
-
## DONE: At least a rough version, using a FEN string as model and a board composed of QGraphicsItems. I imagine that we redraw the board whenever the position changes, so as of now the board is rather stateless (YAY!).
 
-
# Creating a basic GUI to display the Board and the pieces. A piece can be moved by tapping on it and then tapping on the destination.
 
-
## TODO: Decide between a full scene graph UI (= max flexibility to customize look and feel), or use more traditional widgets?
 
-
# Setup communication channels
 
-
## DONE: ML @ Garage: [https://garage.maemo.org/pipermail/chess-developer/]
 
-
## DONE: IRC channel @ freenode.net: #miniature @ irc.freenode.net
 
-
 
-
About setting up the environment
 
-
* Preview of [http://wiki.forum.nokia.com/index.php/Qt_for_Maemo_Developers_Guide Qt for Maemo Developers Guide]
 
-
* [http://qt.nokia.com/maemo Official Qt 4.6 port for Maemo 5], including mailing list for developer feedback.
 
-
** A more comprehensive guide [http://www.forum.nokia.com/piazza/wiki/images/7/7a/Qt_for_Maemo_Developers_Guide_v0_5_Beta.pdf can be found here].
 
-
* The Qt 4.6 packages are about to land in extras-devel
 
-
 
-
=== Phase 2 ===
 
-
# Implement a basic chess Game adapter. The basic Game adapter knows the starting position of every piece and can determine if a move was legal. The concept of alternating player moves is also implemented here. It also recognizes checkmate, stalemate and threefold repetition thus ending the game.
 
-
 
-
=== Ideas for future phases ===
 
-
Proposals and plans for future phases.
 
-
 
-
==== Automatic login & logoff====
 
-
In the first boot of the app we can offer a dialog offering to store the login & password, create a new account or "later" (which will will go to play offline). Once the app has login & password booting will imply logging in and the way to log out will be to simply close down the app.
 
-
 
-
==== Menu while not playing ====
 
-
(Seek player will be in the main screen, below the board - a mockup will come soon)
 
-
* Settings
 
-
** Highlight last move - default SQUARES. Also NO - ARROWS?
 
-
** Show legal moves? - default NO.
 
-
** Show coordinates - default NO.
 
-
** Sounds - default NO.
 
-
** Vibra on moves - default NO.
 
-
** Board position - default RIGHT (to be implemented when landscape mode comes).
 
-
* Customization (to be implemented when customization comes).
 
-
** Piece sets selector.
 
-
** Boards selector.
 
-
 
-
==== Menu while playing ====
 
-
Items in the application menu while playing a game:
 
-
* Resign
 
-
* Request draw
 
-
* Abort
 
-
* Adjourn
 
-
* Promotion piece
 
-
** When clicking the window shows all the figures with the Queen selected by default.
 
-
* Settings
 
-
** Same as while not playing
 
-
 
-
== Technology selections ==
 
-
How to make the most from existing free projects avoiding forking and duplicated work as much as possible.
 
-
 
-
* Qt 4.6 for UI layer. The goal is to have Maemo as primary development platform, aiming for straight ports to Symbian and other Qt compatible platforms.
 
-
** Can we save work by looking at [http://pacaq.sourceforge.net/ pacaq] and [http://knights.sourceforge.net/ Knights]? Others? --[[User:qgil|qgil]] 06:22, 3 November 2009 (UTC)
 
-
* What starting point to get the online chess features?
 
-
* What starting point for chatting?
 
-
** TP connection manager: http://telepathy.freedesktop.org/wiki/Components
 
-
*** Qt 4.6 wrapper (http://telepathy.freedesktop.org/wiki/TapiocaQt) might be a good idea to look at.
 
-
** Rationale: I would like to see a "I play chess!" tag next to each contact I have. This information would of course have to come from a central server or such. Also, it would be great if we could just re-use the chat functionality that is already there with maemo5 (of course it needs a modified view to fit into our UI) --[[User:mikhas|mikhas]].
 
-
* What starting point for game analysis?
 
-
** [http://scid.sourceforge.net/ Scid] ([http://packages.debian.org/lenny/scid see dependencies]) would be nice by itself and as gateway to [http://www.craftychess.com/ Crafty] ([http://packages.debian.org/lenny/crafty see dependencies]) and other engines.--[[User:qgil|qgil]] 06:22, 3 November 2009 (UTC)
 
-
 
-
== Architecture ==
 
-
 
-
GUI:
 
-
* Board
 
-
* Chat
 
-
* Player Cards
 
-
* Online Play
 
-
 
-
Logic:
 
-
* Game - the logic for a particular game, right now that would be just chess, but other board games could be possible too. (Chess based or other)
 
-
* Pre-Game - How to find players, select a server or engine
 
-
 
-
Domain:
 
-
* Board - Represents the data structure of the board (duh)
 
-
* Player - information about the other player, like online status, skill level
 
-
 
-
Communication:
 
-
* ICS
 
-
* Bluetooth
 
-
* Telepathy
 
-
* Computer Chess Engine - an offline engine should be accessed the same way any online game is, the engine does not have to be in the same task
 
-
 
-
== References ==
 
-
* [http://www.craftychess.com/ Crafty] is a free, open-source computer chess program.
 
-
* [http://www.v7f.eu/public/n800/chess/ EBoard and Crafty] for the N810/N800/N770 - [http://maemo.org/downloads/product/OS2007/chess OS2007 Downloads page].
 
-
* [http://knights.sourceforge.net/ Knights] aimed to be the ultimate chess resource for the K Desktop Environment... years ago.
 
-
* [http://pacaq.sourceforge.net/ pacaq] is a chess game visualizing and analysis tool done with the Maemo 4.1 Qt4 port - [http://talk.maemo.org/showthread.php?t=21793 Talk thread].
 
-
** From all programs on this list, this is the only one were reading the code is worth your time.
 
-
* [http://scid.sourceforge.net/ SCID], a chess database application for Windows, Linux and Mac OS operating systems.
 
-
** See also [http://scid.sourceforge.net/scidpocket.html SCID Pocket]
 
-
* [http://www.gnu.org/software/xboard/ Xboard] is a graphical user interface for chess in all its major forms.
 

Revision as of 20:01, 8 November 2009

You love chess. You love Maemo and its devices. You believe they fit so well... yet you haven't found a convincing implementation of a chess game for Maemo. Miniature to the rescue!

Contents

The concept

More or less:

  • The main use case is playing online against other players at freechess.org
  • Now imagine that you can also chat with the other player.
  • Playing against the computer is a given (chat is optional)
  • Learning is important and it would be great to watch games, review stored games and also process offline the lessons given at certain times in freechess.org
  • A variant would be to play against othe player with a compatible device via local network or bluetooth.
  • I guess if we got at this point then implement variants such as suicide chess, random house, etc is peanuts.

Basing this on Qt 4.6 would be useful to assure the Fremantle - Harmattan path, be fully compliant with whatever the Ovi store brings and have ports for Symbian, Windows Mobile and desktop OSs (Linux, Windows, Mac).

Features

None. Minuature is currently vaporware. :(

Roadmap

Draft. Sorted by priority.

Items with "?" are optional/dubious and might be moved for later phases of development or removed from the roadmap once we focus the discussion on them.

Play games online

  1. Chess game basics, demonstrated off-line.
    1. Finger friendly UI.
      1. Mechanism to avoid false moves. First tap to point square, second to confirm?
      2. TODO: extract all move mode proposals from thread so we can evaluate them while comparing working examples.
    2. Portrait mode.
      1. TODO: find out why "setAttribute( Qt::WA_Maemo5ForcePortraitOrientation, true); setAttribute( Qt::WA_Maemo5ForceLandscapeOrientation, false);" is not sufficient (used git master from here, but it now says: "don't use it". Perhaps this just works now?)
    3. Pieces can be moved manually.
    4. Only legal moves are possible.
      1. Option to highlight legal moves?
      2. TODO: draw a sequence diagram or similar to demonstrate the necessary interactions between remote server, our game component, and the board representation. Also indicate how the user is notified.
    5. "Black/White Wins!" banner after a mat.
    6. Resign.
    7. Pawn promotion, piece selection.
      1. Queen autopromotion?
    8. Draw request/accept.
    9. Timer
      1. Time limit warning?
  2. Online chess basics, targeting http://www.freechess.org/ first
    1. Log in & out
    2. Register
    3. Search challengers / by time
    4. Propose a game
    5. Timeseal support.
  3. Online chess advanced
    1. Join tournaments
    2. Full access to FICS console (might make sense only in landscape mode)

Chat with your opponent

  1. Landscape support.

Customization

  1. Download and select different boards and pieces.
  2. Download and select different engines.

Play with other opponents P2P e.g. via Bluetooth

Learn chess lessons with moves + text

  1. Positions can be set manually.

Play local tournaments e.g. via Telepathy Tubes

Play against computer

Chess variants

Display games by you or others, live or stored

(moved to back since Chessmonk is concentrating on this for Maemo 5 - not that urgent)

  1. History of an opening.
  2. Take a picture of a printed game, process the notations with OCR and display it.
  3. Display several games at a time.
  4. Watch game via webcam stream