Miniature/Development

Miniature is based on the official Qt 4.6 for Maemo and its Graphics View framework. Most of our work focuses on developing a UI layer optimized for mobile touch devices. When it comes to the backend we want to recycle as much as possible from existing chess engines.

The development is guided by the roadmap and is organized by phases bringing new features to our users. The organization of the roadmap is based on a pragmatical implementation of the Miniature concept taking into account features missing in Maemo, existing chess projects and the requests from current and potential users.

New contributors are welcome! You can help testing and bugfixing new releases focusing on the current phase or you can pick one item more distant in the roadmap and go ahead with it. No matter what you do we recommend you to stay on focus.

Project status

 * The Miniature project was born as a proposal sent to the Maemo community on 2009-10-31.
 * Phase 0: Project setup - ONGOING
 * Currently working on the roadmap item Play Games Online, divided in 3 phases:
 * Phase 1.0: Offline chess basics - STARTED
 * Phase 1.1: Online chess basics - NOT STARTED
 * Phase 1.2: Online chess advanced - NOT STARTED


 * 2009-11-03: First concept of play + chat (landscape).
 * 2009-11-01: First mockup.

Roadmap
(Draft, sorted by priority.)

Items with "?" are to be decided upon once we focus the discussion on them. These items might be moved to later phases of development, or removed from the roadmap altogether.


 * 1) Play games online
 * 2) Chess game basics, demonstrated off-line.
 * 3) Online chess basics, targeting http://www.freechess.org/ first
 * 4) Online chess advanced
 * 5) Join tournaments
 * 6) Full access to FICS console (might make sense only in landscape mode)
 * 7) Chat with your opponent
 * 8) Landscape support.
 * 9) Chatting.
 * 10) Customization
 * 11) Download and select different boards and pieces.
 * 12) Download and select different engines.
 * 13) Methods of connectivity to play against human
 * 14) Bluetooth.
 * 15) WLAN.
 * 16) GPRS.
 * 17) Learn chess lessons with moves + text
 * 18) Positions can be set manually.
 * 19) Play local tournaments e.g. via Telepathy Tubes
 * 20) Play against computer
 * 21) Basic need covered by pre-installed Chess app.
 * 22) TODO: Which engines???
 * 23) Chess variants
 * 24) Antichess
 * 25) Chess960
 * 26) Display games by you or others, live or stored
 * 27) Low priority: Chessmonk is concentrating on this for Maemo 5 => not that urgent for Miniature)
 * 28) History of an opening.
 * 29) Take a picture of a printed game, process the notations with OCR and display it.
 * 30) Display several games at a time.
 * 31) Watch game via webcam stream

Roadmap proposals
Add your proposals here. Remember to sign them so we know where do they come from. Just explain the brief concept. If you have further explanations post them somewhere and link from here. Thank you!


 * 1) Chess clock only function: It would be great to use the N900 as a chess clock only if there is a real board and a "real" opponent is available. The functionality will be in the apllication so a nice UI for this function is all what is needed.--jukey 21:57, 9 November 2009 (UTC)
 * 2) Possibility to play a game human vs. human offline. In this case the board should flip 180° between two moves.--jukey 21:57, 9 November 2009 (UTC)

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 pacaq and Knights? Others? --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) --mikhas.
 * What starting point for game analysis?
 * Scid (see dependencies) would be nice by itself and as gateway to Crafty (see dependencies) and other engines.--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)
 * The current game controller can update the board, using FEN strings (we might want to wrap the QStrings in a simple Position container, if we add parsing API to it) and knows about the UI.
 * Pre-Game - How to find players, select a server or engine

Domain:
 * Board - Represents the data structure of the board (duh)
 * Can draw a position based on a valid FEN string, say "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1" encodes the start position.
 * How it works: Each figure is a QGraphicsSvgItem. This is useful since it allows fingertouchability. The board draws its position, meaning it removes all its figures children (by deletion) and then re-reads the SVG files into new QGraphicsSvgItem. Needless to say, this is inefficient. A better way would be to let the board load all figures during its construction time, put them in a vector (using enums for the indices lookup, maybe) and instead of clearing the board by deletion, just unparent the figures from the board, then reparent them into the correct position. Or just move them around, and hide those that were removed by game moves. Both should be easy and bring a good speed-up (SVG loading is quite expensive I hear). It is bascially about killing unneeded new/delete sequences.
 * Player - information about the other player, like online status, skill level
 * Player "cards" would be part of this. Currently, they only exist as some HTML-formatted text in the scene view.

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